RKTools: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (→‎PL command: add link)
m (minor wordsmithing)
Line 1: Line 1:
<var class="product">RKTools</var> &mdash; ''Rocket Tools for Model 204'' &mdash; is a family of products implemented as <var class="product">SOUL</var> application subsystems, designed to function together in a <var class="product">Model 204</var> Online. Prior to version 7.5 of RKTools (October, 2015), the product was known as UL/SPF.
Each product in the family can be installed and run independently, or each can be installed and run as a component of the integrated <var class="product">RKTools</var> framework. All <var class="product">RKTools</var> products share a common look and feel, providing a highly productive full screen 3270 interface to a variety of common <var class="product">Model 204</var> functions. In addition, many of the component subsystems also support web interfaces.
==RKTools components==
<var class="product">RKTools</var> comprises the following products:
<dl>
<dt>[[SirDBA]] <dd>A system that analyzes <var class="product">Model 204</var> databases to determine their logical structure, populating an internal catalog. <var class="product">SirDBA</var> is distributed as a component of the Sir2000 Database Analysis Tools.
<dt>[[SirFile]] <dd>A comprehensive facility both for monitoring the physical storage utilization of <var class="product">Model 204</var> database files and for warning users of the need for file reorganizations. <var class="product">SirFile</var> maintains historical information that allows it to predict when file sizing problems will occur, allowing a DBA to take preventative action before an application outage results.
<dt>[[SirLib]] <dd>A powerful and flexible system that provides change management and
configuration control for <var class="product">Model 204</var> <var class="product">SOUL</var> applications. <var class="product">SirLib</var> is
fully integrated within the <var class="product">SirPro</var> programming environment.
<dt>[[SirMon]] <dd>A comprehensive facility for monitoring the performance and availability of <var class="product">Model 204</var> online systems. <var class="product">SirMon</var> combines the real time monitoring of
<var class="product">Model 204</var> performance with intelligent full screen displays that facilitate System Manager and Administrator duties.
<dt>[[SirPro]] <dd>A collection of powerful and easy to use tools for programmers, database administrators, and application managers. <var class="product">SirPro</var> provides programmers with powerful facilities for managing large libraries of <var class="product">User Language</var> procedures, and it provides system managers with intuitive ISPF-like front ends to many <var class="product">Model 204</var> system management commands. As of <var class="product">RKTools</var> Version 7.5, SirPro also incorporates the user-extensible [[SoulEdit]] editor, which can also be invoked from the command line via the (optional) <var class="product">Model 204</var> apsy <var class="product">SE</var>. Because the procedure list feature of <var class="product">SirPro</var> is so central, it too has an optional standalone apsy called <var class="product">PL</var>.
<dt>[[SirScan]] <dd>A high performance utility that allows users in a <var class="product">Model 204</var> Online to browse the contents of its journal in real time. <var class="product">SirScan</var> permits ordinary users to view journal entries generated by their own online session, and it allows users in [[ADMIN SCLASS]]es to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.
</dl>
In addition, a number of subsystems that are not linked into the <var class="product">RKTools</var> menuing
structure may be accessed via APSY-transfer from the <var class="product">RKTools</var> applications. One such subsystem is <code>FACT</code>, a utility for browsing <var class="product"><b>[[SirFact]]</b></var> dumps.
There are also many sample web and client-server applications developed for the [[Janus_TCP/IP_Base#The_Janus_family|Janus product family]] that are distributed and installed along with the <var class="product">RKTools</var> products. These
include <code>JanCat</code>, an application that builds normalized views of <var class="product">Model 204</var> data for use
by <var class="product">Janus Specialty Data Store</var> applications, and <code>JanSSL</code>, a system for creating and managing SSL certificate requests.
==RKTools packaging and installation requirements==
All of the <var class="product">RKTools</var> products are <var class="product">Model 204</var> application subsystems written in <var class="product">SOUL</var>.
<var class="product">RKTools</var> is distributed as a set of <var class="product">Model 204</var> files in a backup format produced by the <var class="product">Model 204</var> <var>DUMP</var> command.
All <var class="product">SOUL</var>-based products are
distributed in a single <var class="product">Model 204</var> procedure file called <code>SIRIUS</code>.
<var class="product">RKTools</var> makes extensive use of specialized <var class="product">SOUL</var> OO classes and $functions. These classes and $functions enable the creation of powerful <var class="product">SOUL</var> application systems that can support complex environments with minimal server size requirements.
Installing <var class="product">RKTools</var> requires:
<ol>
<li>Downloading the <code>SIRIUS</code> file and restoring it to the <var class="product">Model 204</var> environment where the tools will run. </li>
<li>Setting up some subsidiary <var class="product">Model 204</var> files.</li>
<li>Verifying that the environment has the appropriate parameter settings. </li>
</ol>
For details, see [[RKTools installation]].
Upgrades to <var class="product">RKTools</var> can almost always be handled by restoring a fresh copy of the <code>SIRIUS</code> file.
==Integrating <var class="product">RKTools</var> with other subsystems==
<var class="product">RKTools</var> and any of its constituent products can be easily integrated with other <var class="product">SOUL</var> subsystems. Whenever an <var class="product">RKTools</var> component product is exiting, it first checks to see if the global variable <var>SIRIUS.COMM</var> exists and has a non-null value. If so, the <var class="product">RKTools</var> product performs a subsystem transfer using the value in <var>SIRIUS.COMM</var> as the name of the target subsystem.
For example, the following code fragment lets you transfer into <code>SIRMON</code>. When <code>SIRMON</code> exits, control is transferred to the application subsystem <code>MENUSYS</code>, provided that <code>NEXT</code> is the current subsystem's communication global variable:
<p class="code">%rc = $Setg('SIRIUS.COMM','MENUSYS')
%rc = $Setg('NEXT','XFER')
%rc = $Setg('XFER','SIRMON')
STOP
</p>
In addition to the individual <var class="product">SOUL</var> subsystems that implement the <var class="product">RKTools</var> products,
Rocket Software distributes an umbrella <var class="product">RKTools</var> subsystem, accessed by entering <code>RKTOOLS</code> from the Model&nbsp;204 command line. The <b>RKTOOLS</b> subsystem provides a menu that contains entries for all <var class="product">RKTOOLS</var> components installed at a site:
<p class="caption" style="width:450px">RKTools main menu</p>
<p class="figure">[[File:RKToolsMainMenu.png|450px]]</p>
===Fast-pathing===
===Fast-pathing===
The <var class="product">RKTOOLS</var> subsystems support fast-path navigation. For example, a <var class="product">SirMon</var> user can transfer into the <var class="product">SirPro</var> main menu option 1 destination (the [[SirPro procedure-list selection]] screen) by using the component subsystem name or short-code along with a menu number:  
The <var class="product">RKTOOLS</var> subsystems support fast-path navigation. For example, a <var class="product">SirMon</var> user can transfer into the <var class="product">SirPro</var> main menu option 1 destination (the [[SirPro procedure-list selection]] screen) by using the component subsystem name or short-code along with a menu number:  
Line 74: Line 6:
<p class="code">pro 1
<p class="code">pro 1
</p>
</p>
And a user in <var class="product">SirScan</var> can enter <code>sirmon 3.1</code> on the command line and be transferred directly to the option 1 (Resource Usage) destination of the <var class="product">SirMon</var> main menu option 3 (User Monitor) screen.
And a user in <var class="product">SirScan</var> can enter <code>sirmon 3.1</code> on the command line and be transferred directly to the option 1 (<b>Resource Usage</b>) destination of the <var class="product">SirMon</var> main menu option 3 (<b>User Monitor</b>) screen.


====PL command====
====PL command====
A special command, <var>PL</var>, allows direct entry to the [[SirPro procedure-list operations#Overview|Procedure List screen]] in SirPro. The command format is:
<var>PL</var> is both a special subsystem and a command that lets you directly enter the [[SirPro procedure-list operations#Overview|Procedure List screen]] in <var class="product">SirPro</var>. The command is like a <code>pro 1</code> fast-path command combined with procedure-search specifications.
 
The command format is:
<p class="syntax">PL [<span class="term">procedurePattern</span>] [FILE <span class="term">filename</span> | GROUP <span class="term">groupname</span>]
<p class="syntax">PL [<span class="term">procedurePattern</span>] [FILE <span class="term">filename</span> | GROUP <span class="term">groupname</span>]
</p>
</p>
where <var class="term">procedurePattern</var> supports the wildcard usage described in [[SirPro procedure-list selection#procname|Procedure name]].  
where <var class="term">procedurePattern</var> supports the wildcard usage described in [[SirPro procedure-list selection#procname|Procedure name]].  


If a <var>FILE</var> or <var>GROUP</var> clause is not supplied, the current open context is used. The context is obtained using <code>$view('APDFCNTX')</code> (see the <var>[[DEFCNTX and APDFCNTX parameters|APDFCNTX]]</var> parameter).
If you do not specify a <var>FILE</var> or <var>GROUP</var> clause, one of the following is used:
<ul>
<li>The current open context. This context is obtained using <code>VIEW APDFCNTX</code> or <code>$view('APDFCNTX')</code> (see the <var>[[DEFCNTX and APDFCNTX parameters|APDFCNTX]]</var> parameter). </li>
 
<li>The last-visited SirPro procedure list. </li>
</ul>


<blockquote class="note">
<blockquote class="note">
<p><b>Note:</b> Use a <var>PL</var> command like the following to search for procedure names that contain the words "FILE" or "GROUP": </p>
<p><b>Note:</b> To search for procedure names that contain the words "FILE" or "GROUP", use a <var>PL</var> command like the following: </p>
<p class="code">PL File FILE <i>filename</i></p>
<p class="code">PL File FILE <i>filename</i></p>
<p>
<p>
Line 95: Line 34:
</ul>
</ul>
</blockquote>
</blockquote>
==Release notes==
Each RKTools release has the version number of the Model&nbsp;204 release whose features it can exploit. 
For information about member product changes and new features contained in a release, see the RKTools release notes for your version of Model&nbsp;204 (for example, [[Release notes for RKTools V7.5]]).
[[Category: RKTools]]

Revision as of 18:20, 4 May 2016

Fast-pathing

The RKTOOLS subsystems support fast-path navigation. For example, a SirMon user can transfer into the SirPro main menu option 1 destination (the SirPro procedure-list selection screen) by using the component subsystem name or short-code along with a menu number:

sirpro 1

Or:

pro 1

And a user in SirScan can enter sirmon 3.1 on the command line and be transferred directly to the option 1 (Resource Usage) destination of the SirMon main menu option 3 (User Monitor) screen.

PL command

PL is both a special subsystem and a command that lets you directly enter the Procedure List screen in SirPro. The command is like a pro 1 fast-path command combined with procedure-search specifications.

The command format is:

PL [procedurePattern] [FILE filename | GROUP groupname]

where procedurePattern supports the wildcard usage described in Procedure name.

If you do not specify a FILE or GROUP clause, one of the following is used:

  • The current open context. This context is obtained using VIEW APDFCNTX or $view('APDFCNTX') (see the APDFCNTX parameter).
  • The last-visited SirPro procedure list.

Note: To search for procedure names that contain the words "FILE" or "GROUP", use a PL command like the following:

PL File FILE filename

where:

  • File indicates procedures whose name contains the word "File".
  • FILE is required because the context is not automatically added if searching for the words "FILE" or "GROUP".