Information Catalog Manager Administration Guide

Starting the Information Catalog Manager from the command line

Use the DGUIDE command to open an information catalog from the MS-DOS command line. You can add parameters to the command to import or export a tag language file. Importing a tag language file from the command line and Exporting metadata from the information catalog describe the parameters that you can add to the DGUIDE command.

Importing a tag language file from the command line

Use the DGUIDE command to open an information catalog and import a tag language file from an MS-DOS command prompt. When you use the DGUIDE command, keep in mind the following rules for the command syntax:

• None of the parts, except where specified, are case sensitive.
• Each keyword must be preceded by either a slash (/) or hyphen (-) character.
• All keywords that follow /IMPORT as shown in Figure 70 are required if you choose to import.
• Underlined choices are defaults.

Figure 70. DGUIDE command parameters for opening an information catalog and importing metadata

DGUIDE /USERID userid /PASSWORD password /DGNAME dgname Optional keywords: /ADMIN /TRACE 0|1|2|3|4 /IMPORT filename /LOGFILE filename /RESTART B|C Optional import keyword: /ICOPATH iconpath

The following example shows the required parameters you specify to open the sample information catalog as an administrator.

DGUIDE /USERID longods /PASSWORD secret /DGNAME ICMSAMP /ADMIN

The following list shows the parameters you can add to the DGUIDE command. Optional and required keywords for importing a tag language file are noted.

/ADMIN

Specifies that you are logging on as an administrator. If you do not specify this optional keyword for the DGUIDE command, you are logged on as a user, and you cannot perform administrator tasks.

/DGNAME

Your information catalog name.

If the information catalog is local, give the database name. If the information catalog is remote, give the alias under which it was cataloged.

Example:

/DGNAME ICMSAMP

/ICOPATH

Valid only with /IMPORT; optional.

Indicates that you are importing icons and specifies the icon path that the import function will use. The Information Catalog Manager assumes that the path is the same as the one where you installed the Information Catalog Manager unless you specify a full drive and path. You must specify a fixed drive.

Example:

/ICOPATH d:\icons\

/IMPORT

Imports the tag language file you specify. Unless you specify the full drive, path, and file name, the Information Catalog Manager assumes that the file is in the path specified on the DGWPATH environment variable.

Example:

/IMPORT d:\tagfile.tag

This keyword bypasses the Information Catalog Manager user interface and performs the import function as a batch process.

/LOGFILE

Valid only with /IMPORT; required with /IMPORT.

Specifies the file destination for messages the Information Catalog Manager generates during import. Unless you specify a full drive, path, and file name, the Information Catalog Manager places the file in the path specified on the DGWPATH environment variable. You must specify a fixed drive.

Example:

/LOGFILE d:\tagfile.log

/PASSWORD

Your password for this user ID.

Example:

/PASSWORD secret

Passwords are case-sensitive for accessing databases on the following operating systems, you must type them exactly as specified.

• AIX
• Windows NT and Windows 2000
• Solaris Operating Environment

/RESTART

Valid only with /IMPORT; required with /IMPORT.

Indicates which option the import function uses. The valid options are:

B

Imports the tag language file from the beginning.

C

The default. Imports the tag language file from the last point at which the Information Catalog Manager successfully committed changes to the information catalog.

/TRACE

The level of trace information to send to the trace file. Each higher level includes the functions of the levels below it (3 includes the functions of levels 0, 1, 2, and 3). You might have to specify a higher level if you call IBM Software Support to diagnose Information Catalog Manager problems.

0

The default. Includes all messages and warning, error, and severe error conditions.

1

Includes entry and exit records of the highest level Information Catalog Manager functions.

2

Includes extremely granular entry and exit records of the Information Catalog Manager functions.

3

Includes input and output parameters (excluding input or output structure).

4

Includes all input or output structures that are passed to and used by the Information Catalog Manager.

/USERID

Your information catalog user ID. Depending on the database location of the information catalog you are opening, type the user ID required by the database. For example, the user ID might be your local, LAN, AS/400, AIX, or OS/390 TSO user ID.

Example:

/USERID longods

Exporting metadata from the information catalog

Use the DGUIDE command to export metadata into a tag language file which you can import into another information catalog.

When you use the DGUIDE command to export metadata, keep in mind the following rules for command syntax:

• None of the parts, except where specified, are case sensitive.
• Each keyword must be preceded by either a slash (/) or hyphen (-) character.
• All keywords that follow /EXPORT as shown in Figure 71 are required.
• Underlined choices are defaults.

Figure 71. DGUIDE command parameters for exporting metadata

DGUIDE /DGNAME ic_name /USERID userid /PASSWORD password /ADMIN /EXPORT filename /LOGFILE filename /OBJTYPE object_type /OBJECTS name Optional keywords: /ADMIN /A /C /L /T

/ADMIN

Specifies that you are logging on as an information catalog administrator. If you do not specify this optional keyword for the DGUIDE command, you log on as a user. You can export metadata as a user if your information catalog administrator has given you authority; however, you cannot perform all administrator tasks.

This keyword is optional.

/A

Specifies that you want to export all comments associated with an exported object.

This keyword is optional.

/C

Specifies that you want to export all objects that are contained in an exported object.

This keywords is optional.

/DGNAME

The name of the information catalog from which you want to export.

If the information catalog is local, give the database name. If the information catalog is remote, give the alias under which it was cataloged.

Example:

/DGNAME ICMSAMP

/EXPORT

Exports objects to the tag language file you specify. Unless you specify the full drive, path, and file name, the Information Catalog Manager assumes that the file is in the path specified on the DGWPATH environment variable.

Example:

/EXPORT d:\tagfile.tag

/L

Specifies that you want to export all objects that have a linked relationship with an exported object.

This keyword is optional.

/LOGFILE

Specifies the file destination for messages the Information Catalog Manager generates during the export process. Unless you specify a full drive, path, and file name, the Information Catalog Manager places the file in the path specified on the DGWPATH environment variable. You must specify a fixed drive.

Example:

/LOGFILE d:\tagfile.log

/OBJECTS

Specifies the universal unique identifier (UUI) for each object you want to export. You can specify up to five UUI values separated by periods and enclosed in quotation marks.

Example:

/OBJECTS "DWCTARGET.DWCADMIN.CUSTOMER"

/OBJTYPE

Specifies the DP NAME (short name) of the object that you want to export.

Example:

/OBJTYPE TABLES

/PASSWORD

Your password for this user ID.

Example:

/PASSWORD secret

Passwords are case-sensitive for accessing databases on the following operating systems, you must type them exactly as specified.

• AIX
• Windows NT and Windows 2000
• Solaris Operating Environment

/T

Specifies that you want to export all contacts that are associated with an exported object.

This keyword is optional.

/USERID

Your information catalog user ID. Depending on the database location of the information catalog you are opening, type the user ID required by the database. For example, the user ID might be your local, LAN, AS/400, AIX, or OS/390^(R) TSO user ID.

Example:

/USERID hchan

In the following example, the administrator hchan exports a relational table object with a UUI of DBNAME(DWCTARGET) OWNER(DWCADMIN) TABLES(CUSTOMER) from the ICMSAMP information catalog. The table object and all columns associated with the object will be exported as well as all contact objects and objects that have linked relationships with the table object. The metadata for the exported objects will be written to a file called x:\mypath\tagfile.tag.

DGUIDE /DGNAME ICMSAMP /USERID hchan /PASSWORD mypass /ADMIN /EXPORT
x:\mypath\tagfile.tag /LOGFILE x:\mypath\tagfile.log 
/OBJTYPE TABLES /OBJECTS "DWCTARGET.DWCADMIN.CUSTOMER" /c /t /l