Select remote instances
Query instances of one specified entity type and display the result in a table format. There will be one row for each instance and one column for each attribute in the result table. The EDMinstanceBrowser can be activated by clicking on a table cell that contain an instanceID or an aggregateID. The result table can be sorted according to a column by clicking on the column head frame.
Optionally all subtype instances of the specified type can be queried as well.
The condition argument to this command can be any legal Express-X logical expression, including function calls. The condition should be written in "symbolic Express-X syntax".
Any number of tables (result of this command) can be active on the screen simultaneously. The actual available virtual memory is the only limitation factor for the number of simultaneously active tables.
Optionally the result table can be written to a file in various specified formats instead of a table displayed on the screen.
Arguments:
Server context name: |
Specify name of server context. |
Remote repository: |
Specify the name of the open remote repository that holds the actual instances. Repository names are case sensitive. |
Remote model: |
Specify the name of the remote model that holds the instances to select. Model names are case sensitive. |
Entity: |
Specify the name of the entity, i.e. the type of the instance to select. Entity names are case insensitive. |
Attributes: |
Specify the names of the attributes that will be the columns in the resulting table. In case of more attributes in this argument, the attribute names should be separated with the space or the comma character. The number and the order of the columns in the result table will be according to the number and order of the attributes in this argument. Attribute names are case insensitive. |
Order by attribute: |
Specify the name of the attribute to order the selection by. |
Filter (entity names): |
Specify the name of the entity, i.e. the type of the instance to select. Entity names are case insensitive. |
First instance index to check: |
Specify an integer value denoting the index, i.e., element number in the entity extent aggregate that holds all instances of the same type in a model. The value of the <First instance index to check> argument specifies the index of the first instance to be queried. The instance type is specified by the <Entity> argument. The first instance in the entity extent aggregate has index zero. |
Condition: |
Specify the condition the actual instance should match. The <Condition> argument can be any legal Express-X logical expression, including function calls. The <Condition> should be written in "symbolic Express-X syntax". |
Max number of hits: |
Specify the maximum number of instances that matches the condition specified in the argument <Condition>. This argument restricts the number of instanceID to be returned. This argument can be set with the string value all – i.e. to return all instanceID matching the query. |
Remote XML configuration: |
The name of the XML configuration to apply to the resulting XML formatted query result when the option [xml format] is used. |
Output file: |
Specify the name of an optional output file that will receive the result table. |
Options:
accumulating command output: |
A global option that appends the command output to the EDMsupervisor output window. Otherwise the output window is refreshed and only the last command output is displayed. |
match selected input: |
A global option that specifies that only items that partly or exactly matches the string in the related argument input field when activating a Select button, will be in the selection list. An empty (blank) string will match all items. |
update indexes: |
A global option that specifies that the <First instance to check> argument will be updated to the next index after the one currently displayed. |
subtypes: |
Specifies that all instances in the actual model that is a subtype of the specified instance type in the <Entity> argument will be queried. |
include filter: |
Only the subtypes of the entity given by the <Entity> argument that are listed in the <Filter> argument will be queried for matching instances. Only applicable when combined with the [subtypes] option. |
exclude filter: |
All subtypes of the entity given by the <Entity> argument except those listed in the <Filter> argument will be queried for matching instances. Only applicable when combined with the [subtypes] option. |
ascending: |
Ascending sorting order. This option is only effective when the <order by> argument is specified. When the result table is displayed on the screen, the table can be sorted according to a column by clicking on the actual column head frame. |
descending: |
Descending sorting order. This option is only effective when the <order by> argument is specified. When the result table is displayed on the screen, the table can be sorted according to a column by clicking on the actual column head frame. |
include instance_ids: |
Prepend all attribute columns in the query result with an instanceId column. |
only instance_ids: |
Return only a single column with the instanceIds of the matcing instances. |
ignore empty columns: |
Specifies that empty columns will not be part of the result table. |
transfer no data: |
No query result will be returned from the remote EDMdatabase. Use this option when the number of matching instances is the only information needed or for testing the query syntax before actually performing it. |
html format: |
The output file will be created in HTML format. Default file extension is “.htm”. This option is only valid when the [result in file] option is set. |
xml format: |
The output file will be created in XML format. Default file extension is ".xml". This option is only valid when the [result in file] option is set. |
old xml format: |
The result of the query will be returned in a simple well formed XML formatted file on the local file system. |
ascii format: |
The output file will be created in ASCII format. Default file extension is ".txt". The tabulator character will be delimiter between each column. This option is only valid when the [result in file] option is set. |
result in file: |
Specifies that the result from the command will be written to the file specified in the <Output file> argument. |
zipped file: |
The file given by the argument <Output file> will be compressed with gzip. |
show file: |
The generated output file will be displayed in the available internet browser when the option [file output] is set together with one of the options [html format] or [xml format]. |