GETRULES

. [GETRULES] ----------

- [RuleFn [RuleFt -[ ( DISK LOCK -]]] [Userid [USRDFLT [--------NOLOCK]]] -----------------[---EDIT LOCK -]]] -----------------[--------NOLOCK]]] -----------------[---PANEL------]]] ----------------------------------------------------- RuleFn - The file name of the rule file to be ---------retrieved. The default is the userid ---------of the issuing user. RuleFt - The file type of the rule file to be ---------retrieved. The default is USRDFLT. ( OPTIONS: DISK --- Indicates the rule file retrieved ---------should be written on the issuing user's ---------A disk. EDIT-- - Puts the issuing user in an XEDIT ---------session where the rule file may be ---------edited. PANEL--- Places the issuing user in a fullscreen ---------panel that allows the user to ---------view/update the rules in the rule file. ---------The rule file is locked while the panel ---------is active. Panel is the default. LOCK---- Locks the rule file, so that it may be ---------updated exclusively by the issuing user ---------LOCK is the default. NOLOCK - Specifies the rule file is not locked. --

Purpose

Use the GETRULES command to retrieve a copy of a SafeSFS rule file. The rule file may then be viewed or updated. The user may update the file interactively using XEDIT, a fullscreen SafeSFS panel, or may store the file on their A-disk. Locking of the rule file prevents conflicting, simultaneous updates by multiple users. The rule file must be locked for updates. NOLOCK should be used when viewing, but not updating the file.

Authorization

MANAGE authorization over the rule file to be updated or viewed or SAFADMIN authorization.

Parameters

RuleFn :

The file name of the rule file to be retrieved. The default is the userid of the issuing user.

RuleFT :

The file type of the rule file to be updated. It must be one of the following:

ADMIN	Specifies the GLOBAL ADMIN rule file. The RuleFn parameter must be GLOBAL.
GRPADMIN	Specifies the RuleFn GRPADMIN rule file, where RuleFn is the file name of the rule file to be retrieved.
USRADMIN	Specifies the RuleFn USRADMIN rule file, where RuleFn is the file name of the rule file to be retrieved.
USRDFLT	Specifies the RuleFn USRDFLT rule file, where RuleFn is the file name of the rule file to be retrieved. USRDFLT is the default.
GRPDFLT	Specifies the RuleFn GRPDFLT rule file, where RuleFn is the file name of the rule file to be retrieved.
DEFAULT	Specifies the GLOBAL DEFAULT rule file. The RuleFn parameter must be GLOBAL.
MANAGE	Specifies the SAFESFS MANAGE rule file. The RuleFn parameter must be SAFESFS.

Options:

DISK	Indicates the rule file specified should be written on the issuing user's A disk.
EDIT	Indicates the issuing user should be placed in an XEDIT session with the specified rule file. If the user issues the XEDIT FILE subcommand after updating the rule file, the new rule file will be written on the SafeSFS rules database mdisk and the changes will take effect immediately. The NOLOCK option is used for viewing the file only.
PANEL	Indicates the issuing user is placed in a fullscreen SafeSFS panel session with the specified rule file. The user may update the rules in the rule file using the SafeSFS fullscreen panels. Any updates made during the panel session will take effect immediately. The rule file is always locked during the fullscreen panel session. The LOCK and NOLOCK options may not be specified when the PANEL option is used.
LOCK	Indicates the requested rule file should be locked. This allows the issuing user to have exclusive update access to the rule file until it is unlocked. (See REPRULES and UNLOCK commands.) The LOCK option may not be used with the PANEL option. LOCK is the default.
NOLOCK	Indicates the requested rule file should not be locked. This allows the issuing user to view the file without updating it. NOLOCK may not be used with the PANEL option.

Return Codes

Return Code	Meaning
0	Command processed successfully.
4	Not authorized.
8	Command failed. Rule file not retrieved or not replaced.
32	File already exists.
114	Invalid option.
116	Invalid rule file name.
115	Invalid rule file type

Usage Notes

1. GETRULES is the default SAFESFS command. The rule file retrieved defaults to the issuer's USRDFLT rule file. The default options are PANEL and LOCK. This means that end users may simply type SAFESFS, and they will be placed into a SafeSFS fullscreen panel that allows them to update their rules. See example below.



2. Always specify NOLOCK if the intention is to browse the file without making changes. This allows another user to update the file simultaneously. NOLOCK may not be used with PANEL.



3. LOCK is always the default.

1. SAFESFS
   This command retrieves the issuing user's USRDFLT rule file, and places them into a SafeSFS fullscreen panel that allows the rule file contents to be updated. The rule file is locked while it is being updated. When the user exits the fullscreen panels, the rule file is unlocked.



2. SAFESFS GETRULES JIM USRDFLT (DISK
   This command retrieves the JIM USRDFLT rule file and places it on the issuing user's A disk. The rule file is locked until it is unlocked by the REPRULES command or the UNLOCK command.



3. SAFESFS GETRULES SYSTEMS GRPADMIN (EDIT
   This command retrieves the SYSTEMS GRPADMIN rule file and places the issuing user into XEDIT on the rule file. The user may update the rule file as desired. The rule file is locked until the user QQUITs or FILEs out of XEDIT. If changes were made and filed, then the SAFESFS rules are updated and the rule file is unlocked.



4. SAFESFS GETRULES SAFESFS MANAGE
   This command retrieves the SAFESFS MANAGE file and places the issuer into a SafeSFS fullscreen panel where the rules may be updated. The file is locked until the user finishes updating the file. This command requires SAFADMIN authorization.