vdl-action-get-entity-data
Fetch data from a model entity.Supported model entity types: ARRAY, SET, BOOLEAN, INTEGER, REAL & STRING.When using the "with-labels" attribute, data will be returned as an ARRAY.
Required parent element
Example
<vdl-action-group name="getData">
<vdl-action-get-entity-data entity="myEntity" scenario="0" with-labels="true"></vdl-action-get-entity-data>
</vdl-action-group>
<vdl-action-group name="getFilteredData">
<vdl-action-get-entity-data entity="myArrayEntity" scenario="0" filters="={'SetOneName':[1,2], 'SetTwoName':[1,2]}"></vdl-action-get-entity-data>
</vdl-action-group>
<vdl-action-group name="getFilteredData">
<vdl-action-get-entity-data entity="myArrayEntity" scenario="0" filters="={0:[1,2], 1:[1,2]}"></vdl-action-get-entity-data>
</vdl-action-group>Attributes
| entity | The name of the model entity to fetch data from.If the entity attribute is not set then the current value passed by the previous VDL Action or VDL action group will be used to supply the entity name.An error will be displayed if the entity does not exist. | accepts expression | |
|---|---|---|---|
| filters | To return a only a slice of the array, pass a filters object that is keyed by either the set name, or the indices of the set to be filtered by. The values of the filters must in an array and relate to the keys not the labels. For example: {'SetOneName': [1,2], 'SetTwoName': [1,2]}, or {0: [1,2], 1: [1,2]}.An error will be thrown when un-related set names or indices that are not in range are used, or the values are not in an array. | requires expression | |
| scenario | The scenario to fetch data from, defaults to the first scenario. You can specify either a scenario id or the current position of the scenario on the shelf. | accepts expression | |
| with-labels | Add labels to the returned entity data. Labels will be fetched from the annotated labels array. If there is no label array, labels will contain the value |
© 2001-2023 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.