USMeta.Domains |
|
|
|
At runtime, gets metadata information about domains from the model developed in USoft Definer. For each retrieved domain, this information takes the form of name/value pairs. Each name/value pair expresses a domain attribute setting. Returns an XML document of the form demonstrated in Example 1 below. Syntax
All parameters are optional. Parameter values that you pass are mapped to parameters by alias name. The '.*ID.*' value in the following example is for domain-name-pattern because of the "Domains" alias:
(For backward compatibility only, it is possible to supply parameter values by position. Using this syntax, a list of non-aliased values maps to the parameter list in the order stated, with empty values at the end of the list if you supply less than 4 values, and '' (the empty string) as a way of explicitly declaring an empty value.) Domain-name-pattern is a regular expression that matches zero, one or more domain names in the model. The result data is limited to domains matching the pattern. If domain-name-pattern is omitted, then result data is not limited in this way. Type-pattern is a regular expression that matches zero, one or more data types of domains in the model. The result data is limited to domains with a data type matching the pattern. If type-pattern is omitted, then result data is not limited in this way. The following are valid data types in USoft:
If interfaces-only is set to 'yes', only columns that have Interface = Yes are included. The default of interfaces-only is 'no', meaning that domains are in scope regardless of the value of their Interface attribute. Module-pattern is a regular expression that matches zero, one or more module names in the model. The result data is limited to domains within modules matching the pattern. Any domains that are consumed from a different module which is filtered out by the regular expression, will show two additional fields 'INTERFACE_FROM_MODULE', which will be 'Y', and 'IMPLEMENTING_MODULE', which will contain the module name where the domain originates from. The 'MODULE_NAME' field will in this case contain the name of the module in which the interface was consumed. If module-pattern is omitted, then the result data is not limited in this way. Example 1 This example returns domain information about any domains in the model that have a name containing the letters 'ID', and a 'NUMBER' data type:
The return value of this statement could be:
See also |
|