ZOMList

Lists information on selected objects.

Syntax

ZOMList <object specification> [<option>...]

Options

;k <keyword> [!]

Assigns a keyword to the selected object(s). If the keyword is already assigned, this assignment is ignored. If "!" is specified, the keyword assignment is removed for the object(s).

;p <property> [!]

Sets the specified user-designated property for the selected object(s). If "!" is indicated, the specified property is reset for the selected object(s).

;d <document name>

Specifies that the output is to be written to the indicated document. The document must be already created. If the ;d option is omitted, it indicates that the output is to be written to the screen.

;v

Sets the Verbose option. Additional object properties are reported.

;vi

Sets the Information Verbose option. Object dependency information is reported.

;vk

Sets the Keyword Verbose option. All keywords assigned to the selected objects are reported.

;sh

Lists the objects from the Shadow Object Dictionary, rather than the Object Dictionary.

;a

If a document name is specified, the ;a option indicates that the output is to be appended to the end of the document. If the ;a option is omitted, it indicates that the output is to replace the contents of the document specified in ;d option.

;b

If a document name is specified, the ;b option indicates that you would like to browse the document file after the action is completed. The ;b option does not take effect if the ;d option was not used to specify an output document.

;w

If a document name was not specified, the ;w option sets pause on while the information is being listed to the screen. The ;w option does not take effect if output is directed to a document using the ;d option.

Comments

This lists information about the objects specified.

Non-Verbose Option

If you do not use the verbose option (;v), ZOMList lists the object's name, type, owner name and directory, as shown in the following example:

ObjectName    ObjectType    Dir Name      OwnerName
Customers     EntitySet      zim
FilledBy      Relationship   zim
Supplier$SDB  Document       zim

Verbose Option

A verbose listing is produces by including the verbose option (;v). A sample listing is shown below:

ObjectName    ObjectType    DirName
Customers     EntitySet     ZIM           zim0100
             A CH DS D E l.l m N r s (1.1091)
 
FilledBy      Relationship  ZIM           zim0109
            A CH DS D E l.l m N r s (1.1756)
  
Supplier$SDB  Document      ZIM
           A ch ce D E l.l m N r s (1.1852)

The extra two lines of output per object provide information about the property settings of the object. The second line, shown in isolation below, lists these properties as abbreviations. If the property is set, then the abbreviation is shown in uppercase. If it is false, it is shown in lowercase.

The third line reveals several details about the object which can be useful when planning data distribution, as shown in the example below:

Zim0100 (1.1174)

The information shown includes:

<FileName>

This is the actual operating system file which maps onto the object. This is shown for EntitySets, relationships with fields, and directories. It is useful when constructing your areas.zim and dirs.zim files.

(#.#)

These are Zim internal numbers which uniquely identify the object. Normally, you do not use these numbers, but they are made available should the Zim technical support group need to know their values.

Verbose Information Option

The output from ZOMList using the "verbose information" option (;vi) for the object Customers is shown below. The information includes: the output from ZOMList with the verbose option set, the list of keywords associated with the object, a brief summary of the Object Dictionary information describing the object, a list of any fields which the object depends on, a list of any objects depended on, and a list of all objects which depend on it.

********************************************************

ObjectName    ObjectType    DirName
 
Customers     EntitySet     ZIM           zim0100
           A CH DS D E l.l m N r s (1.1091)
 
 
Keywords:
 
$Changed
$new
 
Object Dictionary Information:
 
30 FirstName  ZIM           alpha    20  0   no  no  no
35 LastName   ZIM           alpha    20  0   no  yes no
40 CC         ZIM           int       2  0   yes uni no
45 Salutation ZIM           alpha    10  0   no  no  no
 
Depends on objects:
Flag ObjectName   ObjectType    OwnerName     DirName
 
D ZIM             Directory                   ZIM
Is depended on by objects:
 
Flag ObjectName   ObjectType      OwnerName   DirName
 
I    Issue         Relationship                ZIM
I    ShippedTo     Relationship                ZIM
O    Custs         Role           Customers    ZIM
O    Customer$SSH  Set                         ZIM

Sample ZOMList ;vi Output

Examples

The following command lists the object "Customers" to the screen with pause mode on.

ZOMList Customers ;w

The following command puts the verbose listing for the objects keyworded by "Sales_System" in the document "ListRpt," and brings up the document browser on the report.

ZOMList +k Sales_System ;d ListRpt ;b ;v

The following command lists the information report for the object "Customers" to the screen with pause mode on.

ZOMList Customers ;vi ;w

The following command puts the information report for the objects keyworded by "Sales_System" in the document "InfoRpt," and brings up the document browser on the report.

ZOMList +k Sales_System ;vi ;d InfoRpt ;b

The following example lists all the keywords associated with all Form objects.

ZOMList +t Form ;vk