Category: Programs and Utilities

Lists information on selected objects.

Syntax

ZOMList object specification [option…]

Options

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    DirName      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:

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

Produces a statistical report on selected objects.

Syntax

ZOMStatistics object specification [option…]

Options

Comments

This service computes and reports statistics for all objects selected by the object selection criteria. A sample report is shown below:

ZOM Statistics Report

Object Existence Statistics

===========================

Existing  392

Corrupt 0

NotExisting 0

Defined 391

NotDefined  1

Neither  0

Object Type Statistics

======================

Directories  1

Entity Sets  9

Relationships  6

Roles:            15

Documents:        84

Forms:            57

Displays:         16

Windows:          29

Variables:        37

Constants:        133

Named Sets:       5

Operational Statistics

======================

Active:           392

NotActive:        0

Locked:           0

Directory Locked: 0

Not Locked:       392

Data Save:        12

No Data Save:     0

Not DataSaveAble: 380

Selected:         0

Not Selected:     392

Program Statistics

==================

Programs:         29

(ignore warnings): 0

Macros:            0

Docs Not Programs:55

Pgms with Errors: 0

Need Compile:     0

Need UnCompile:   0

Keyword Statistics

==================

Number of Keywords:       2

Number of objects in each keyword:

$changed:                 4

$new:                     392

Metric Statistics

=================

Program Metrics

Number of Pgms:          29

Total Lines of Code:     8291

Average Lines of Code:   285.9

Min Lines of Code:       9

Max Lines of Code:       806

Database Table Metrics

Number of Tbls:          12

Total Records:           397

Average Records:         33.1

Min Records:             1

Max Records:             142

Example

The following command puts the statistics report for the objects keyworded by “Sales_System” in the document “StatsRpt,” and brings up the document browser on the report.

ZOMStatistics +k Sales_System ;d StatsRpt ;b

The “w” option is used to wait between pages of output produced by a ZOM service.

For example, the following command lists information on all the objects named “Inventory” to the screen and waits for the user to press Enter after every page of output:

ZOMList Inventory ;w

Processing options are used to set object status properties and to modify the behavior of the service being invoked. Each ZOM service specifies the processing options that apply. For more information, see the Reference Guide. However, there are some processing options that apply generally to all ZOM services and these options are described in the following topics.

The “d” option is used to redirect the output of a ZOM service to a document. For example, the following lists information on all the objects named “Inventory” to the document ListOutputDoc:

ZOMList Inventory ;d ListOutputDoc

In this case, the contents of ListOutputDoc are overwritten. ListOutputDoc must be an existing document object.

If you want to append the output onto the end of the document, you would use the “a” option as well:

ZOMList Inventory ;d ListOutputDoc ;a

You can also use processing options to set and reset keywords for your objects. The option syntax is similar to the selection syntax for keywords. You specify the processing option “;k” followed by the keyword. For example, the following command assigns the keyword “Customer_Forms” to all Form objects with names starting with “fCust”:

ZOMSet fCust* ^t Form ;k Customer_Forms

You can remove a keyword assignment by using the exclamation point (!). For example,

ZOMSet +t Ent ;k Tables!

removes the “Tables” keyword from all EntitySet objects.

You can use processing options to set and reset any of the user-designated status properties. The option syntax is similar to the selection syntax for status properties. Specify the processing option ;p followed by the status property indicator. For example, the following command assigns the locked property to all Entity Set objects:

ZOMSet +t Ent ;p l

The ZOMSet service used here is useful in setting status properties. ZOMSet is a special service that has no inherent function of its own but selects the specified objects and obeys the processing options are provided. Contrast the example above with the following example

ZOMList +t Ent ;p l

that also assigns the locked property to all EntitySet objects, but then lists all of the selected objects.

You can reset a status property by using the exclamation point (!). For example

ZOMSet +t Ent ;p l!

removes the locked property from all EntitySet objects (i.e., makes the objects not locked).

Objects can be selected by a named set that contains a list of objects. This named set must be constructed using the ObjList EntitySet:

find all ObjList where ObjectName like ‘%Cust%’ -> sCust

In this example, all objects of the set “sCust” are selected:

ZOMList +s sCust

Objects can be selected by querying the data property using the selection criteria “da”. All data objects (i.e., EntitySet objects and relationships with field objects) are selected. For example, in the following command, all data objects are selected for use by the ZOMLIST service:

ZOMList +p da

In the next example, all objects that are not data objects are selected:

ZOMList +p da!

Objects can be selected by querying the selected property using the selection criteria “s”. All objects that are selected (i.e., have been assigned by the user as selected) are selected. In the following example, all objects that are considered selected by the user are selected:

ZOMList +p s

In the next example, all objects that are not selected are selected:

ZOMList +p s!