GetEntity function
Description
Displays the OpenInsight common dialog as used by the User Interface and Client/Server Workspaces.
Syntax
Item = GetEntity(Mode, TypeDesc, bFilter, Display, ItemLabel, ListLabel, DefaultSelection, DefaultType, Options)
Parameters
The GetEntity function has the following parameters:
| Parameter | Description |
|---|---|
| Mode | Open or save as, defined by GE_MODE_OPEN$ and GE_MODE_SAVE$ in the insert record GetEntity_Equates. |
| TypeDesc | An @fm delimited array of human-readable selection criteria (filters), like "Messages" |
| Bfilter | An @fm delimited array of Boolean values corresponding to the TypeDesc parameter. True signifies that Display<i> contains a "TYPE*CLASS" repository filter, while FALSE$ signifies that Display<i> contains an @vm-delimited list of items to display. |
| Display | An @fm delimited array of display information corresponding to the TypeDesc parameter. Each item in the array is either a "TYPE*CLASS" repository filter or an @vm-delimited list of items depending on the filter chosen for the type.. |
| ItemLabel | (optional) @fm delimited array of labels that replace "Entity Name:" (for filters) or "Item Name" (for lists). |
| ListLabel | (optional) @fm delimited array of labels that replace "List Entities of Type:" (for filters) or "List Items of Type:" (for lists) |
| DefaultItem | (optional) default item name, defaults to NULL (""). |
| DefaultType | (optional) index into TypeDesc, defaults to 1. |
| Options | (optional) An @fm delimited array of additional options regarding various items within the Get_Entity dialog. The options are defined in the GetEntity_Equates insert record . There are four additional options. Option # (Option Equates) - Description 1 (GE_OPT_TITLE$) - Text string to replace the dialog default title. 2 (GE_OPT_HIDE_CHK$) - True will hide the "Show Inherited" check box. 3 (GE_OPT_HEADTEXT$) - The heading text for the dialog box. 4 (GE_OPT_SUBHEADTEXT$) - The subheading text for the dialog box. |
Returns
index:@fm:name, where the index specifies the filter/list number (position within TypeDesc) and the name is either a fully qualified entity id (if bFilter<index> is true) or the item selected from the list.
See Also
Example
* Create an Open Dialog for all Native Reports and launch the
* opened report
Declare Function Repository
$Insert Logical
$Insert GetEntity_Equates
mode = GE_MODE_OPEN$
Type_Desc = 'Banded Reports':@fm:'Report Builder Reports'
bFilter = True$ : @fm : True$
Display = 'OIREPORT*BRWLAYOUT' : @fm : 'OIREPORT*RBLAYOUT'
Item_Label = "Banded Reports" : @fm : "Report Builder Reports"
List_Label = "Report Type" : @fm : "Type of Reports"
Default_Item = ""
Default_Type = ""
options = ""
options<1> = "Run Reports"
options<2> = 1
options<3> = "Run Reports"
options<4> = "Select a Report to Run"
ReposID = GetEntity(Mode, Type_Desc, bFilter, Display, Item_Label, List_Label, Default_Item, Default_Type,Options)
If ReposID then
report_info = Repository('EXECUTE', ReposID<2>)
end