Configuration Guide for Siebel Offline Client for Life Sciences > Configuration Files, Filter Definitions, and Calculated Expressions > Application, Page, and Applet Definitions >
Applets Definition
The following code sample describes a general definition of an applet schema. Example of Code for Applets Schema Definition
The following code is an example of an applets schema definition. appletsdefn.xml: < AppletData> < Filters> < applets> </ AppletData>
< Filters>: <Filters> <FILTER>+ </Filters>
<applets>: <applets> <APPLET>+ </applets>
<APPLET>: <APPLET> <DRILLDOWN_OBJECTS>? <RULES>? <APPLET_USER_PROPS>? <TEMPLATE> </APPLET>
<DRILLDOWN_OBJECTS>: <DRILLDOWN_OBJECTS> <DRILLDOWN_OBJECT>* </DRILLDOWN_OBJECTS>
<DRILLDOWN_OBJECT>: <DRILLDOWN_OBJECT> <DYNAMIC_DRILLDOWN_DESTIONATIONS>* </DRILLDOWN_OBJECT>
<DYNAMIC_DRILLDOWN_DESTINATIONS>: <DYNAMIC_DRILLDOWN_DESTINATIONS> DYNAMIC_DRILLDOWN_DESTINATION>* </DYNAMIC_DRILLDOWN_DESTINATIONS>
<RULES>: <RULES> <RULE>* </RULES>
<APPLET_USER_PROPS>: <APPLET_USER_PROPS> <APLLET_USER_PROP>* </APPLET_USER_PROPS>
<TEMPLATE>: <TEMPLATE> <TEMPLATE_ITEM>+ </TEMPLATE>
<TEMPLATE_ITEM>: <TEMPLATE_ITEM> <TEMPLATE_ITEMS_USER_PROPS>* <PICKMAPS>* </TEMPLATE_ITEM>
<TEMPLATE_ITEMS_USER_PROPS>: <TEMPLATE_ITEMS_USER_PROPS> <TEMPLATE_ITEMS_USER_PROP>* </TEMPLATE_ITEMS_USER_PROPS>
<PICKMAPS>: <PICKMAPS> <MAPPING>* </PICKMAPS>
The following topics describe the attributes for the page schema definition:
<FILTER> Attributes
Table 34 describes the <FILTER> attributes for the Applets schema definition.
Table 34. <FILTER> Attributes
|
|
|
|
|
NAME |
Required |
None |
Text |
Name of the filter definition file. |
VERSION |
Required |
None |
Number |
Version number of the filter definition file. |
<applets> Attribute
Table 35 describes the <applets> attribute for the Applets schema definition.
Table 35. <applets> Attributes
|
|
|
|
|
SEQUENCE |
Optional |
None |
Number |
Not used. |
<APPLET> Attributes
Table 36 describes the <APPLET> attributes for the Applets schema definition.
Table 36. <APPLET> Attributes
|
|
|
|
|
ALPHA_FIELD |
Optional |
None |
Text |
Field for filtering records using the alphabetical query bar. |
ASSOCIATE_APPLET |
Optional |
None |
Text |
Not used. |
CLASS |
Required |
None |
AppletObj |
This applet is a generic applet. |
CLASS |
Required |
None |
FormAppletObj |
This applet is a form. |
CLASS |
Required |
None |
ListAppletObj |
This applet is a list. |
CLASS |
Required |
None |
PickAppletObj |
This applet is for selection through query and filtering. |
CLASS |
Required |
None |
PivotObj |
This applet is for pivot query. A pivot query is a query that delivers the sum total of a number of values. |
COMMENTS |
Optional |
None |
Text |
Information about the applet. |
DRAG_ENABLED |
Optional |
None |
Text |
Indicates that a user can move records in this applet another applet. |
DROP_ENABLED |
Optional |
None |
Text |
This applet can be a drop target for relevant records. This refers to a drag and drop action, which requires a source to drag from and a target to drop the object to. |
ENTITY |
Required |
None |
Text |
The object or database table that this applet is based on. |
FILTER |
Required |
None |
Text |
The filter definition file on which this applet is based. |
HEIGHT |
Optional |
0 |
Number |
Height in pixels. |
HEIGHT |
Optional |
0 |
Number% |
Height expressed as a percentage. |
HELP_IDENTIFIER |
Optional |
None |
Text |
Unique identifier in an index of help files. |
INACTIVE |
Optional |
N |
N |
This applet is active. |
INACTIVE |
Optional |
N |
Y |
This applet is disabled. |
INSERT_POSITION |
Optional |
First |
first |
Inserts new records at the beginning of the list. |
INSERT_POSITION |
Optional |
First |
last |
Inserts new records at the end of the list. |
INSERT_POSITION |
Optional |
First |
immediateAfter |
Inserts new records immediately after the selected record. |
NAME |
Required |
None |
Text |
Name of the applet. |
NO_DELETE |
Optional |
N |
N |
Records can be deleted. |
NO_DELETE |
Optional |
N |
Y |
Records cannot be deleted. |
NO_INSERT |
Optional |
N |
N |
Records can be inserted. |
NO_INSERT |
Optional |
N |
Y |
Records cannot be inserted. |
NO_UPDATE |
Optional |
N |
N |
Records can be modified. |
NO_UPDATE |
Optional |
N |
Y |
Records cannot be modified. |
PERSISTENT |
Optional |
N |
N |
The content and layout information of the applet are not cached. |
PERSISTENT |
Optional |
N |
Y |
The content and layout information of the applet are cached for the session. The cache prevents the applet from being reloaded each time. Use this attribute for data or UI intensive applets. UI intensive applets are applets with a complicated UI, requiring lengthy processes to reload the applet. |
SEARCH_SPEC |
Optional |
None |
Text |
Only display records that meet the filtering criteria. |
TITLE |
Optional |
None |
Text |
String Id for the applet title. |
TITLE_TEXT |
Optional |
None |
Text |
Displayed text of the applet title. |
TYPE |
Optional |
Standard |
Associate |
Not used. |
TYPE |
Optional |
Standard |
Standard |
Specifies that this is a normal applets. |
TYPE |
Optional |
Standard |
Pick |
Specifies that this type is a pick map. |
WIDTH |
Optional |
0 |
Number |
Width in pixels. |
WIDTH |
Optional |
0 |
Number% |
Width expressed as a percentage. |
XMLDATA_ROOT_TAG |
Required |
None |
ListOfObject |
Name of the XML tag name in the filter definition file for the entity. |
<DRILLDOWN_OBJECT> Attributes
Table 37 describes the <DRILLDOWN_OBJECT> attributes for the Applets schema definition.
Table 37. <DRILLDOWN_OBJECT> Attributes
|
|
|
|
|
COMMENTS |
Optional |
None |
Text |
Indicates a comment field. |
DESTINATION_FIELD |
Required |
None |
Text |
Field in the target record that matches the field of the source record. |
ENTITY |
Required |
None |
Text |
Entity of the target record. |
HYPERLINK_FIELD |
Required |
None |
Text |
Field in this record for initiating the drilldown. |
INACTIVE |
Optional |
N |
N |
This drilldown is active. |
INACTIVE |
Optional |
None |
Y |
This drilldown is disabled. |
NAME |
Required |
None |
Text |
Name of the drilldown |
PAGE |
Required |
None |
Text |
Page to drilldown to, or the link you click to obtain more detailed information. |
SEQUENCE |
Optional |
None |
Number |
This is the order of evaluation among the list of drilldowns. Each drilldown in the list is evaluated in order of the SEQUENCE attribute. If a drilldown is found, where all conditions are fulfilled, that drilldown is executed and further evaluation of the list is stopped. |
SOURCE_FIELD |
Required |
None |
Text |
Field in this applet for matching the destination field. |
<DYNAMIC_DRILLDOWN_DESTINATION> Attributes
Table 38 describes the <DYNAMIC_DRILLDOWN_DESTINATION> attributes for the Applets schema definition.
Table 38. <DYNAMIC_DRILLDOWN_DESTINATION> Attributes
|
|
|
|
|
DESTINATION_DRILLDOWN_OBJECT |
Required |
None |
Text |
Name of drilldown object to be evaluated next. |
FIELD |
Required |
None |
Text |
Name of the field from which the drilldown is based. |
INACTIVE |
Optional |
N |
N |
Dynamic drilldown destination is active. |
INACTIVE |
Optional |
N |
Y |
Dynamic drilldown destination is disabled. |
NAME |
Required |
None |
Text |
Name of the dynamic drilldown destination. |
SEQUENCE |
Optional |
None |
Number |
This is the order of evaluation among the list of drilldowns. Each drilldown in the list is evaluated in order of the SEQUENCE attribute. If a drilldown is found, where all conditions are fulfilled, that drilldown is executed and further evaluation of the list is stopped. |
VALUE |
Required |
None |
Text |
Value of the field on which the drilldown is based. |
<RULE> Attributes
Table 39 describes the <RULE> attributes for the Applets schema definition.
Table 39. <RULE> Attributes
|
|
|
|
|
CLASS |
Required |
None |
Text |
This is the ActionScript class where the rule is defined. For a rule to perform any action in the Offline Client for Life Sciences application, it must be associated with corresponding ActionScript code. This code is contained in a file, representing a class. Each class can contain multiple code segments, or methods, that perform different actions. |
ENTITY |
Optional |
None |
Text |
The entity to which the rule is applied. |
EVENT |
Required |
None |
Text |
The UI event that triggers the rule. |
INACTIVE |
Optional |
N |
N |
The rule is active. |
INACTIVE |
Optional |
N |
Y |
The rule is disabled. |
METHOD |
Required |
None |
Text |
This is the ActionScript class where the rule is defined. For a rule to perform any action in the Offline Client for Life Sciences application, it must be associated with corresponding ActionScript code. This code is contained in a file, representing a class. Each class can contain multiple code segments, or methods, that perform different actions. |
NAME |
Required |
None |
Text |
Name of the rule. |
<APPLET_USER_PROP> Attributes
Table 40 describes the <APPLET_USER_PROP> attributes for the Applets schema definition.
Table 40. <APPLET_USER_PROP> Attributes
|
|
|
|
|
INACTIVE |
Optional |
N |
N |
This applet user property is active. |
INACTIVE |
Optional |
N |
Y |
This applet user property is disabled. |
NAME |
Required |
None |
Text |
Name of the applet user property. |
VALUE |
Required |
None |
Text |
Value of the applet user property. |
<TEMPLATE> Attributes
Table 41 describes the <TEMPLATE> attributes for the Applets schema definition.
Table 41. <TEMPLATE> Attributes
|
|
|
|
|
INACTIVE |
Optional |
N |
N |
This applet user property is active. |
INACTIVE |
Optional |
N |
Y |
This applet user property is disabled. |
NAME |
Required |
None |
Text |
Id for this template. |
SEQUENCE |
Required |
None |
Text |
Placeholder that references the main control of any template for loading of subcontrols, for example, in the form applet template the placeholder, PHn, refers to the tile container into which all form items are loaded. A tile container is a placeholder for a section on the template, into which all form items are loaded. |
SUBTMPL |
Optional |
None |
Text |
Name of the subtemplate, which is used for a pop up. |
WEB_TEMPLATE |
Required |
None |
Text |
Name of the applet template used for this applet. |
<TEMPLATE_ITEM> Attributes
Table 42 describes the <TEMPLATE> attributes for the Applets schema definition.
Table 42. <TEMPLATE_ITEM> Attributes
|
|
|
|
|
AVAILABLE |
Optional |
None |
N |
This item is in the default display. Applicable to List Applets only. |
AVAILABLE |
Optional |
None |
Y |
The item is in the Available list of the applet rather than the default display. This attribute is applicable to list applets only. |
CALCULATED |
Optional |
N |
N |
This item maps to a field in the entity. |
CALCULATED |
Optional |
N |
Y |
This is a calculated field and the formula is in EXPRESSION. |
COLINDEX |
Optional |
None |
Number |
Indicates the form column number in which this item is displayed. Column numbering starts from 0. |
COLSPAN |
Optional |
None |
Number |
Number of columns this item occupies. |
COMMENTS |
Optional |
None |
Text |
Information about the item. |
DATA_TYPE |
Required |
None |
DTYPE_BOOL |
Specifies a Boolean data type. |
DATA_TYPE |
Required |
None |
DTYPE_CURRENCY |
Specifies a Currency data type. |
DATA_TYPE |
Required |
None |
DTYPE_DATE |
Specifies a Date only data type. |
DATA_TYPE |
Required |
None |
DTYPE_DATETIME |
Specifies a Date and time data type. |
DATA_TYPE |
Required |
None |
DTYPE_ID |
Specifies a ID data type. |
DATA_TYPE |
Required |
None |
DTYPE_INTEGER |
Specifies a Integer data type. |
DATA_TYPE |
Required |
None |
DTYPE_NUMBER |
Specifies a Float data type. |
DATA_TYPE |
Required |
None |
DTYPE_PHONE |
Specifies a Phone number data type. |
DATA_TYPE |
Required |
None |
DTYPE_TEXT |
Specifies a Text data type. |
DATA_TYPE |
Required |
None |
DTYPE_TIME |
Specifies a Time only data type. |
DATA_TYPE |
Required |
None |
DTYPE_ZIPCODE |
Specifies a ZIP code data type. |
DISPLAY_FORMAT |
Optional |
None |
Text |
Display format for the item. |
DISPLAY_OBJECT |
Optional |
None |
Text |
Id of an additional displayed item (icon or string). |
DISPLAY_OBJECT_TEXT |
Optional |
None |
Text |
Text (title or label). |
EXPRESSION |
Required when CALCULATED is set to Y. |
None |
Text |
Formula to calculate the value of the item. |
FIELD |
Optional |
None |
Text |
Field in the entity for this item. |
GROUP |
Optional |
None |
Text |
This item belongs to a specific group, such as a popup. |
HEIGHT |
Optional |
0 |
Number |
Height in pixels. |
INACTIVE |
Optional |
N |
N |
This item is active. |
INACTIVE |
Optional |
N |
Y |
This item is disabled. |
ITEM_IDENTIFIER |
Optional |
None |
Text |
Specifies in which placeholder this item is displayed in the applet template. |
NAME |
Required |
None |
Text |
Name of the item. |
NO_COPY |
Optional |
None |
N |
This field can be copied. If DEEPCOPY is set to Y on the child applet, then the child records will also be copied. |
NO_COPY |
Optional |
None |
Y |
This field cannot be copied. |
PICK_APPLET |
Optional |
None |
Text |
Applet that provides fields to define the pick map. |
POPUP_EDIT |
Optional |
N |
N |
This item displays in a standard format. |
POPUP_EDIT |
Optional |
N |
Y |
This item is displayed in a bigger popup for ease of editing. |
PRE_DEFAULT |
Optional |
None |
Text |
Default value for this item after creation of a new record. |
READ_ONLY |
Optional |
N |
N |
The item is editable. |
READ_ONLY |
Optional |
|
Y |
The item is read-only. |
REQUIRED |
Optional |
N |
N |
The item is not required. |
REQUIRED |
Optional |
N |
Y |
The item is required. |
ROWINDEX |
Optional |
None |
Number |
Row number of the item in the form. It starts at zero (0). |
ROWSPAN |
Optional |
None |
Number |
Number of columns this item occupies. |
SEQUENCE |
Optional |
None |
Number |
The order of this item in the applet. |
SHOW_IN_LIST |
Optional |
None |
N |
Indicates that this item cannot be displayed, for example, a Delete button in the list. Applicable to list applet only. |
SHOW_IN_LIST |
Optional |
None |
Y |
Displays this item in the list. Applicable to list applet only. |
SORT |
Optional |
None |
Number |
Sorts items in a consecutive numerical order, starting from 1. |
SORT_MODE |
Optional |
None |
ASC |
Sorts in ascending order. |
SORT_MODE |
Optional |
None |
DESC |
Sorts in descending order. |
TAB_STOP |
Optional |
None |
None |
Not used |
TEXT_ALIGNMENT |
Optional |
left |
center |
Aligns text in the center. |
TEXT_ALIGNMENT |
Optional |
left |
left |
Left aligned. |
TEXT_ALIGNMENT |
Optional |
left |
right |
Right aligned. |
TYPE |
Optional |
None |
AdvancedCheckBox AdvancedColorPicker AdvancedCombobox AdvancedTextArea AppletToggle CheckBox ColorPicker ComboBox CustomCtrl DateField DatePickerField DateTimeField Detailer DrillDownThreadBar HorizontalButtonBar HorizontalNumericStepper HToolbar IconMap Image Label Label10 Label11 Label12 Label13 Label14 Label8 Label9 LabelBold LabelBold10 LabelBold11 LabelBold12 LabelBold13 LabelBold14 LabelBold8 LabelBold9
|
UI control for displaying this item. |
TYPE (contd) |
Optional |
None |
MultilineText MultilineText2 MultiSelectCheckBox MultiSelectComboBox Number NumericStepper Page PDQControl PDQControlPanel Pick PopUpButton PwdControl RadioButton Ratings Signature Slider SortControl Text Text10 Text11 Text12 Text13 Text14 Text8 Text9 TextArea TextBold TextBold10 TextBold11 TextBold12 TextBold13 TextBold14 TextBold8 TextBold9 TextInput ThreadBar ToggleButtonBar Toolbar TrashControl UnboundedTextArea UnboundedTextInput VerticalButtonBar VerticalButtonBarLeft Vtoolbar
|
UI control for displaying this item. |
VISIBLE |
Optional |
None |
N |
Displays this item. |
VISIBLE |
Optional |
None |
Y |
Does not display this item. |
WIDTH |
Optional |
0 |
Number |
Width of this item in pixels. |
<TEMPLATE_ITEMS_USER_PROP> Attributes
Table 43 describes the <TEMPLATE_ITEMS_USER_PROP> attributes for the Applets schema definition.
Table 43. <TEMPLATE_ITEMS_USER_PROP> Attributes
|
|
|
|
|
INACTIVE |
Optional |
N |
N |
This user property is active. |
INACTIVE |
Optional |
N |
Y |
This user property is disabled. |
NAME |
Required |
None |
Text |
Name of the template item user property. |
VALUE |
Required |
None |
Text |
Value of the template item user property. |
<MAPPING> Attributes
Table 44 describes the <MAPPING> attributes for the Applets schema definition.
Table 44. <MAPPING> Attributes
|
|
|
|
|
CONSTRAINT |
Optional |
N |
N |
There is no field constraint on the Pick Applet query. |
CONSTRAINT |
Optional |
N |
Y |
The Pick Applet query is constrained by records where the FIELD in the pick applet matches the value in the PICK_FIELD. |
FIELD |
Required |
None |
Text |
The field in this applet to be mapped. |
INACTIVE |
Optional |
N |
N |
The mapping attribute is active. |
INACTIVE |
Optional |
N |
Y |
The mapping attribute is disabled. |
PICK_FIELD |
Required |
None |
Text |
The mapped field in the pick applet. |
|