This chapter contains detailed descriptions of the commands used to work with RSF packages.
When you create a package, you specify where on your machine to find the save file and cover letter associated with an RSF transmission. Other package attributes govern the conditions under which the package may be accessed.
In general, objects must be associated with an RSF package in order to be sent or retrieved with Remote Software Facility.
However, you can use the Copy File Using RSF (CPYFRSF) command to send and retrieve database file members that are not part of a package. You can also use the commands in library RSFTOOLS to send and retrieve other objects without having to create a new RSF package each time. See Appendix B for more information about RSFTOOLS.
The Work With RSF Packages (WRKRSF) command is used to work with a list of packages on your machine, or to print a list of packages. You create packages with the Create RSF Package (CRTRSF) command. See Creating Packages for more information about this command.
While working with RSF packages, you can easily create, delete, change, copy, and rename packages on your machine. You can also display detailed information about packages, display the cover letters associated with packages and display the save files associated with packages.
The prompted version of the WRKRSFPKG command is shown below.
The parameters for the WRKRSFPKG command are described below in the order that they appear on the command prompt. Default values are underlined.
Indicate which entries to include in the list.
The possible values are:
*ALL: No entries are excluded based on name.
generic-name: Enter a generic name for the servers to be included in the list. Case is significant. An asterisk (*) in the generic specification will match any string of zero or more characters in the name. An underscore (_) in the generic specification will match any single character in the name.
Enter characters to compare to entry text to determine which entries should be included in the list. An entry is included in the list if the entry text contains the string specified. Case is not significant.
The possible values are:
*ALL: No entries are excluded based on text.
string: Enter any text string of up to 50 characters.
Indicates whether the list should be displayed or printed.
The possible values are:
*: Display the list.
*PRINT: Print the list.
Controls the amount of detail shown when printing the list.
The possible values are:
*BASIC: A subset of the total information is shown for each package. Multiple packages are printed per page.
*FULL: All information is shown for each package. One package is printed per page.
The display that is presented when you specify OUTPUT(*) on the WRKRSFPKG command is shown below.
The following function keys may be used with this display:
F3: Exit without updating.
F5: Refresh the display.
F6: Create a new package.
F12: Cancel.
F13: Change user defaults.
F21: Present a system command line window.
The fields on the Work with RSF Packages display are explained below.
Enter a value in the "Position to" field and press Enter to position the list to a specific entry. The cursor is positioned to the first entry in the list that is greater than or equal to the "Position to" value you specify.
Enter an option number in the "Opt" column beside a list entry, and press Enter to perform a function on the list entry. You may enter options beside several list entries before pressing Enter. The options for the list entries are processed in turn when you press Enter. The following is a list of options and their functions.
2=Change: The CHGRSFPKG command prompt is displayed with the current values for the entry filled in.
3=Copy: A display is presented with which you specify the new names for entries to be copied.
4=Delete: A display is presented allowing you to confirm your choices for delete. When you press Enter a second time, the entries are deleted.
5=Display: Detailed information about the entry is displayed.
7=Rename: A display is presented with which you specify new names for the entries to be renamed.
8=Display cover : letter: The cover letter associated with the package is displayed.
10=Display save file: The contents of the save file associated with the package are displayed.
user-defined-option: You may key a user-defined option. To define new options, select option 9 from the Start PDM (STRPDM) menu.
See the on-line help text for this display for more information about user-defined options.
The name of each package appears in this column.
The current status for the package is shown.
The possible values are:
*HELD: Remote AS/400s attempting to access the package will receive a message indicating that the package is temporarily unavailable
blank: The package is available to be retrieved.
Text describing the package is shown. Type over the text and press Enter to change the text.
When you press F13, the Change User Defaults panel is presented.
The following commands are discussed elsewhere in this manual:
Create Package (CRTRSFPKG)
Work With Catalog (WRKRSFCAT)
Install RSF Package (INLRSFPKG)
Log Package Install (LOGRSFINL)
Retrieve Install Information (RTVRSFINL)
For more information about the following commands, prompt the command and press F1 to view the on-line help text:
Change Package (CHGRSFPKG)
Delete Package (DLTRSFPKG)
Rename Package (RNMRSFPKG)
The Create RSF Package (CRTRSFPKG) command is used to create a new RSF package on your machine.
An RSF package contains information that tells Remote Software Facility where on your machine to find the save file and cover letter when a remote AS/400 requests to access the package or when you reference the package to send objects to another machine. Other information is stored with the package that governs the conditions under which the package may be accessed.
The prompted version of the CRTRSFPKG command is shown below. Click on the image to see command parameter descriptions.
The parameters for the CRTRSFPKG command are described below.
The name of a new RSF package to be created on your machine. This is a required parameter.
The possible values are:
name: Enter the name for a new package.
*CATALOG: Create a special package to handle catalog requests from remote AS/400s. Creating this package gives you more control over the handling of incoming catalog requests. If a *CATALOG package does not exist when a request for a catalog is received from a remote system, installation default values govern how the request is handled. See Setting Product Defaults for more information about installation defaults.
The qualified name of a save file that contains, or will contain the objects associated with the package. Make sure that user profile RSFSRV is authorized to the save file. See Security Considerations For RSF Servers for more information about save file authority.
The possible values are:
*PKG: The package name is used for the save file name.
name: Enter the name of a save file. The save file does not have to exist at the time the package is created, but it must exist at the time a request to access the package is processed. The save file can be created by a pre-processing program if one is associated with this package.
*NONE: This value is only valid when *CATALOG is specified for "Package".
The possible library values are:
*LIBL: The job library list is used to locate the save file.
*CURLIB: The current library is used to locate the save file.
library name: The name of an existing library which contains, or will contain the save file.
The name of an existing spooled file that contains the print image of the cover letter to be associated with the package. This can be changed later with the CHGRSFPKG command.
The possible values are:
*NONE: No cover letter is associated with the package.
*PKG: The package name is used for the spooled file name.
name: The name of an existing spooled file to associate with the package. The spooled file data is copied to an internal format as the command is processed, so the spooled file does not need to exist at the time a request to access the package is received.
The qualified name of a job containing the spooled file to be associated with the RSF package. This parameter is ignored if *NONE is specified for "Spooled file with cover letter".
The possible values are:
*: The spooled file is found in the current job.
name: The name of a job containing the spooled file.
The possible user values are:
name: The user id associated with the job.
The possible job number values are
000000-999999: The number for the job.
The number of the spooled file that is to be associated with the package. This parameter is ignored if *NONE is specified for "Spooled file with cover letter".
The possible values are:
*LAST: The last spooled file with the specified name, in the specified job is used.
*ONLY: The only spooled file with the specified name, in the specified job is used.
1-9999: The number of the spooled file that contains cover letter data to be associated with the RSF package.
Whether the cover letter data in the named spooled file replaces or is added to existing cover letter data for the package. This parameter is ignored if *NONE is specified for "Spooled file with cover letter".
The possible values are:
*REPLACE: The cover letter data in the named spooled file replaces the cover letter data associated with the package.
*ADD: The cover letter data in the named spooled file is appended to the cover letter data associated with the package.
Free format text describing the package.
The possible values are:
characters: Enter up to 50 characters of text that describes the package.
The qualified name of a user program to call before granting access to the package. If specified, this program is called upon receiving a request to access the package, before an acknowledgment is sent to the requester. Depending upon how the program returns, access to the package is either granted or denied. See Pre-Processing Programs for more information.
*SYSVAL: The value specified for installation defaults is used. See Setting Product Defaults for more information about installation defaults.
*NONE: No pre-processing program is called.
program name: The name of a pre-processing program to call.
The possible library values are:
*LIBL: The job library list is used to locate the program.
*CURLIB: The current library is used to locate the program.
library name: The name of an existing library which contains the specified program.
The qualified name of a user program to call to determine whether information about the package should be sent to the requester for a *CATALOG request. If specified, this program is called for the RSF package upon receiving a request for a catalog. Depending upon how the program returns, catalog information about the package is either sent to the requester or not. See Catalog Pre-Processing Programs for more information.
The possible values are:
*SYSVAL: The value specified for installation defaults is used. See Setting Product Defaults for more information about installation defaults.
*NONE: No catalog pre-processing program is called.
program name: The name of a catalog pre-processing program to call.
The possible library values are:
*LIBL: The job library list is used to locate the program.
*CURLIB: The current library is used to locate the program.
library name: The name of an existing library which contains the specified program.
The initial status for the package when it is created.
The possible values are:
*NORMAL: The package is available to be accessed.
*HOLD: Requesters attempting to access the package receive a message indicating that the package is temporarily unavailable.
The maximum number of times each remote AS/400 can access the package. If a requester attempts to access the package more than the number of times allowed, an error message is sent and the request ends abnormally.
*SYSVAL: The value specified for installation defaults is used. See Setting Product Defaults for more information about installation defaults.
*NOMAX: There is no limit to the number of times the package can be accessed by each requester.
1-9999997: The number of times the package can be accessed by each requester.
The qualified name of a message queue to receive normal transaction messages. If specified, information and completion messages generated during a successful transactions for the package are sent to the message queue.
The possible values are:
*SYSVAL: The value specified for installation defaults is used. See Setting Product Defaults for more information about installation defaults.
*NONE: Information and completion messages generated from successful transactions are not sent.
name: The name of a message queue to which information and completion messages generated from successful transactions are sent.
The possible library values are:
*LIBL: The job library list is used to locate the message queue.
*CURLIB: The current library is used to locate the message queue.
library name: The name of an existing library which contains the specified message queue.
The qualified name of a message queue to receive abnormal transaction messages. If specified, error messages generated during unsuccessful transactions for the package are sent to the message queue.
The possible values are:
*SYSVAL: The value specified for installation defaults is used. See Setting Product Defaults for more information about installation defaults.
*NONE: Error messages generated from unsuccessful transactions are not sent. Error message ids will still appear in the RSF log.
name: The name of a message queue to which error messages generated from unsuccessful transactions are sent.
The possible library values are:
*LIBL: The job library list is used to locate the message queue.
*CURLIB: The current library is used to locate the message queue.
library name: The name of an existing library which contains the specified message queue.
The qualified name of a message queue to receive ad hoc requester messages. If specified, ad hoc messages for this package, sent by requesters using the MSG parameter on one of the RSF commands, are sent to the message queue.
The possible values are:
*SYSVAL: The value specified for installation defaults is used. See Setting Product Defaults for more information about installation defaults.
*NONE: Ad hoc requester messages are not sent. The messages are still logged in the RSF log and can be viewed with the WRKRSFLOG command.
name: The name of a message queue to which ad hoc requester messages are sent.
The possible library values are:
*LIBL: The job library list is used to locate the message queue.
*CURLIB: The current library is used to locate the message queue.
library name: The name of an existing library which contains the specified message queue.
What to show for the number of records contained in the cover letter for the package. The number of records is sent to requesters for each RSF package when a *CATALOG request is processed. The number of records is also displayed when detailed information about an RSF package is displayed with option 5 on the Work With RSF Packages display.
The possible values are:
*CALC: Calculate the number of records dynamically at run time from the actual cover letter data associated with the package. If no cover letter can be found, zero is reported for number of records.
1-9999999: A constant number to report for number of records. Reporting a constant number provides a small performance advantage over calculating the number of records dynamically. In addition, since the cover letter can be created with a pre-processing program, the actual cover letter data may not exist at the time the number of records is required. In this case, specifying a constant number allows you to estimate the number of records that are expected to be in the cover letter.
What to show for the number of records contained in the save file associated with the package. The number of records is sent to requesters for each RSF package when a *CATALOG request is processed. The number of records is also displayed when detailed information about an RSF package is displayed with option 5 on the Work with RSF Packages display.
The possible values are:
*CALC: Calculate the number of records dynamically at run time from the actual save file data associated with the package. If no save file data can be found, zero is reported for number of records.
1-9999999: A constant number to report for number of records. Reporting a constant number provides a small performance advantage over calculating the number of records dynamically. In addition, since the save file can be created with a pre-processing program, the actual save file data may not exist at the time the number of records is required. In this case, specifying a constant number allows you to estimate the number of records that are expected to be in the save file.
The following commands are discussed elsewhere in this manual:
Work With Packages (WRKRSFPKG)
Work With Catalog (WRKRSFCAT)
Install RSF Package (INLRSFPKG)
Log Package Install (LOGRSFINL)
Retrieve Install Information (RTVRSFINL)
For more information about the following commands, prompt the command and press F1 to view the on-line help text:
Change Package (CHGRSFPKG)
Delete Package (DLTRSFPKG)
Rename Package (RNMRSFPKG)
Pre-processing programs allow you to customize the handling of RSF requests received by your machine. A pre-processing program associated with an RSF package is called when a request for the package is received from a remote system. The pre-processing program may also be called when you send the package to a remote server from your machine. Depending on how the pre-processing program returns, access to the package is either granted or denied.
Use pre-processing programs to:
You can specify a system default pre-processing program. See Setting Product Defaults for more information about changing RSF defaults. You can associate a pre-processing program with specific packages using the Create RSF Package (CRTRSFPKG) or Change RSF Package (CHGRSFPKG) command. See Creating Packages for more information.
The following parameters are passed to all pre-processing programs:
Request Structure, CHAR(*), (Input/Output): A data structure containing information about the request. You can use physical file RSDS002 in library RSF to externally define the data structure. See Appendix A for a detailed description of the fields contained in this data structure.
Message Data, CHAR(128), (Output): If this field is blank upon returning from the pre-processing program, access to the package is granted. If this field is not blank upon returning from the user program, the message data is sent to the requester as message RSF9896. When the message data returned is not blank, the value specified for the Message Type parameter determines whether the request ends normally or abnormally. If *ESCAPE is specified for Message Type, the request ends abnormally
Message Type, CHAR(7), (Output): This parameter is ignored if Message Data is blank. Allowable values are: *INFO, *COMP, *DIAG, *NOTIFY, *STATUS and *ESCAPE. *ESCAPE is assumed if an invalid value is returned. The value specified governs whether the request ends normally or abnormally. If *ESCAPE is specified and "Message data" is not blank, access to the package is denied.:
Library RSFTOOLS contains sample pre-processing programs. See Appendix B for information about RSFTOOLS.
Catalog pre-processing programs allow you to customize the handling of *CATALOG requests received by your machine. A catalog pre-processing program associated with an RSF package is called when a *CATALOG request is received from a remote system. Depending on how the pre-processing program returns, catalog information about the package is or is not returned to the requester.
Use catalog pre-processing programs to:
You can specify a system default catalog pre-processing program. See Setting Product Defaults for more information about changing RSF defaults. You can associate a catalog pre-processing program with specific packages using the Create RSF Package (CRTRSFPKG) or Change RSF Package (CHGRSFPKG) command. See Creating Packages for more information.
The same parameters are passed to catalog pre-processing programs as are passed to regular pre-processing programs. This allows you to write a single program that can be used to pre-process both download requests and catalog requests for a given RSF package.
The following parameters are passed to all catalog pre-processing programs:
Request Structure, CHAR(*), (Input): A data structure containing information about the request. You can use physical file RSDS002 in library RSF to externally define the data structure. See Appendix A for a detailed description of the fields contained in this data structure.
Message Data, CHAR(128), (Output): If this field is blank upon returning from the pre-processing program, catalog information for the package is returned to the requester. If this field is not blank upon returning from the user program, the value specified for the "Message type" parameter determines whether or not catalog information for the package is returned to the requester. If *ESCAPE is specified for "Message type", catalog information for the package is not returned to the requester.
Message Type, CHAR(7), (Output): This parameter is ignored if "Message data" is blank. Allowable values are: *INFO, *COMP, *DIAG, *NOTIFY, *STATUS and *ESCAPE. *ESCAPE is assumed if an invalid value is returned. The value specified governs whether catalog information for the package is returned to the requester. If *ESCAPE is specified and "Message data" is not blank, catalog information is not returned.
Library RSFTOOLS contains sample catalog pre-processing programs. See Appendix B for information.
If you will be allowing remote requesters to send RSF packages to your machine with the SNDRSFPKG command, you may want to specify one or more user programs to be called when a package is received. Use the ADDRSFRDE and CHGRSFRDE commands to specify user programs to be called upon receiving packages from various requesters. The programs specified will be called after all of the data associated with a package has been received, and only if the package is received successfully. Depending on how the user program returns, the SNDRSFPKG request will end normally or abnormally
Use post-processing programs to:
You can specify a system default post-processing program with the Change RSF Defaults (CHGRSFDFT) command. See Setting Product Defaults for more information about this command. You can associate a post-processing program with a specific requester using the ADDRSFRDE or CHGRSFRDE commands. See Adding Requester Directory Entries for more information.
The following parameters are passed to all post processing programs:
Request Structure, CHAR(*), (Input/Output): A data structure containing information about the request. You can use physical file RSDS002 in library RSF to externally define the data structure. See Appendix A for a detailed description of the fields contained in this data structure.
Message Data, CHAR(128), (Output): If this field is not blank upon returning from the user program, the message data is sent to the requester as message RSF9896. When the message data returned is not blank, the value specified for the "Message type" parameter determines whether the request ends normally or abnormally. If *ESCAPE is specified for "Message type", the request ends abnormally.
Message Type, CHAR(7), (Output): This parameter is ignored if "Message data" is blank. Allowable values are: *INFO, *COMP, *DIAG, *NOTIFY, *STATUS and *ESCAPE. *ESCAPE is assumed if an invalid value is returned. The value specified governs whether the request ends normally or abnormally. If *ESCAPE is specified and "Message data" is not blank, the request ends abnormally.
Library RSFTOOLS contains sample post-processing programs. See Appendix B for information.
Automatic installation programs can be included with RSF packages to facilitate the installation of objects contained in the package. Automatic installation programs must always be named RSFINST.
To include an automatic installation program with a package, create a program named RSFINST and save it--along with the other objects for the package--into the save file that is associated with the package.
An automatic installation program is invoked by either the Retrieve RSF Package (RTVRSFPKG) or the Schedule RSF Transmission (SCDRSFTNS) command when the user specifies *TRY or *YES for "Automatic installation". Automatic installation programs can also be invoked by the Install RSF Package (INLRSFPKG) command. If automatic installation is requested and the package has been successfully transmitted, RSF restores program RSFINST to library QTEMP and then runs the program.
See Retrieving Packages for more information about the RTVRSFPKG command. See Scheduling Transmissions for more information about the SCDRSFTNS command. See Installing a Package as a Separate Step for more information about the INLRSFPKG command.
Note: It is good practice for automatic installation programs to log the package as installed when the installation completes successfully. The Log Package Install (LOGRSFINL) command is provided for this purpose and should be included as the last step in the program. The server ID and package name to pass to the LOGRSFINL command can be taken from the Request Structure parameter that is passed to the automatic installation program (see below).
The following parameters are passed to all RSFINST programs:
Request structure, CHAR(*), (Input): A data structure containing information about the request. You can use physical file RSDS002 in library RSF to externally define the data structure. See Appendix A for a detailed description of the fields contained in this data structure.
Message Data, CHAR(128), (Output): If this field is blank upon returning from the program, the installation ends normally. If this field is not blank upon returning from the program, the message data is sent to the requester as message RSF9896. When the message data returned is not blank, the value specified for the "Message type" parameter determines whether or not the request ends normally. If *ESCAPE is specified for "Message Type", the request ends in error.
Message Type, CHAR(7), (Output): This parameter is ignored if "Message data" is blank. Allowable values are: *INFO, *COMP, *DIAG, *NOTIFY, *STATUS and *ESCAPE. *ESCAPE is assumed if an invalid value is returned. The value specified governs whether the installation ends normally or not. If *ESCAPE is specified and "Message data" is not blank, the installation program ends in error.
Saved library, CHAR(10), (Input): The name of the library that was saved to the save file, or the name of the library containing the objects that were saved.
Save command, CHAR(10), (Input): The command that was used to save the objects.
Library RSFTOOLS contains sample installation programs. See Appendix B for information.
Many packages are installed at the time they are retrieved by specifying *YES for "Automatic Installation" on the Retrieve RSF Package (RTVRSFPKG) command or on the Work With Catalog display. Occasionally, however, it is convenient to retrieve and install the package in two separate steps. The Install RSF Package (INLRSFPKG) command is supplied for this purpose, allowing you to install a package from a save file that was previously transmitted.
However, in order to be installed with the INLRSFPKG command, the save file associated with the package must support automatic installation by containing an RSFINST install program.
The prompted version of the INLRSFPKG command is shown below. Click on the image to see command parameter descriptions.
The parameters for the INLRSFPKG command are described below.
Enter the qualified name of the package to be installed. The server ID is used to qualify the package name.
This is a required parameter
The possible single values are:
*SAVF: A save file name is specified instead of a package name. When *SAVF is specified for this parameter, you must specify a value for the Save File (SAVF) parameter.
The possible package values are:
package-name: Enter the name of the package to be installed.
The possible server values are:
server-ID: Enter ID of the server from which the package was retrieved.
Enter the qualified name of a save file containing the data to be installed.
This parameter is ignored unless *SAVF is specified for the Package To Install (PKG) parameter.
The possible values are:
save-file-name: Enter the name of the save file containing the RSF package data.
The possible library values are:
*LIBL: Your job's library list is used to locate the save file.
*CURLIB: Your job's current library is used to locate the save file.
library-name: Enter the name of the library which contains the save file.
Specify the name of the install program to call. See Automatic Installation Programs for more information.
The possible values are:
*INSTALL: RSF attempts to restore program RSFINST to library QTEMP from the package save file. If program RSFINST can be restored, it is run.
It is the user's responsibility to write installation program RSFINST and include it in the save file for the package if automatic installation for this package is to be supported.
program-name: Enter the name of the installation program to call.
The possible library values are:
*LIBL: Your job's library list is used to locate the program.
*CURLIB: Your job's current library is used to locate the program.
library-name: Enter the name of the library which contains the program.
Specify whether to check the package retrieval date and the save file change date for validity.
The possible values are:
*YES: The dates are checked. If the save file was changed after the package was retrieved, the request ends in error.
*NO: The save file date is not checked.
Specify whether to check the package install date.
The possible values are:
*YES: The request ends in error if the package was installed after it was last retrieved.
*NO: The install date is not checked.
Enter an ad hoc message to be passed to the install program. The message can be used to send parameters to the install program.
The possible values are:
*NONE: No message is sent.
message-text: Enter up to 128 characters of parameters or message text.
The following commands are discussed elsewhere in this manual:
Work With Packages (WRKRSFPKG)
Create RSF Package (CRTRSFPKG)
Work With Catalog (WRKRSFCAT)
Log Package Install (LOGRSFINL)
Retrieve Install Information (RTVRSFINL)
For more information about the following commands, prompt the command and press F1 to view the on-line help text:
Change Package (CHGRSFPKG)
Delete Package (DLTRSFPKG)
Rename Package (RNMRSFPKG)
You can use the Log Package Install (LOGRSFINL) command to indicate when a package from a remote server has been retrieved or installed.
RSF automatically flags a package as retrieved when the package is successfully retrieved using either the Work With Catalog display or the Retrieve RSF Package (RTVRSFPKG) command. The server ID logged is the server from which the package was retrieved.
RSF also automatically flags a package as retrieved when the package is successfully sent with the Send RSF Package (SNDRSFPKG) command. In this case, the log entry is made on the server (target) machine, and the name of the requester directory entry used to process the request is the name logged for server ID.
RSF does not automatically log package installs. This must be done explicitly by the user. The recommended way is to include this command as the last step in user-written automatic installation programs. The name of the package and the server ID are included in the data structure that is passed to automatic installation programs.
The prompted version of the LOGRSFINL command is shown below. Click on the image to see command parameter descriptions.
The parameters for the LOGRSFINL command are described below.
Enter the ID for the server from which the package was retrieved.
This is a required parameter
The possible values are:
server-ID: Enter a valid server ID. The name of the server ID used for an actual transaction is included in the data structure that is passed to automatic installation programs.
Enter the name of the package to be logged.
This is a required parameter
The possible values are:
package-name: Enter a valid package name. The name of the package retrieved is included in the data structure that is passed to automatic installation programs.
Specify the log action to take.
The possible values are:
*INL: The package is logged as installed.
*RTV: The package is logged as retrieved.
*RESET: Existing log information for a package is cleared.
Specify the qualified name of the save file into which the retrieved package data was placed. This information may be used later to install the package.
This is a required parameter if *RTV is specified for the Action parameter.
The possible values are:
file-name: Specify the target save file name.
The possible library values are:
QGPL: Library QGPL is used by default.
*CURLIB: The save file is in the job's current library.
library-name: Enter a valid library name.
The following commands are discussed elsewhere in this manual:
Work With Packages (WRKRSFPKG)
Create RSF Package (CRTRSFPKG)
Work With Catalog (WRKRSFCAT)
Install RSF Package (INLRSFPKG)
Retrieve Install Information (RTVRSFINL)
For more information about the following commands, prompt the command and press F1 to view the on-line help text:
Change Package (CHGRSFPKG)
Delete Package (DLTRSFPKG)
Rename Package (RNMRSFPKG)
You can use the Retrieve Install Information (RTVRSFINL) command in a CL program to retrieve package install information, such as the date and time a package was retrieved or installed.
RSF automatically flags a package as retrieved when the package is successfully retrieved using either the Work With Catalog display or the Retrieve RSF Package (RTVRSFPKG) command. The server ID logged is the server from which the package was retrieved.
RSF also automatically flags a package as retrieved when the package is successfully sent with the Send RSF Package (SNDRSFPKG) command. In this case, the log entry is made on the server (target) machine, and the name of the requester directory entry used to process the request is the name logged for server ID.
RSF does not automatically log package installs. This must be done explicitly by the user. The recommended way is to include the Log Package Install (LOGRSFINL) command as the last step in user-written automatic installation programs. The name of the package and the server ID are included in the data structure that is passed to automatic installation programs.
The prompted version of the RTVRSFINL command is shown below. Click on the image to see command parameter descriptions.
The parameters for the RTVRSFINL command are described below.
Enter the ID for the server from which the package was retrieved.
This is a required parameter
The possible values are:
server-ID: Enter a valid server ID.
Enter the name of the package for which information is being retrieved.
This is a required parameter
The possible values are:
package-name: Enter a valid package name.
Enter the name of a CL variable to receive the date the package was retrieved. The date is returned in yyyymmdd format. All zeros are returned if the package has not been retrieved.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(8).
Enter the name of a CL variable to receive the time the package was retrieved. The date is returned in hhmmss format. All zeros are returned if the package has not been retrieved.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(6).
Enter the name of a CL variable to receive the name of the user who retrieved the package. Blanks are returned if the package has not been retrieved.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(10).
Enter the name of a CL variable to receive the name of the save file into which the retrieved package data was placed. Blanks are returned if the package has not been retrieved.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(10).
Enter the name of a CL variable to receive the name of the library containing the save file. Blanks are returned if the package has not been retrieved.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(10).
Enter the name of a CL variable to receive the date the package was installed. The date is returned in yyyymmdd format. All zeros are returned if the package has not been installed.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(8).
Enter the name of a CL variable to receive the time the package was installed. The time is returned in hhmmss format. All zeros are returned if the package has not been installed.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(6).
Enter the name of a CL variable to receive the name of the user who installed the package. Blanks are returned if the package has not been installed.
The possible values are:
variable-name: Enter the name of a CL variable. The variable should be declared as TYPE(*CHAR) LEN(10).
The following commands are discussed elsewhere in this manual:
Work With Packages (WRKRSFPKG)
Create RSF Package (CRTRSFPKG)
Work With Catalog (WRKRSFCAT)
Install RSF Package (INLRSFPKG)
Log Package Install (LOGRSFINL)
For more information about the following commands, prompt the command and press F1 to view the on-line help text:
Change Package (CHGRSFPKG)
Delete Package (DLTRSFPKG)
Rename Package (RNMRSFPKG)
Use the Install Pre- or Co-Requisite (INLRSFREQ) command to install a pre- or co-requisite package. This command is usually included in RSF automatic install programs.
A pre-requisite package is one that must be installed before the current package can be installed. A co-requisite package is one that that is meant to work with the current package. Co-requisites should be installed immediately after the current package is installed.
See program REQUISITE in RSFTOOLS/QCLSRC for an example of installing a package with pre-requisites.
The INLRSFREQ command will:
The prompted version of the INLRSFREQ command is shown below. Click on the image to see command parameter descriptions.
The parameters for the INLRSFREQ command are described below.
Enter the ID for the server from which the package is retrieved.
This is a required parameter
The possible values are:
server-ID: Enter a valid server ID.
Enter the pre- or co-requisite package to be installed.
This is a required parameter
The possible values are:
package-name: Enter a valid package name.
Whether RSF should hang up the phone connection at the completion of the transaction. This parameter is ignored for non-switched connections. Click here for a complete description of this parameter.
The following commands are discussed elsewhere in this manual:
Install RSF Package (INLRSFPKG)
Log Package Install (LOGRSFINL)