Overview
Gets the properties of:
- a generic object
- the children of the generic object
- the bookmarks/embedded snapshots of the generic object
Parameters
None
Outputs
The following is returned in the output:
| Name | Description | Type |
|---|---|---|
| qPropEntry |
Information about the properties. This parameter is mandatory. |
| Name | Description | Type |
|---|---|---|
| qProperty | Information about the generic object properties. |
GenericObjectProperties |
| qChildren | Information about the children of the generic object. | Array of GenericObjectEntry. |
| qEmbeddedSnapshotRef | Reference to a bookmark/snapshot that is embedded in the generic object. |
Null or GenericBookmarkEntry. |
| Name | Description | Type |
|---|---|---|
| qInfo |
Identifier and type of the object. This parameter is mandatory. |
NxInfo |
| qExtendsId |
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). This parameter is mandatory. If you do not want to link your object, set this parameter to an empty string. |
String |
| qMetaDef |
Definition of the dynamic properties. |
Dynamic properties |
| Name | Description | Type |
|---|---|---|
| qProperties | Information about the properties of the bookmark. |
GenericBookmarkProperties |
| qBookmark | Information about the bookmark. |
NxBookmark |
| Name | Description | Type |
|---|---|---|
| qInfo |
Information about the bookmark. This parameter is mandatory. |
NxInfo |
| qMetaDef | Definition of the dynamic properties. | Dynamic properties |
| Name | Description | Type |
|---|---|---|
| qStateData |
List of selections for each state. |
Array of AlternateStateData |
| qUtcModifyTime | Time when the bookmark was created. | Double precision floating point |
| qVariableItems | List of the variables in the app at the time the bookmark was created. | Array of BookmarkVariableItem |
| Name | Description | Type |
|---|---|---|
| qId |
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. This parameter is optional. If an identifier is not set, the engine automatically sets one. |
String |
| qType |
Type of the object. This parameter is mandatory. |
String |
| Name | Description | Type |
|---|---|---|
| qStateName |
Name of the alternate state. Default is current selections: $ |
String |
| qFieldItems | List of the selections |
Array of BookmarkFieldItem |
| Name | Description | Type |
|---|---|---|
| qDef | Name and type of the field |
FieldDefEx |
| qLocked |
Indicates if the field is locked. Default is false. |
Boolean |
| qSelectInfo | Information on the selections criteria |
SelectInfo |
| qValues |
List of the selected values Either the list of selected values or the list of excluded values is displayed. |
Array of FieldValue |
| qExcludedValues |
List of excluded values. Either the list of selected values or the list of excluded values is displayed. |
Array of FieldValue |
| qAndMode |
If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false. |
Boolean |
| qOneAndOnlyOne |
If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false. |
Boolean |
| Name | Description | Type |
|---|---|---|
| qName | Name of the field | String |
| qType | Type of data entity |
One of: • 0 for NOT_PRESENT: the field does not exist • 1 for PRESENT: plain field •2 for IS_EXPR: calculated dimension |
| Name | Description | Type |
|---|---|---|
| qTextSearch |
Text search string. Everything that matches the text is selected. This parameter is optional. |
String |
| qRangeLo |
Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
Double |
| qRangeHi |
Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
Double |
| qNumberFormat |
Gives information about the formatting of the range. This parameter is used when performing range selections or text searches in dimensions. |
FieldAttributes |
| qRangeInfo |
This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections. |
Array of RangeSelectInfo |
| Name | Description | Type |
|---|---|---|
| qText |
Text related to the field value This parameter is optional. |
String |
| qIsNumeric |
Is set to true if the value is a numeric. This parameter is optional. Default is false. |
Boolean |
| qNumber |
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional. |
Double |
| Name | Description | Type |
|---|---|---|
| qType |
Type of the field. Default is U. |
One of: • U for UNKNOWN type. • A for ASCII; Numeric fields values contain only standard ASCII characters. • I for INTEGER; Numeric fields values are shown as integer numbers. • R for REAL; Numeric fields values are shown as real numbers. • F for FIX; Numeric fields values are shown as numbers with a fix number of decimals. • M for MONEY; Numeric fields values are shown as in the money format. • D for DATE; Numeric fields values are shown as dates. • T for TIME; Numeric fields values are shown as times. • TS TIMESTAMP; Numeric fields values are shown as time stamps. • IV for INTERVAL; Numeric fields values are shown as intervals. |
| qnDec |
Number of decimals. Default is 10. |
Integer between 0 and 15. |
| qUseThou |
Defines whether or not a thousands separator must be used. Default is 0. |
One of:
|
| qFmt |
Defines the format pattern that applies to qText. Is used in connection to the type of the field (parameter qType). For more information, see Struct FieldAttributes. Example: YYYY-MM-DD for a date |
String |
| qDec |
Defines the decimal separator. Example: . |
String |
| qThou |
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: , |
String |
| Name | Description | Type |
|---|---|---|
| qRangeLo | Lowest value in the range. | Double |
| qRangeHi | Highest value in the range. | Double |
| qMeasure | Label of the measure. | String |
| Name | Description | Type |
|---|---|---|
| qName | Name of the variable. | String |
| qValue | Value of the variable. | FieldValue |
Learn more
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!