Category: The ZIM Data Dictionary

ZIM’s Auxiliary Relationships are predefined relationships to associate Data Dictionary objects thus speeding Zim applications development.

The Predefined Relationships

Remarks

When a new Zim database is first created, the above auxiliary relationships are also automatically created to be used in Zim development.

Example

To find all fields belonging to the entity sets “Customers” and “Invoices”:

find Ents EntFields Fields where Ents.EntName in ("Customers", "Invoices") -> sMySet

Check whether there are any relationships with fields:

find Rels RelFields Fields
if $SetCount = 0
    out "No Relationships with Fields"
endif

A numeric code indicating the “class” (field or widget type) of the associated form field.

Valid Values

WdgType = {30 where FT = “0”, 31 where FT = “1”,

A numeric value ranging from 1 to the maximum available widgets according to the table below:

The callback events an object can raise.

Valid Values

An integer code combining the following values:

Remarks

Only resizable windows can have menus.

Example: If the object has to raise a GotFocus event and a Click event, the WdgCallbacks would contain (2 + 64) = 66.

Provides extra information about the object being used.

Valid Values

A character string, up to 512 characters long either blank or in JSON format.

Remarks

The WdgCSS values for the objects involved present either a blank value or a free-format JSON syntax containing additional information about the object. This extra information may be Data Dictionary fields valid only to the particular object or implemented for future use.

Example

{"icon": "c:/images/zx.ico", "smallincrement":30}

ZIM:X allows JSON data format to be retrieved by the means of the $FindJSON function if the above value would be stored in FFs.WdgCSS:

LIST FFs FORMAT $FindJSON(WdgCSS, "smallincrement")
30

See Also

$FindJSON

The “appearance” of an object.

Valid Values

An integer code combining the following values:

Remarks

Only resizable windows can have menus.

Example: If the window has a caption, is resizable and has a close button, the value would be (1 + 2 + 16384) = 16387.

Indicates whether an index is to be maintained on the field.

Valid Values

As shown in the table below:

Remarks

Index is ignored for fields that belong to documents.

A time stamp indicating when it was created

Remarks

A time stamp indicating when it was created

The name of the owner of the database table on the database server if the table is not owned by the user or included in his or her schema.

Remarks

The name of the owner of the database table on the database server

The name of the database table on the database server, if different than the EntitySet name. RemoteName is normally used when there is a naming incompatibility between Zim and the database server.

Remarks

The name of the database table on the database server

Whether this Document is defined to be per user.

Valid Values

“yes” or “no” (the default value is “no”).

Remarks

Normally, Documents are located in a place pointed by its FileName field. However, with DocPerUser set to “yes”, the corresponding document has the following behaviour:

. They are handled by the current session and their information is lost after the session finishes;

. They are located in the $WorkPath directory;

. They don’t exist at the beginning of the session and must explicitly be generated on the fly by the application.

Note: In previous versions of Zim, per user Documents were indicated by the “)” mark in the FileNome of the document. In Zim 8 and up, the DocPerUser field must be set to “yes” and the “)” mask must be there as well for compatibity issues. In future versions, this mark will be removed.