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 selected object(s).
;p <property> [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
Comments
This service has no special function of its own. ZOMSet selects the specified objects and sets any properties according to the given processing options. ZOMSet is convenient for setting object properties without doing any further processing on those objects.
Examples
The following command sets the object “Customers” to be locked.
ZOMSet Customers ;p l
The following command sets all objects that are compiled to be compilable.
ZOMSet +p ca ;p c
The following command sets the DataSave property for all objects that have the Data property set.
ZOMSet +p da ;p ds
The following example deletes the keyword “Sales_System” from all objects keyworded by the keyword “Sales_System.”
Imports dictionary descriptions of objects from documents.
Syntax
ZOMImport [<option>…]
Options
;f <format>
Specifies the format in which that the Object Dictionary specifications are to be imported. There are several available formats:
Z50
To import Z50 format, omit the ;f option. This is the default import / export format, and is recommended for exchanging definitions between ZOM enabled environments. Z50 files have file names that end in “.z50”.
Z45
This format is suitable for importing definitions created using ZOM Version 4.5 which was released with the Developers’ Release, 4.5, of Zim for Windows. It can be used to import definitions created by this previous Windows release. Z45 files have file names that end in “.z45”.
Z41
This imports definitions exported by versions of ZOM prior to 4.5. Z41 files have file names that end in “.z41”.
DT4
This imports definitions compatible with ZimSAVE and ZimLOAD. It is useful for exchanging objects between ZOM and older versions of Zim. DT4 files have file names that end in “.dt4”.
OEF
This imports output which is compatible with the Object Exchange Format, a generic object exchange format definition which is designed for integration with other development tools. OEF files have file names that end in “.oef”.
;t sh
Specifies that the target of the import operation is the Shadow Object Dictionary and not the Object Dictionary. See ZOMDiff for more information on comparing different versions of object definitions.
Comments
This command checks the set of objects to be imported over for locked objects prior to executing. If there are locked objects to be affected, the command issues an error and exits. An object is considered to be locked if it is locked itself, or is in a locked directory. For information about setting and clearing locks, refer to ZOMSet.
This command touches any objects imported once its action has completed. This results in the object’s status and dependency information being updated. For more information, refer to ZOMTouch.
Examples
The following command imports the objects contained in the Z50 format files.
ZOMImport
The following command imports the objects in DT4 format.
Generates a program to create all selected objects.
Syntax
ZOMCrtBoot object specification [option…]
Options
;k [!]
The ;k option is used to assign 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 [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
;d
This 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.
;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 command generates a program consisting of create statements for the selected objects. It is used to generate system bootstrap scripts. The scripts generated preserves the file numbers of directories, entity sets, and relationships with fields. As well, code is generated to make a copy of the object’s file immediately after it is created.If a given set of objects has a complex dependency hierarchy, it can be very difficult to determine the correct order in which to create the objects. If all the objects are properly created and Dependency Tracking is enabled, this command generates the create statements in the correct order.
Examples
The following command generates a program which, when executed, creates the object “Customers.” The output is written to the screen.
ZOMCrtBoot Customers
The following command appends the same program out to the document BuildCusts.
Generates a program to import dictionary information of selected objects into the Object Dictionary.
Syntax
ZOMDDBoot object specification [option…]
Options
;k [!]
The ;k option is used to assign 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 [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
;d
This 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.
;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 generates a program consisting of statements which construct the Object Dictionary description for the objects indicated. It is used to generate system bootstrap scripts. It is not as efficient as using ZOMExport ZOMImport
Examples
The following command generates a program which, when executed, populates the Object Dictionary with the description of the object “Customers.” The output is written to the screen.
ZOMDDBoot Customers
The following command writes the same program out to the document BuildCusts.
Deletes the Object Dictionary information for selected objects (but does not erase the object or object description).
Syntax
ZOMDelete object specification [option...]
Options
;k [!]
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 selected object(s).
;p [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
Comments
ZOMDelete deletes the Object Dictionary definitions for the objects specified in the object list specification.It is important to differentiate between erasing an object, deleting an object, and destroying an object. Erasing an object undoes the act of creating an object. Creation takes a Object Dictionary description and uses it as the basis for constructing a system representation of the object in the indicated directory. Thereafter, the object can be used. Erasing an object erases this system representation, but still leaves the Object Dictionary description intact. Deleting an object deletes the object’s description from the Object Dictionary, but leaves its system representation intact. Destroying executes both an erase and a deletion, as well as deleting the registration information from the Object Dictionary. An object can be erased and deleted without being destroyed, if the ZOMErase and ZOMDelete functions are executed separately.This command checks the set of objects to be processed for locked objects prior to executing. If there are locked objects to be processed, the command issues an error and exits. An object is considered to be locked if it is locked itself, or is in a locked directory. For information about setting and clearing locks, refer to ZOMSet.This command touches the objects deleted once its action has completed. This results in the object’s status and dependency information being updated. For more information, refer to ZOMTouch.This action results in the objects affected being keyworded as “changed.” The exact keyword used is determined by ZOM’s configuration. For more information, refer to ZOMConfig.
Examples
The following command deletes the object named “Customers.” Its description in the Object Dictionary is deleted, but it is not erased.
ZOMDelete Customers
The following command deletes the objects keyworded by the keyword “To_Delete.”
Erases selected objects and deletes their dictionary and object descriptions.
Syntax
ZOMDestroy object specification [option..]
Options
;1 NOERASE
This option indicates that destroy is to not erase the object. This is especially useful in the case of predefined objects that are described in the Object Dictionary (e.g., ZimPROF, printer). You might want to remove the descriptions of these predefined objects but not erase the objects themselves.
Comments
The ZOMDestroy command deletes both Object Dictionary definitions and erases the created objects for the objects specified in the object list specification. All references to the object in the data dictionary are deleted. The object is not destroyed at the operating system level.
It is important to differentiate between erasing an object, deleting an object, and destroying an object. Erasing an object undoes the act of creating an object. Creation takes an Object Dictionary description and uses it as the basis for constructing a system representation of the object in the indicated directory. Thereafter, the object can be used. Erasing an object erases this system representation, but still leaves the Object Dictionary description intact. Deleting an object deletes the object’s description from the Object Dictionary, but leaves its system representation intact. Destroying executes both an erase and a deletion, as well as deleting the registration information from the Object Dictionary. An object can be erased and deleted without being destroyed if the ZOMErase and ZOMDelete functions are executed separately.
This command checks the set of objects to be processed for locked objects prior to executing. If there are locked objects to be processed, the command issues an error and exits. An object is considered to be locked if it is locked itself, or is in a locked directory. For information about setting and clearing locks, refer to ZOMSet.
This operation can potentially affect the status of programs and objects which depend on the destroyed objects. If ZOM is configured with its Explode Level to be 1, then this command finds the dependent objects and touches them. Refer to ZOMConfig and the discussion of dependencies in Object Dependencies.
Examples
The following command destroys the object named “Customers.” Its description in the Object Dictionary is deleted, it is erased, and its registration in ZOM is deleted.
ZOMDestroy Customers
The following command destroys the objects keyworded by the keyword “$ziminit” with the NOERASE option active. This causes the Object Dictionary information and registration to be deleted, but the objects are not erased from the environment.
Exports the dictionary descriptions of selected objects to documents.
Syntax
ZOMExport object specification [option…]
Options
;k [!]
The ;k option is used to assign 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 selected object(s).
;p [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
;f
The ;f option specifies the format that the Object Dictionary specifications are to be exported in. There are several available formats:
Z50
To export in Z50 format, omit the ;f option. This is the default import/export format, and is recommended for exchanging definitions between ZOM enabled environments. File names for Z50 files end in “.z50”.
Z41
This produces output compatible with ZOM export/import files created by versions of ZOM prior to Version 5.0. This format is useful for exporting definitions into Zim environments where earlier versions are in use. File names for Z41 files end in “.z41”.
DT4
This produces output compatible with ZimSAVE and ZimLOAD. It is useful for exchanging objects between ZOM and older versions of Zim. File names for DT4 files end in “.dt4”.
OEF
This produces output compatible with the Object Exchange Format, a generic object exchange format definition designed for integration with other development tools. File names for OEF files end in “.oef”.
;a
Normally ZOMExport clears the Shadow Dictionary before adding the objects selected from the Object Dictionary. The ;a option forces ZOMExport to skip clearing the Shadow Dictionary so that the selected objects are appended to those already in the shadow.
;t sh
Export the objects from the Shadow Object Dictionary, rather than the Object Dictionary.
Comments
ZOMExport starts by clearing the Shadow Dictionary unless the ;a option has been specified. It then selects objects (using
Examples
The following command exports the object named “Customers.” It is exported in Z50 format.
ZOMExport Customers
The following command exports the objects keyworded by the keyword “To_Export.” The objects are exported in DT4 format.
Erases selected objects (but does not delete any dictionary or object descriptions).
Syntax
ZOMErase object specification [option…]
Options
;k [!]
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 selected object(s).
;p [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
Comments
This erases the actual Zim objects specified, but not delete the object’s definitions in the application dictionary.It is important to differentiate among erasing an object, deleting an object, and destroying an object. Erasing an object undoes the act of creating an object. Creation takes a Object Dictionary description and uses it as the basis for constructing a system representation of the object in the indicated directory. Thereafter, the object can be used. Erasing an object erases this system representation, but still leaves the Object Dictionary description intact. Deleting an object deletes the object’s description from the Object Dictionary, but leaves its system representation intact. Destroying executes both an erase and a deletion, as well as deleting the registration information from the Object Dictionary. An object can be erased and deleted without being destroyed, if the ZOMErase and ZOMDelete functions are executed separately.This command checks the set of objects to be processed for locked objects prior to executing. If there are locked objects to be processed, the command issues an error and exits. An object is considered to be locked if it is locked itself, or is in a locked directory. For information about setting and clearing locks, refer to ZOMSet.This command touches the objects erased once its action has completed. This results in the object’s status and dependency information being updated. This operation can also potentially affect the status of programs and objects which depend on the erased objects. If ZOM is configured with its Explode Level to be 1, then this command finds the dependent objects and touches them. For more information, refer to ZOMTouch and the discussion of dependencies in Object Dependencies.This action results in the objects affected being keyworded as “changed.” The exact keyword used is determined by ZOM’s configuration. For more information, refer to ZOMConfig.
Examples
The following command erases the object named “Customers.” It is erased from the database environment, but its description in the Object Dictionary is retained.
ZOMErase Customers
The following command erases the objects keyworded by the keyword “To_Erase.”
The ;k option is used to assign 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 [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
;d
This 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.
;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.
;q
The name of a query program created using the DPSMakeQuery command.
Comments
ZOMExec executes the specified query for each of the objects selected. The query must be created using the DPSMakeQuery command. Information on the current object being processed by ZOMExec is provided to the query program in a collection of pre-defined variables:
vObjectName
The name of the object.
vObjectDirName
The name of the Zim directory containing the object.
vObjectOwnerName
The name of the owning object.
vObjectKey
The object’s unique identifier key.
vObjectType
The type of the object.
vObjectActive
The active property; “Y” indicates active.
vObjectLocked
The locked property; “Y” indicates locked; “D” indicates the Zim directory is locked.
Example
The following command executes the query “Change_Colors” for each object of type Form.
The ;k option is used to assign 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 [!]
Set the specified user-designated property for the selected object(s). If “!” is indicated, the specified property is reset for the selected object(s).
;d
This is the name of the document (which must already exist) from which data is loaded. This document should have been previously specified as the ;d option in a ZOMDataSave command for the same object.If you specify a specific document, it is recommended that you execute the data load against one object, since the document is defined to save data from a single specific object.If you do not specify a document name, ZOMDataLoad uses the internal data save document name associated with each object.
;r
This service generates a program that executes the data load function. This program is normally put in a temporary document. By specifying the name of the document to be used to store the program, ZOMDataLoad reroutes the program code to this document instead.
;q
This option causes ZOMDataLoad to skip actually loading the data. The programs to load data are created.
Comments
This program can be used to restore temporarily saved data into the object. The data usually comes from the internal ZOM document associated with each object that contains data. If, however, a ZOMDataSave was done where the data was saved into a named document, then that data can be loaded by specifying the document name with the ;d option.The ;r option can be used to also generate a program that actually carries out the load operation. This program could be incorporated directly into your application where it may be necessary to load data into an object.The data which ZOMDataLoad can retrieve must be created using ZOMDataSave.
Examples
The following command loads the contents of the EntitySet “Customers” from the datasave document associated with the Customers object.
ZOMDataLoad Customers
The following command loads the contents of the EntitySet “Customers” from the document “dsCusts.” The program that executes the data load is generated into the document “pCustDataLoad.”
ZOMDataLoad Customers ;d dsCusts ;r pCustDataLoad
As long as the definition of Customers does not change, subsequent data loads can be accomplished by executing the generated program, as shown below. This program can be compiled and embedded in your shipping applications.
pCustDataLoad()
The following command loads the data in all objects with the DataSave property set (i.e., EntitySets and relationships with fields). The data in these objects must have been previously saved using ZOMDataSave.
English 
Portuguese