Change System Dir Attributes (CHGSYSDIRA)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Change System Directory Attributes (CHGSYSDIRA) command changes system directory attributes used when working interactively with the directory and the directory shadow systems.
An override program is provided that fills in the values of these directory attributes.
Restrictions:
- You must have security administrator (*SECADM) or all object (*ALLOBJ) special authority to use this command.
- You must have all object (*ALLOBJ) special authority to change the search (SCHPGM), the verification (VRFPGM), or the supplier (SUPPGM) user exit program.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| SCHTYPE | Type of search | *EXACT, *GENERIC, *SAME | Optional, Positional 1 |
| SCHPGM | Search program | Single values: *SAME, *NONE Other values: Qualified object name |
Optional, Positional 2 |
| Qualifier 1: Search program | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| VRFPGM | Verification program | Single values: *SAME, *NONE Other values: Qualified object name |
Optional |
| Qualifier 1: Verification program | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| SUPPGM | Supplier program | Single values: *SAME, *NONE Other values: Qualified object name |
Optional |
| Qualifier 1: Supplier program | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| RTYITV | Retry interval | 1-999, *SAME | Optional |
| RTYLMT | Retry limit | 0-9, *SAME | Optional |
| ALWDSPNUI | Display network user ID | *NO, *YES, *SAME | Optional |
| MSGQ | Message queue | Single values: *SAME Other values: Qualified object name |
Optional |
| Qualifier 1: Message queue | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| RMTSHD | Shadow remote users | *NO, *YES, *SAME | Optional |
| RMVJOBLOG | Remove shadowing job logs | *NO, *YES, *SAME | Optional |
| ALWSCH | Allow search | *NO, *YES, *SAME | Optional |
| USRDFNFLD | User-defined fields | Single values: *SAME Other values (up to 100 repetitions): Element list |
Optional |
| Element 1: Field name | Character value | ||
| Element 2: Product ID | Character value, *NONE | ||
| Element 3: Function | *ADD, *RMV, *CHG, *KEEP | ||
| Element 4: Field type | *DATA, *MSFSRVLVL, *ADDRESS | ||
| Element 5: Maximum field length | 1-512 |
| Top |
Type of search (SCHTYPE)
Specifies the type of search to be applied to the Search System Directory display. The search attribute specified on this parameter applies to the system.
- *SAME
- The value does not change.
- *EXACT
- The system searches for the exact text string specified on the Search System Directory display. This value includes the ability to specify an asterisk (*) as part of the string to find generic values.
- *GENERIC
- The system searches for the text string specified on the Search System Directory display, but makes the end of the string an automatic generic search. An asterisk (*) does not need to be specified at the end of a string to find generic values.
| Top |
Search program (SCHPGM)
Specifies the user exit program that performs a customized search from the Search System Directory display. More information about the user exit program is in the APIs topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
If a user exit program is specified, it must exist.
- *SAME
- The value does not change.
- *NONE
- No search user exit program is specified.
The name of the program can be qualified by one of the following library values:
- *LIBL
- All libraries in the library list for the current thread are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- library-name
- Specify the name of the library to be searched.
- program-name
- Specify the name of the user exit program that performs the user search.
| Top |
Verification program (VRFPGM)
Specifies the user exit program that verifies a change, add, or delete operation for directory entries, departments, and locations that are local or shadowed. This program is called from both a local data entry and from directory shadowing. More information about the user exit program is in the APIs topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
Changes are always verified by the system. If a user exit program is not supplied, no additional verification checking is required by the system. When a user exit program is supplied, the user exit program is called and then system validation is performed.
If a user exit program is specified, it must exist.
- *SAME
- The value does not change.
- *NONE
- No authority user exit program is specified.
The name of the program can be qualified by one of the following library values:
- *LIBL
- All libraries in the library list for the current thread are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- library-name
- Specify the name of the library to be searched.
- program-name
- Specify the name of the user exit program that verifies the modification.
| Top |
Supplier program (SUPPGM)
Specifies the user exit program that decides whether a change, add, or delete operation for directory entries, departments, and locations is to be shadowed to a collector system. This program is called from directory shadowing. More information about the user exit program is in the APIs topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
If a user exit program is not supplied, all changes are sent to the collector system. When a user exit program is supplied, the user exit program is called and then directory shadowing is performed.
If a user exit program is specified, it must exist.
- *SAME
- The value does not change.
- *NONE
- No authority user exit program is specified.
The name of the program can be qualified by one of the following library values:
- *LIBL
- All libraries in the library list for the current thread are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- library-name
- Specify the name of the library to be searched.
- program-name
- Specify the name of the user exit program that decides which records to supply during directory shadowing.
| Top |
Retry interval (RTYITV)
Specifies the number of minutes to wait after an unsuccessful shadow before attempting to shadow again.
- *SAME
- The value does not change.
- retry-interval
- Specify the interval (in minutes) to wait before attempting to shadow the directory data again. Valid values range from 1 through 999.
| Top |
Retry limit (RTYLMT)
Specifies the number of times to retry a directory shadow before the operation fails.
- *SAME
- The value does not change.
- number-of-retries
- Specify the number of retries to perform before ending the directory shadow attempt. Valid values range from 0 through 9.
| Top |
Display network user ID (ALWDSPNUI)
Specifies whether to allow all network user IDs to be displayed or printed by all users. The network user IDs are always displayed or printed for system administrators or for users who display or print their own directory entries.
- *SAME
- The value does not change.
- *YES
- All network user IDs are displayed to all users.
- *NO
- Network user IDs are not displayed to all users.
| Top |
Message queue (MSGQ)
Specifies the qualified name of the message queue to which messages are sent.
- *SAME
- The value does not change.
The name of the message queue can be qualified by one of the following library values:
- *LIBL
- All libraries in the library list for the current thread are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- library-name
- Specify the name of the library to be searched.
- message-queue-name
- Specify the name of the message queue to which messages are sent.
| Top |
Shadow remote users (RMTSHD)
Specifies whether to supply additions, changes, or deletions of locally-defined remote directory entries during directory shadowing. Locally-defined remote directory entries are added locally, but have a system name that is different from the local system name. Changes are always supplied for local directory entries and for shadowed entries.
- *SAME
- The value does not change.
- *YES
- Additions, changes, and deletions to all directory entries are supplied to collecting systems during directory shadowing.
- *NO
- Additions, changes, or deletions of locally-defined remote directory entries are not supplied during directory shadowing. Updates to local directory entries or shadowed entries are supplied to collecting systems during directory shadowing.
| Top |
Remove shadowing job logs (RMVJOBLOG)
Specifies whether to delete job logs created during previous directory shadow collections from a specific supplier system. More information about this parameter is in the SNA Distribution Services book, SC41-5410.
- *SAME
- The value does not change.
- *YES
- The job log created when the local system collected from a remote system is automatically deleted when the local system collects from that supplier system again.
- *NO
- The job log created when the local system collected data from a remote system is not automatically deleted.
| Top |
Allow search (ALWSCH)
Specifies whether to allow a search on the system distribution directory.
- *SAME
- The value does not change.
- *NO
- Search data is not created for the system distribution directory.
- *YES
- Search data is created for the system distribution directory. When this option is specified, the search file cannot be shared while the search data is being created. After the search data is created, all updates to the system distribution directory will update the search data. After this option is successfully run, the system distribution directory can be searched.
| Top |
User-defined fields (USRDFNFLD)
Specifies the user-defined field names, function, field type, and maximum field length on the user-defined field names. You can add, remove, or change user-defined field names in the system distribution directory for the system with this parameter.
If the specified user-defined field name exists on a supplier shadowing system, the data is automatically initialized on your system the next time you collect from that supplier system. After the initialization, any changes made to that field on other shadowing systems are updated on your system when it is shadowed. If there are user-defined fields on other shadowing systems that are not defined on your system, then these fields and their value are passed through to the other shadowing systems so the data is not lost.
If the user-defined field name does not exist on a supplier system but exists in the network, the user-defined field will not get initialized. To get the user-defined field initialized on your system, add it to the supplier system where the supplier system shadows data from a system with the user-defined field.
Up to 100 user-defined fields can be specified.
- *SAME
- The user-defined fields as specified on the system do not change.
The possible User-Defined-Field Name value is:
- field-name
- Specify up to 10 characters for the user-defined field name.
The possible User-Defined-Field Product ID values are:
- *NONE
- No user-defined field product ID is specified.
- product-ID
- Specify up to 7 characters for the user-defined field product ID.
The possible User-Defined-Field Function values are:
- *KEEP
- Indicates that the system should keep the user-defined field that is specified above.
- *ADD
- Indicates that the system should add the user-defined field that is specified above.
- *RMV
- Indicates that the system should remove the user-defined field that is specified above. This removes it from this system and not from the shadowing systems.
- *CHG
- Indicates that the system should change the user-defined field that is specified above. The maximum length value and the field type can be changed. The field name and product ID cannot be changed.
The possible Field Type values are:
Field type is required for function *ADD and optional for *CHG. It will be ignored for function *KEEP and *RMV.
- *DATA
- Indicates that the user-defined field contains data for the user.
- *MSFSRVLVL
- Indicates that the user-defined field contains a mail server framework service level value. By specifying this value, this user-defined field can be used to store information for a service level for the Mail Server Framework. Also, this type of field will be displayed in the list when F4 is pressed on the Add and Change Directory Entry panels for the 'Mail service level' field.
- *ADDRESS
- Indicates that the user-defined field contains an address. By specifying this field, it indicates that this field can be used as a preferred address by the user. Also, this type of field will be displayed in the list when F4 is pressed on the Add and Change Directory Entry panels for the 'Preferred address' field.
The possible User-Defined-Field Maximum length value is:
- maximum-length
- Specify between 1 and 512 bytes for the maximum length of the user-defined field. Maximum field length is required for function *ADD and optional for *CHG. It will be ignored for function *KEEP and *RMV.
| Top |
Examples
Example 1: Changing the Search Type to Generic
CHGSYSDIRA SCHTYPE(*GENERIC)
This command searches the Search System Directory display to find all matches that begin with the specified text string. For example, a search for Smith may result in Smith, Smithsonian and Smithton.
Example 2: Changing the Shadowing Retry Attributes
CHGSYSDIRA RTYITV(10) RTYLMT(3)
This command changes the attributes that control the available options when shadowing fails. The interval between failures is 10 minutes with a maximum of three retries for this example.
| Top |
Error messages
*ESCAPE Messages
- CPF898C
- *ALLOBJ special authority required to do requested operation.
- CPF90F7
- System directory attributes not changed.
| Top |