RKWeb

From m204wiki
Jump to: navigation, search

Contents

Overview

The RKTools 7.7 release is comprised of the RKTools subsystems, Dictionary/204, and RKWeb.

  • The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).
  • Dictionary/204 is available from the TN3270 interface, the RKTools menu, or from RKWeb.
  • RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.

RKWeb harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device.

All existing security and product ownership is honored in the RKWEB subsystem — for instance, an interface is provided for managing group definitions and passwords, but the option is only available to RKWEB subsystem ADMIN SCLASS users that have System Administrator login privileges.

RKWeb requires Janus Web Server and Model 204 version 7.6 or later. See RKWeb installation for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: Build, Manage, and Monitor. The Command processor is available in each functional area.

Build

The Build menu provides these options for building your application:

Edit

The Build > Edit menu option enables you to edit procedures within Model 204 files.

Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

RKWeb editor

The editor provided with RKWeb is based on the open-source Ace editor.

The RKWeb editor:

  • Works with all SOUL code and other code stored in M204 procedure files.
  • Uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.
  • Respects Model 204 security, allowing users to see, browse, and/or edit only the procedures that they would have permission to see, browse, or edit in 3270.
  • Is available to all Model 204 owners.

The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see Default keyboard shortcuts.

To edit a procedure

Note: Pop-ups must be enabled to use this feature.

  1. Click the Build tab.
  2. In the Build menu, click Edit.
  3. If needed, click the Open Procedure List button.
  4. The Edit tool fetches a list of procedures in the current file. The list appears in a new window (or tab).
  5. To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field. Then click the List button.

  6. To filter the list of procedures:
    • Enter a string in the Filter field, such as shared or EDITOR. (Case-sensitivity of the string is set in the Procedure List Settings dialog box.)
    • Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.
    • Press Enter or click List to refresh the list of procedures.
    • To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.
  7. Click a procedure name to open that procedure in a new window (or tab) and edit it in the RKWeb editor.
  8. After editing, click Save and close the window to return to the procedure list window.
  9. Close the procedure list window to return to the RKWeb main screen.

To customize the procedure list settings

  1. Click the Settings icon in the upper right corner of the screen.
  2. In the Procedure List Settings dialog box, you can customize the following Procedure List settings:

    • Hiding of BASE.* and SEQ.* type procedures
    • Font size
    • Case sensitivity of procedure name Filter field
    • Double-clicking (vs. single-clicking) to open a procedure
    • Procedure colors:
      • Background color of the Procedure List toolbar.
      • Color of an open procedure.

      Enter a color name, such as red, or its hexadecimal code, such as #FF0000, or its rgb value,
      such as rgb(255,0,0).

  3. Click Save to save your changes.

Configure

The Build > Configure option is available to SirLib owners who are RKWEB subsystem ADMIN SCLASS users. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

To use SirLib change control

  1. Click the Build tab.
  2. In the Build menu, click Configure.

    This opens the SirLib Configuration and Change Control System.

    SirLib functionality is provided as a Janus legacy application, operating outside the RKWeb menu framework. When you click the Configure menu option, a new window (or tab) opens, leaving your original RKWeb session in place in the original window (or tab).

    Note: These Janus Legacy applications are not fully integrated with RKWeb, so you must use the security configured for those applications. For instance, FILEMGMT is implemented as Janus Legacy, and it might prompt you for a separate password.

  3. Enter an action number to choose a menu option from the Configuration and Change Control System menu.

    The Target file field, Fixes File field, and menu options are the same as on the SirLib main menu.

    Menu numberItemEnables you to...
    1Project Definition ListAdd, delete, or change the project identifiers in the FixFile assigned to a managed file.
    2 Apply changes (Reconfigure a file)Apply file updates.
    3 Administration (specify a file or use default) Administer system and file profiles.
    4 Security (specify a file or use default) Set SirLib security settings.
    5 Cutover Clean up and stabilize projects. Release cutover returns a managed file to a pre-managed state, but with all existing updates applied.
    6 Reports Run a SirLib report on Change History, Configuration, or Problem tracking.
    7 View/Clear Procedure Locks (ADMIN users only) See procedures that are currently checked out.
  4. When you have performed all desired tasks, close the window to return to your RKWeb session.

Fact Dump Analysis

The Fact Dump Analysis menu item provides a UI to the SirFact FACT subsystem, enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.

Note: Your site must own SirFact and you must be an RKWEB subsystem SCLASS user in order for you to use Fact Dump Analysis.

To select and analyze a diagnostic dump

  1. Click the Build tab.
  2. In the Build menu, click Fact Dump Analysis.
  3. Click Select from the submenu.

    In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.

    To choose a different file, enter its name in the File field and click Switch file.

  4. Click a procedure name to analyze its dump information with the SirFact FACT subsystem.

    The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.

    Enter SirFact commands to extract additional information, which is appended to the information on the screen:

    • To view the context where an error occurred, enter the Context SirFact command, with an information context, in the Command field and click Send query.

      The valid information contexts are:

      * (asterisk) Switches FACT context to the mainline of the executing program.
      . (period) Switches to whichever context the program was in at the time of the SirFact error.
      subroutine-name Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.
    • To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the Display SirFact command and its parameters in the Command field and click Send query.

Tune Reports

The Tune Reports menu item enables you to produce a listing of one or more SirTune reports, which you can use to tune problem areas in an Online.

Note: The Tune Reports menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see SirTune report configuration. Tune Reports is available to all owners of SirTune that are RKWEB subsystem ADMIN SCLASS users.

To produce a report

  1. Click the Build tab.
  2. In the Build menu, click Tune Reports.
  3. Select Procedure or Dataset to choose either a procedure or data set report.
    • For Procedure:

      In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).

    • For Dataset:

      In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).

  4. In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).
  5. Click Generate to generate the report.

Manage

The Manage menu contains options to manage your applications, files, and user logins:

Subsystem Management

The Subsystem Management menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB subsystem ADMIN SCLASS users who have System Administrator login privileges.

Procedure

Enter specifications for subsystem procedures on the Procedure screen.

To create specifications for a subsystem procedure
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select Procedure.
  3. Enter a name in the Subsystem field and press Enter.
  4. If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.
  5. The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.
  6. Edit the procedure prefixes as desired.
  7. Edit the procedure names as desired.
  8. Edit the global variables as desired.
  9. If you have made any edits, click the Save number Updates button.
To rename specifications for a subsystem procedure
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select Procedure.
  3. Select an item in the Subsystem drop-down list.
  4. Click the icon beside the Subsystem field and select Rename.
  5. In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.
  6. The renamed item appears as the selected subsystem.
To copy specifications for a subsystem procedure
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select Procedure.
  3. Select an item in the Subsystem drop-down list.
  4. Click the icon beside the Subsystem field and select Copy.
  5. In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.
  6. The new copy appears as the selected subsystem.
To delete specifications for a subsystem procedure
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select Procedure.
  3. Select an item in the Subsystem drop-down list.
  4. Click the icon beside the Subsystem field and select Delete.
  5. In the Delete Subsystem pop-up, click Confirm Delete.
  6. The item disappears from the display and the subsystem list.

Operational

Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the Operational menu options.

To specify subsystem operating options
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select Operational.
  3. In the Subsystem field, select a subsystem name from the drop-down list.
  4. Set the operating options as needed.

    The following table summarizes the operating options and what they specify when enabled. For more details, see operating options.

    Operating option field Description
    Status Specifies the level of availability of the subsystem to users.
    Auto Start Automatically starts the subsystem when the first user enters the subsystem name.
    Lock File/Group Subsystem files and groups are available only to users running in the subsystem after the subsystem is started.
    Log user into M204 The user is logged out of Model 204 and then logged back in to Model 204 with the subsystem name as the user ID when entering the system.
    Log user out of M204 The user is automatically logged out of Model 204 upon exiting the subsystem.
    Auto Commit A SOUL COMMIT statement is executed by Model 204 at each procedure END in the subsystem during execution.
    Maximum Iterations The maximum number of consecutive times the same procedure can be invoked.
    Account An account value that overrides the login account. The original value is restored when the user exits the subsystem.
    Privileges (in hex) A user's privileges while in the subsystem. Privileges specified before logging into the subsystem are overridden.
    Start Login privileges (in hex) Controls login privileges while starting a subsystem. If specified, Start Login Privileges overrides both the user's previous privileges and other privilege fields in the subsystem definition.
    Subsystem can access Remote Files For use with Parallel Query Option/204 (PQO) applications; allows application subsystem definitions and requests to refer to remote files.
    Message Display Options Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.
  5. Click the Save number Updates button.

Files

The Files menu item enables you to define the files, including the procedure file, used by the subsystem.

To create or update a file specification
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select Files.
  3. Select a subsystem from the drop-down list beside the Subsytem field.
  4. On the Files screen, enter the file specifications in each field.
  5. Click the Save number Updates button.

System Classes

You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.

To create a system class
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select System Classes.
  3. On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.
  4. In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.
  5. In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.
  6. If you are a system manager, you can update the fields in the Login Privileges section.
    • Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

      Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

      Enter a hexadecimal value within the range of X'00' to X'FF', as described in PRIVDEF parameter settings.

      NULL indicates default privileges from the Operational Parameters screen.

    • Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

      NULL indicates the security activated on login.

      The original value of the record security ID is restored when the user exits the subsystem.

    • Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.

      Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.

      NULL indicates the user's login account or the value from the Operational screen.

  7. In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

    This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:

    • Prcldef specifies Model 204 procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.
    • Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default).
    • Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.
  8. When done defining the system class, click the Save number Updates button.
To add or delete another system class
  1. Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).
  2. A new title, CLASSx, appears. (As each new class is added, x is incremented by 1.) Click the title field to enter a different name, up to eight characters long.
  3. Fill in the fields as described above.
  4. To delete the class, click the trash can icon beside its name.
To view users
  1. Click the Manage tab.
  2. In the Subsystem Management menu, click the arrow to open the submenu, and select Users.
  3. On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.
  4. The list of users appears.

Dictionary

Dictionary/204 functionality is provided as a Janus legacy application.

The Dictionary links provide convenient access to the existing 3270 Dictionary/204 screens.

RKWeb provides the following Dictionary submenu items:

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.

Administration

The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:

  1. Entity Type Maintenance. Enables you to define, update, or delete a Dictionary entity type.
  2. Path Maintenance. Enables you to display, add, update, or delete a Dictionary path definition.
  3. Facility Administration. Enables you to:
    • Add, delete, or rename procedure names on a list of user-written procedures that produce reports
    • Determine command options and setting defaults for the File Management facility
  4. Security Administration. Enables you to specify the privileges of Dictionary/204 users.
  5. Inventory Report. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.

    Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.

Documents

The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.

The Dictionary Document Facility screen contains a menu with the following options:

  1. Add an Entry. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).
  2. Update an Entry. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.

    Updating also allows you to create dummy entries.

  3. Delete an Entry. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.
  4. Copy an Entry. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.
  5. Rename an Entry. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility.

Reports

Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:

  • All the attributes and relationships for a given entry
  • List of all of the entries for a given type of entity — all SCREENs, all FILEs, and so on
  • Entries selected by name, entity type, relationship with another specified entry, or specific keywords

To run Dictionary reports:

  1. Select Manage > Dictionary > Reports from the main menu.
  2. On the Dictionary Reports Main Menu that appears, select an option:
    1. Display an Entry

      Displays the attributes and/or relationships (or references) for an entry of a specified entity type.

    2. List Entries of an Entity Type

      Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.

    3. Display Cross-References for an Entry

      Displays relationships between entries based on cross-references only. You can search all entries or only entries of a particular entity type.

    4. Display Named References for an Entry

      Displays relationships between entries based on named references only. You can search all entries or only entries of a particular entity type.

      Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).

    5. Display All References for an Entry

      Displays any relationship between entries including cross-, named, or path (indirect) references.

    6. Browse Entries by Attributes

      Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.

      You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.

    7. Select User-Written Report

      Select a report that has been customized by the Dictionary administrator.

Xref

The Dictionary cross-reference facility produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.

  1. From the main menu, select Manage > Dictionary > Xref.
  2. On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.
  3. In the Report Options list, select the SOUL elements to be included in the report, or select All.
  4. On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.
  5. In the procedure selection criteria section, specify procedure names or patterns:
    • Enter N to use procedure names. You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:

      BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3

    • Enter P to use a pattern. This informs the Cross-Reference facility that you want to use pattern-matching rules.

      For example, enter BILLSYS* to generate a report for all procedures in the selected file that begin with the string BILLSYS.

File Management

The Dictionary/204 File Management Subsystem facility, FILEMGMT, enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:

  • Construct the Model 204 commands that create the physical file
  • Store the appropriate entries in your installation's dictionary

By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:

  • View existing file data
  • Reset file parameters
  • Add fields, records, and field groups to existing files
  • Calculate and change the size of a file
  • Copy files, fields, and records

To invoke FILEMGMT:

  1. Select Manage > Dictionary > File Management from the main menu.

    The FILEMGMT primary screen appears.

  2. In the Filename field, enter the name of the file that you are working with.
  3. In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.

The categories are as follows:

File maintenance Creates a new Model 204 file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.
Field maintenance Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.
Record maintenance Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.
Field Group maintenance Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.

SQL Catalog Reports

The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:

  1. File of valid DDL syntax, which you can use to rebuild the catalog
  2. Fixed format report of a table or view
  3. Privilege report by table or view name
  4. Privilege report by user

Fill in the fields as needed for each report:

FieldUsed in report type...Value
Schema Name1,2, or 3Enter the name of a specific schema or enter an asterisk (*) for all schemas.

If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.

Authorization ID1 or 2Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.

If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.

Table View/Name1, 2, or 3Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.

If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.

DDL Statement Type(s)1The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.

Select one or more of the following identifiers:

Identifier Statement generated
T CREATE TABLE
V CREATE VIEW
G GRANT
T, V, or G CREATE SCHEMA or SET SCHEMA
CREATE TABLE, CREATE VIEW, and GRANT

If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.

Grantee4Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.

If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.

"USE" Command ArgAllUse this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.

You can enter any USE command argument that is valid in your operating environment, for example, PRINTER FOO or $PRINT *.

For more details, see "USE" Command Arg.

Table Specifications

The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see Creating or modifying a base table (Main Menu panel).

Unless otherwise noted, you must enter a value for each field.

FieldValue
Schema Authorization Authorization ID (default is the Model 204 login user ID)
Table Name The name of the SQL table that you are defining. Multiple nested tables are allowed.
Schema Name The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)
Model 204 File Name The name of the Model 204 file that you want defined as an SQL table.
Password If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.
Table Type The table type: B (Base), P (Parent), or N (Nested).
Primary Key If the table type is P (Parent) or N (Nested), enter the value for the primary key.
Parent Table If the table type is N (Nested), enter the name of the SQL table that each nested table references.

Passwords

Clicking the Manage > Passwords menu item enables you to use the SirPro password functionality to maintain passwords in CCASTAT. The Passwords interface is available to RKWEB subsystem ADMIN SCLASS users who have System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

Users

From the Users menu, you can add, change, or delete login user ID entries in the password table.

To add a user ID
  1. Click the plus sign icon beside the Model 204 User Passwords header.
  2. In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
  3. In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long. For more information on mixed-case passwords and Password Expiration, see LOGCTL for user ID entries.
  4. Re-enter the password in the Verify Password field.
  5. In the Privileges field, click the search icon beside the field and select from a checklist of privileges.
  6. In the Priority field, choose a user priority from the drop-down list.
  7. In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.
  8. Click the Save updates button. The information is immediately committed to CCASTAT.
  9. Press F5 to refresh the screen and verify that the new user ID is listed.
To change a User ID
  1. Click the icon to the left of the user ID that you want to change.
  2. Select Change from the pop-up menu that appears.
  3. In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.
  4. Click the Save updates button. The information is immediately committed to CCASTAT.
To delete a user ID
  1. Click the icon to the left of the user ID that you want to delete.
  2. Select Delete from the pop-up menu that appears.
  3. In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
  4. Press F5 to refresh the screen and verify that the user ID has been removed from the list.

Files

From the Files menu, you can add, change, or delete file entries in the password table.

To add a file password
  1. Click the plus sign icon beside the Model 204 File Passwords header.
  2. In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see LOGCTL for file entries.
  3. In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.
  4. In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.
  5. Re-enter the password in the Verify Password field.
  6. In the Privileges field, click the search icon beside the field and select from a checklist of privileges.
  7. In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.
  8. In the User class field, enter the number of the user class that can access the file.
  9. In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit field-level security for Select, Read, Update, and Add privileges.
  10. In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.
  11. Click the Save updates button. The information is immediately committed to CCASTAT.
  12. Press F5 to refresh the screen and verify that the new file entry is listed.
To change a file password or logon settings
  1. Click the icon to the left of the file ID that you want to change.
  2. Select Change from the pop-up menu that appears.
  3. In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see LOGCTL for file entries.

    Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.

  4. Click the Save updates button. The information is immediately committed to CCASTAT.
To delete a file
  1. Click the icon to the left of the File that you want to delete.
  2. Select Delete from the pop-up menu that appears.
  3. In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
  4. Press F5 to refresh the screen and verify that the file has been removed from the list.

Groups

From the Groups menu, you can add, change, or delete group entries in the password table.

To add a group entry
  1. Click the plus sign icon beside the Model 204 Group Passwords header.
  2. In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see LOGCTL for group entries.

    Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.

  3. Click the Save updates button. The information is immediately committed to CCASTAT.
  4. Press F5 to refresh the screen and verify that the new group entry is listed.
To change a group password or logon settings
  1. Click the icon to the left of the group id that you want to change.
  2. Select Change from the pop-up menu that appears.
  3. In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see LOGCTL for group entries.

    Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.

  4. Click the Save updates button. The information is immediately committed to CCASTAT.
To delete a group entry
  1. Click the icon to the left of the group that you want to delete.
  2. Select Delete from the pop-up menu that appears.
  3. In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
  4. Press F5 to refresh the screen and verify that the group entry has been removed from the list.

Group Definitions

The Group Definitions menu option enables system managers to manage the group definitions in CCAGRP. Access to the Group Definition page is given to RKWEB subsystem ADMIN SCLASS users who have System Administrator login privileges.

To add a group

  1. Click the plus sign icon beside the Model 204 Groups screen title.

    The Create a new group screen appears.

  2. Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the CREATE command.
  3. Click the Save changes button.
  4. Press the F5 key to refresh the display and see your group in the list.

To copy a group

  1. Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.
  2. In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.
  3. Press F5 to refresh the screen and see the new copy with the name that you entered.

To rename a group

  1. Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.
  2. In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.
  3. Press F5 to refresh the screen and confirm the name change.

To update a group

  1. Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.
  2. The Update group definition dialog box appears.

  3. Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the CREATE command.
  4. Click the Save number Updates button.

To delete a group

  1. Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.
  2. In the Delete Group pop-up, click Confirm Delete.
  3. Press F5 to refresh the screen and confirm that the group has been removed from the list.

SSL Certificates

Note: Before using the RKWeb SSL Certificates interface, click the Manage > SSL Certificates > SSL Information menu item and read the SSL Certificate Management - How to use this application screen.

Overview

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.

Access to this feature in RKWeb requires a Janus Network Security license and is restricted to RKWEB subsystem ADMIN SCLASS members, who also have System Administrator login privileges.

Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see About keys and certificates.

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see SSL certificate management.)

The process of getting a valid certificate and private key combination usually involves these steps:

StepMenu itemNotes
1. Generate a private key and an associated certificate request.Create RequestThe certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.
2. Forward the certificate request file to the certifying authority (CA).N/AScroll down the screen to the "How to use this page" section.
3. The certifying authority digitally signs the certificate.N/A Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.
4. The certifying authority sends the digitally signed certificate back to the holder of the private key.N/AN/A
5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.Receive CertificateWith Janus Network Security, the private key and the signed certificate must be placed into the same procedure.

Create Request

To generate a certificate request
  1. Click the Manage > SSL Certificates > Create Request menu item.
  2. On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help.
  3. Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.
  4. Click the Create certificate request button.
To generate a self-signed certificate
  1. Click the Manage > SSL Certificates > Sign Certificate menu item.
  2. On the Sign a Certificate screen, scroll down to read the online help.
  3. Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.
  4. Click the Sign the Certificate button.
To receive a signed certificate
  1. Click the Manage > SSL Certificates > Receive Certificate menu item.
  2. On the Receive a Signed Certificate screen, scroll down to read the online help.
  3. Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.
  4. Click the Receive Certificate button.
To manage SSL requests and certificates
  1. Click the Manage > SSL Certificates > Manage Certificates menu item.
  2. Click the equals sign icon beside a request name and select an option:
    • View the details of the certificate on a separate screen
    • Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.
    • Rename the selected certificate
    • Delete the selected certificate
To learn about using the SSL application

Click the Manage > SSL Certificates > SSL Information menu item to bring up the SSL Certificate Management - How to use this application screen.

It is recommended that you read this screen before doing any SSL tasks.

Monitor

The Monitor menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.

Performance

The Monitor > Performance menu is the RKWeb interface to the SirMon monitoring application, and it is restricted to RKWEB subsystem ADMIN SCLASS users at sites that own SirMon. SirMon combines the real-time monitoring of Model 204 performance with intelligent full-screen displays that facilitate System Manager duties. You can scroll the displays, refresh them, and sort them by displayed statistics and parameters.

SirMon provides a collection of predefined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at the Model 204 command level.

SirMon divides the Model 204 Online into System, Files, Users, Subsystems, MP Tasks, and Janus Ports statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

System

The Monitor > Performance > System menu option provides a submenu of system statistics screens, including:

Option Description
Above-the-bar Buffers Locally defined selection.
Above/Below the bar disk I/O Locally defined selection.
Below-the-bar Buffers Locally defined selection.
Database I/O Performance Overall view of physical and logical I/O for the various database files defined to the Online environment.
MP Performance Measures of performance specific to a multi-processor Model 204 environment.
Request Profile Overall view of database activity up to the current moment. Displays total Find statements and various measures of record access and update.
System Performance General view of system performance that includes CPU usage, I/O activity and other broad measures.
User State Distribution Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.
User Wait Type Dist Displays counts of users by wait type (waiting for disk I/O, or file resource, etc.).

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

A SirMon administrator can also locally define custom screens that are accessed from the Monitor > Performance > System menu.

Files

The Monitor > Performance > Files menu presents a submenu of file statistics screens, including:

Option Description
Buffer Usage Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.
Critical File Resource Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.
File Activity Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.
File Table Usage Shows file space utilization information for each open Model 204 file, broken down by table type.
Ordered Index Usage Information about ordered index data density and usage.

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a SirMon administrator as described in Custom screens.

Users

The Monitor > Performance > Users menu presents a submenu of user statistics screens, including:

Option Description
Critical File Resources Detailed statistics providing information about conflicts on critical file resources.
Disk Buffer Usage Various DKxxx statistics for each user.
Misc. Resource Usage Aggregate measures of activity, making it easy to spot significant resource consumers.
Record Locking Table Usage Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.
Resource Usage Broad measurements of users' consumption of CPU and I/O activity.
Resource Usage and Subsys Various resource consumption statistics and the current subsystem for each user.
User State Display Displays users state, wait type and other measures to indicate their level of activity.

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu. These screens are defined by a SirMon administrator as described in Custom screens.

Subsystems

The Monitor > Performance > Subsystems menu presents a submenu of subsystem statistics screens, including:

Option Description
Active/Inactive Subsystems Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
Resident QTBL Usage Detailed breakdown of key information about each subsystem's use of resident QTBL.

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a SirMon administrator as described in Custom screens.

MP Tasks

The Monitor > Performance > MP Tasks menu presents a submenu of task statistics screens, including:

Option Description
Task Performance Display of CPU usage, the PCPU statistic, and other statistics related to performance of Model 204 multitasking.

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Task Monitor menu. These screens are defined by a SirMon administrator, as described in Custom screens.

Janus Ports

The Monitor > Performance > Janus Ports menu presents a submenu of port statistics screens, including:

Option Description
Janus SSLStat A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to Janus Network Security encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the Portname header.

For details on the Janus SSL statistics, see Janus SSLStat.

Janus Status A detailed display of the current status of specified ports.
Janus TStat A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.

For pop-up help for each statistic, hover the mouse over the column header.

Custom

The Monitor > Performance > Custom menu item enables you to build a custom performance screen.

To create a custom performance screen
  1. Click the Monitor tab.
  2. In the Performance menu, click the arrow to open the submenu, and select Custom.
  3. In the Type section, select the type of performance statistics that you want to use.
  4. In the Load From field, click the subsystem that you want to load from.

    To start again, click Clear.

  5. In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.

    The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.

    To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat.

  6. In the Interval Statistics section, click to select each statistic that you want to be included.

    Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).

  7. To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.
  8. To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for username."
  9. To save under a report type, click Save.

Journal Scan

The Journal Scan menu link brings up the RKWeb journal scanner, a high-performance utility similar to the TN3270 interface of SirScan. The journal scanner allows users in a Model 204 Online to browse the contents of its journal in real time. To use the journal scanner, you must have a license to use the SIRSCAN subsystem.

ADMIN SCLASS users of the RKWEB subsystem can view the current Online journal entries or browse the content of archival journals (by DDname, if they are allocated to the Online as sequential files). The data is displayed on the web page with powerful searching commands, including filtering and display options.

The Model 204 journal scan form supports the same input as shown for SirScan (see journal scan specifications).

To run a journal scan

  1. Click the Monitor tab.
  2. In the Monitor menu, click Journal Scan.
  3. On the Model 204 journal scan form, enter the desired field values.

    Click the red plus or minus sign icon to toggle between a minimized set of request options (start time and users only) and an expanded set of options.

  4. Click Submit journal request to see the journal entries.

Command processor

With the command processor, you can run any Model 204 command that your user role has permissions for.

To run a Model 204 command

  1. Click the Command processor link to open the Model 204 command interface.
  2. Enter any command as you would on a Model 204 command line, such as VIEW ALL, then click Submit to run it.
  3. To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.

RKWeb security

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.

  • Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.
  • Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring a secure web port for RKWeb, see RKWeb installation.

Where's my RKTools 3270 functionality?

Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

RKTools 3270RKWeb component > menu itemAvailable to...
Model 204 command line, SirPro command processingBuild, Manage, Monitor > Command processorModel 204 Core
CREATE GROUP command,
SirPro
Manage > Group DefinitionsModel 204 Core
Dictionary/204Manage > DictionaryModel 204 Core
JANSSLManage > SSL CertificatesJanus Network Security owners
LOGCTL/LOGADD commands,
SirPro
Manage > PasswordsModel 204 Core
SirFactBuild > Fact Dump AnalysisSirFact owners
SirLibBuild > ConfigureSirLib owners
SirMonMonitor > PerformanceSirMon owners
SirScanMonitor > Journal ScanSirScan owners
SirTune ReportsBuild > Tune ReportsSirTune owners
SoulEditBuild > EditSirPro owners
Subsystem ManagementManage > Subsystem ManagementModel 204 Core