Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Add Distribution Catalog Entry (ADDDSTCLGE) command is used to add an entry to the distribution catalog. A data object can optionally be loaded into the distribution repository from an iSeries library, folder, or from any of the integrated file systems.
The distribution catalog contains a list of objects that are eligible for distribution. Each catalog entry is identified by a network-wide unique name called a global name. Each catalog entry describes where the object to be distributed is located for retrieval or can be stored when received.
The catalog entry consists of the global name of the object, the name of the object's storage location (if the object exists), and attributes of the object. The data object associated with the global name can be stored as a standard iSeries object in a library, folder, stream file, or distribution repository.
Notes:
Top |
Keyword | Description | Choices | Notes |
---|---|---|---|
GLBNAME | Global name | Element list | Required, Positional 1 |
Element 1: Global name token 1 | Character value, *NETID, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 2: Global name token 2 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 3: Global name token 3 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 4: Global name token 4 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 5: Global name token 5 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 6: Global name token 6 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 7: Global name token 7 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 8: Global name token 8 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 9: Global name token 9 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
Element 10: Global name token 10 | Character value, *NETID, *CPNAME, *DATE, *TIME, *MDDATE, *MDTIME, *SERVER, *TARGET | ||
OBJTYPE | Object type | Character value | Required, Positional 2 |
OBJ | Object | Single values: *NONE Other values: Qualified object name |
Optional, Positional 3 |
Qualifier 1: Object | Name | ||
Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
MBR | Member | Name, *ALL, *FIRST | Optional, Positional 4 |
DATATYPE | Data type | *UNSPEC, *CL, *REXX | Optional, Positional 5 |
DLO | Document library object | Character value, *NONE | Optional, Positional 6 |
FLR | Folder | Character value, *NONE | Optional, Positional 7 |
STMF | Stream file | Path name, *NONE | Optional, Positional 8 |
STGLOC | Local storage location | *STD, *DSTRPS | Optional |
TGTRLS | Target release | *CURRENT, *PRV, V5R2M0, V5R3M0, V5R4M0 | Optional |
DTACPR | Data compression | *NONE, *SNA | Optional |
SNACPRCHR | Compression character | X'00'-X'FF', *BLANK | Optional |
AUTL | Authorization list | Name, QCQRPSAUTL | Optional |
DTAACCKEY | Data access key | Character value, *NONE | Optional |
TEXT | Catalog entry text | Character value, *OBJTEXT, *BLANK | Optional |
VERSIONATR | Version attributes | Element list | Optional |
Element 1: Global name token 1 | *UNSPEC | ||
Element 2: Global name token 2 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 3: Global name token 3 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 4: Global name token 4 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 5: Global name token 5 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 6: Global name token 6 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 7: Global name token 7 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 8: Global name token 8 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 9: Global name token 9 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
Element 10: Global name token 10 | *UNSPEC, *NETID, *CPNAME, *ORDCHAR, *ORDDATE, *ORDDEC, *ORDTIME, *STI, *SYSTYPE | ||
MATCHATR | Match attributes | Element list | Optional |
Element 1: Global name token 1 | *MATCH | ||
Element 2: Global name token 2 | *NOMATCH, *MATCH | ||
Element 3: Global name token 3 | *NOMATCH, *MATCH | ||
Element 4: Global name token 4 | *NOMATCH, *MATCH | ||
Element 5: Global name token 5 | *NOMATCH, *MATCH | ||
Element 6: Global name token 6 | *NOMATCH, *MATCH | ||
Element 7: Global name token 7 | *NOMATCH, *MATCH | ||
Element 8: Global name token 8 | *NOMATCH, *MATCH | ||
Element 9: Global name token 9 | *NOMATCH, *MATCH | ||
Element 10: Global name token 10 | *NOMATCH, *MATCH |
Top |
Specifies the token values of the global name. The global name is the name by which the object is known in a system network architecture (SNA) network. The global name can be a maximum of 65-n characters in length, where n is the number of tokens. A maximum of 10 tokens can be specified and each token can be a maximum of 16 characters in length.
Valid tokens consist of uppercase letters A-Z and numbers 0-9. The special characters #, $, or @ are valid only when VERSIONATR(*CPNAME) is specified. In multilingual networks, language translation may make the value not valid when the special characters are used. Use of these characters is not recommended.
Notes:
This is a required parameter.
The possible token 1 values are:
The possible subsequent token values are:
Top |
Specifies the type of object used.
This is a required parameter.
Top |
Specifies the qualified name of the object to be used when adding the catalog entry.
The possible single value is:
The name of the object can be qualified by one of the following library values:
The possible object name value is:
Top |
Specifies the file member to be used when OBJTYPE(*FILEDATA), OBJTYPE(*FILE), or OBJTYPE(*LICKEY) is specified.
Top |
Specifies the type of data contained in a member that is handled as data only, without attributes. This parameter is only valid when OBJTYPE(*FILEDATA) is specified.
Top |
Specifies the document library object name being cataloged. This parameter is required when OBJTYPE(*DOC) is specified.
Top |
Specifies the folder name in which the document specified on the DLO parameter is located. This parameter is required when OBJTYPE(*DOC) or OBJTYPE(*FLR) is specified.
Top |
Specifies the stream file to be cataloged. This parameter is required when OBJTYPE(*STMF) is specified.
Top |
Specifies the storage location of the data object to which the global name points.
Top |
Specifies the release of the operating system on which you intend to use the object. This parameter is ignored when OBJTYPE(*FILEDATA), OBJTYPE(*PRODUCT), OBJTYPE(*LICKEY), OBJTYPE(*STMF), OR OBJTYPE(*INSOBJ) is specified, or the object is a save file.
Valid values depend on the current version, release, and modification level, and they change with each new release.
Top |
Specifies the compression method used to load a member into the distribution repository.
Top |
Specifies the prime compression character used by the SNA compression algorithm when DTACPR(*SNA) is specified. Valid values range from hexadecimal '00'X through 'FF'X. This parameter is ignored when DTCPR(*NONE) is specified.
Top |
Specifies the name of the authorization list of the repository object. This parameter is required when STGLOC(*DSTRPS) is specified.
Top |
Specifies the data access key (DAK) associated with the file. If this value is specified, the data access key name must exist in the access key table. This access key protects the catalog entry when used in the change control server/client environment.
Top |
Specifies the text description of the catalog entry.
Note: When cataloging a stream file and *OBJTEXT is used for the text parameter, the catalog entry description for the stream file being cataloged is generated with the text Catalog entry for a stream file.
Top |
Specifies the version attributes of the tokens in the global name. The attributes identify the kind of token.
The possible value for token 1 is:
The possible values for tokens 2-10 are:
The tokens with the following attributes may be used in partial matching:
Top |
Specifies whether each token in the global name must match the corresponding token on the global name in the request when partial global name matching is done.
The possible value for token 1 is:
The possible values for tokens 2-10 are:
Top |
Example 1: Adding a Catalog Entry for a File
ADDDSTCLGE GLBNAME(ENTID FINANCE PAYROLL DEDUCT) OBJTYPE(*FILE) OBJ(*LIBL/PAYDED) STGLOC(*STD)
This command adds a catalog entry for the payroll deductions file. All requests received referring to global name ENTID FINANCE PAYROLL DEDUCT are performed on the file PAYDED.
Example 2: Loading a File into the Repository for Filedata
ADDDSTCLGE GLBNAME(ENTID INVENTORY *DATE) OBJTYPE(*FILEDATA) OBJ(APPLZ/CURINV) MBR(*FIRST) STGLOC(*DSTRPS) DTACPR(*SNA) AUTL(MYLIST) VERSIONATR(*UNSPEC *ORDCHAR *ORDDATE) MATCHATR(*MATCH *NOMATCH *NOMATCH)
This command loads the current inventory file APPLZ in library CURINV into the distribution repository in compressed form. The file in the distribution repository can be referred to by the global name ENTID INVENTORY Y1993M09D15. The file is secured by authorization list MYLIST.
Example 3: Loading a Document into the Repository for a Document
ADDDSTCLGE GLBNAME(ENTID NYPS1 SALESRPT) OBJTYPE(*DOC) DLO(STATUS) FLR(NY/SALES.RPT/APRIL) STGLOC(*DSTRPS)
This command loads document STATUS in folder path NY/SALES.RPT/APRIL into the distribution repository.
Example 4: Adding a Distribution Catalog Entry into the Repository for a Product
ADDDSTCLGE GLBNAME(I3IBM1 AS400 ACCOUNT V1R1M0 BASE ALL 2924 REF 001 V5R2M0) OBJTYPE(*PRODUCT) OBJ(ACCLIB/ACCPKG) STGLOC(*DSTRPS) VERSIONATR(*UNSPEC *ORDCHAR *ORDCHAR *ORDCHAR *ORDCHAR *ORDCHAR *ORDCHAR *STI *ORDDEC *ORDCHAR) MATCHATR(*MATCH *NOMATCH *NOMATCH *NOMATCH *NOMATCH *NOMATCH *NOMATCH *NOMATCH *MATCH *NOMATCH *NOMATCH) TEXT('Accounting Base Product V1R1M0')
This command adds an entry to the Distribution Catalog and points to a product stored in the distribution repository.
Example 5: Adding an Entry into the Distribution Catalog for a Product
ADDDSTCLGE GLBNAME(I3IBM1 AS400 DISTSYS V1R2M0 BASE ALL 2924 REF 001 V5R2M0) OBJTYPE(*PRODUCT) OBJ(DSTSYSLIB/DSTLP) STGLOC(*STD) VERSIONATR(*UNSPEC *ORDCHAR *ORDCHAR *ORDCHAR *ORDCHAR *ORDCHAR *ORDCHAR *STI *ORDDEC *ORDCHAR) MATCHATR(*MATCH *NOMATCH *NOMATCH *NOMATCH *NOMATCH *NOMATCH *NOMATCH *MATCH *NOMATCH *NOMATCH) TEXT('Distribution System Base Product V1R2M0')
This command adds an entry for a product to the distribution catalog and points to the save file DSTLP in the library DSTSYSLIB.
Example 6: Adding a Distribution Catalog Entry for License File Pointing to Distribution Repository
ADDDSTCLGE GLBNAME(COMPANY1 ACCOUNT LICENSES) OBJTYPE(*LICKEY) OBJ(ACCNTLIB/ACCLICF) MBR(*FIRST) STGLOC(*DSTRPS) TEXT('License file for ACCOUNT product')
This command adds a distribution catalog entry that is stored in the distribution repository. The license file was previously generated running the DSPLICKEY command to obtain the existing licenses keys for the product ACCOUNT from the license repository.
Example 7: Adding a Distribution Catalog Entry for License File Pointing to i5/OS Standard Location
ADDDSTCLGE GLBNAME(COMPANY2 PURCHASE V3 LICKEYS) OBJTYPE(*LICKEY) OBJ(PURCHLIB/PURCHLICF) STGLOC(*STD) MBR(V3LIC)
This command adds an entry in the distribution catalog pointing to the PURCHLIB/PURCHLICF in i5/OS standard location. The license file can or cannot exist at this time.
Example 8: Adding a Distribution Catalog Entry for Stream File
ADDDSTCLGE GLBNAME(STREAM FILE CATALOG EXAMPLE) OBJTYPE(*STMF) STMF('/Dir1/Dir2/Dir3/UsrFile') STGLOC(*DSTRPS) TEXT('User file cataloged as stream file')
This command adds a distribution catalog entry to the repository that points to a stream file that is to be loaded in the distribution repository.
Example 9: Adding a Distribution Catalog Entry for Stream File with Symbolic Link
ADDDSTCLGE GLBNAME(STREAM FILE WITH SYMBOLIC LINKS CATALOG EXAMPLE) OBJTYPE(*STMF) STMF('FileLink') STGLOC(*DSTRPS) TEXT('Catalog a stream file using symbolic links')
This command adds a distribution catalog entry that points to a stream file stored in the distribution repository. However, in this example, the stream file is referred with a symbolic link. An assumption made in this example is that the current directory contains the following symbolic link:
FileLink = /SomeDirectory/SomeFile
For information about symbolic links, see the Integrated File System Introduction topic in the Information Center.
Example 10: Adding a Distribution Catalog Entry for a Stream File using *MDDATE and *MDTIME on a remote change control server.
These tokens are useful when you catalog files that are distributed regularly, such a transaction logs or sales data. For example, if you want to retrieve a transaction log from the remote change control client (remote target) on a daily basis, you can catalog it on the remote change control server where the remote change control client is attached to with a global name such as:
ADDDSTCLGE GLBNAME(EURO TRANSACT LOG *MDDATE *MDTIME) OBJTYPE(*STMF) OBJ('/transact/logfile') STGLOC(*STD) VERSIONATR(*UNSPEC *ORDCHAR *ORDCHAR *ORDDATE *ORDTIME) TEXT('Transaction log file')
When displaying the catalog entry it will appear as:
EURO.TRANSACT.LOG.&DATE.&TIME
To retrieve the file, you can add the next change request activity in the local system:
ADDCRQA CRQD(QGPL/CRQDRTV) ACTIVITY(ACT01) ACTION(*RTV) GLBNAME(EURO TRANSACT LOG *MDDATE *MDTIME) CPNAME(RMTSRV RMTCLT)
When the change request is submitted in the local system, the remote change control client returns the global name with the *MDDATE and *MDTIME tokens expanded to the actual date and time the file was last modified. For example, if the local file was last modified on 27 February 2001 at 15:40:00, the global name returned from the change control client is:
EURO.TRANSACT.LOG.Y2001M02D27.H15M40S00
The local system (the one to which you retrieved the file) catalogs the file under this name. This way, you can retrieve the same file every day, and each copy is cataloged under a different name. You can see the date and time of the file easily from the catalog entry.
Example 11: Adding a Distribution Catalog Entry for a Stream File using *SERVER and *TARGET tokens.
These tokens are used so that one catalog entry can be used for a file on multiple change control clients (targets). The following catalog entry is added in the change control server named "FREDSWS FREDSWS":
ADDDSTCLGE GLBNAME(EURO SALES FILE *SERVER *TARGET) OBJTYPE(*STMF) STMF('/targetdir/sales/sales.file') STGLOC(*STD) TEXT('Clients sale file')
The change control server "FREDSWS FREDSWS" has two change control client (targets) attached: the change control client "FREDSWS ROSE" and "FREDSWS NORA", and the file '/targetdir/sales/sales.file' exists on both targets.
If a user at another SNA distribution services node retrieved the sales files for all the targets attached to the change control server FREDSWS by requesting the global name EURO SALES FILE *SERVER *TARGET, that user would receive the global names EURO SALES FILE FREDSWS ROSE and EURO SALES FILE FREDSWS NORA
If a user at another SNA distribution services node retrieved it from the change control server "FREDSWS FREDSWS", he would receive the global name EURO SALES FILE FREDSWS FREDSWS. Also, sending the file pointed by EURO SALES FILE *SERVER *TARGET to a focal point from the i5/OS change control server "FREDSWS FREDSWS" would result in catalog entry EURO SALES FILE FREDSWS FREDSWS sent.
Top |
*ESCAPE Messages
Top |