This topic describes the attributes you must define in
identifier screen files. Refer to the file samples for a better understanding
of the attributes.
Table 1. Attributes in the <screen_name>.js file
| Attribute |
Description |
uId |
This is the unique identifier for the screen
and is mandatory. |
packageName |
This is a mandatory attribute and it specifies
the package name of the screen. |
className |
This is a mandatory attribute and it specifies
the class name of the screen. |
namespaces |
It defines the object that contains all the
source and target namespaces used on the screen. This attribute is
mandatory, if you use namespaces on the screen. |
staticBindings |
The object that lists all the source and target
static binding namespaces and paths that are used on the screen. This
attribute is mandatory, if you use static bindings on the screen. |
events |
List of events that are published by the screen.
This attribute is mandatory, if the screen publishes some events. |
subscribers |
List of global and local events to which the
screen listens. This attribute is mandatory, if the screen listens
to any events. |
identifierType |
This attribute helps to categorize the type
of identifier screen. The value is a string. Example: AddressDisplay. |
templateString |
Unlike a normal screen, the value of this attribute
is dynamically determined, so do not define this attribute. The attribute
provides the HTML template file path that defines the UI of the screen. |
identifierList |
This is a mandatory attribute. It is a JSON
representation of the <IdentifierList> XML element
in the ExtnScreenIdentifiers.xml file. |
identifierMappings |
This is an optional attribute. It is a JSON
representation of <IdentifierMappings> XML element
in the ExtnScreenIdentifiers.xml file. |
Table 2. Attributes in <screen_name>InitController.js
| Attribute |
Description |
screenId |
Specifies the fully qualified class name of
the screen. This is a mandatory attribute. For example, extn.common.address.newdisplay.AddressDisplay |
className |
The name of the identifier screen. |
identifierTemplatesRootPath |
This attribute provides the path to the folder
that contains all identifiers. It begins with extn and
must be in the same format as packageName for a regular
screen. For example: extn.common.address.newdisplay.identifiers |
baseTemplateFolder |
This attribute provides the path to the templates folder
that contains the widget repository html file. It begins with extn and
must be in the same format as packageName for a regular
screen. For example: extn.common.address.newdisplay.templates |
Table 3. Attributes in <screen_name>BehaviourController.js
| Attribute |
Description |
screenId |
Specifies the fully qualified class name of
the screen. This is a mandatory attribute. For example, extn.common.address.newdisplay.AddressDisplay |
Table 4. Attributes in <screen_name>.html - HTML file for
an identifier
| Attribute |
Description |
data-dojo-type |
It defines the type of widget. For example, Link, Label,
and so on. |
data-ibmsc-uid |
It is the unique identifier of the widget in
the widget repository html, which should be used while referring the
widget in this identifier html. |
data_dojo_props_identifier |
It is a JSON string containing the uId and
its value, which is mandatory. Similarly, all the properties of the
widget that must be overridden in the identifier html, must be defined. Note: The
properties that you can override can only be strings, booleans, and
numbers.
|
Table 5. Attributes in ExtnScreenIdentifiers.xml file
| Attribute |
Description |
Screen |
This is the repeating element required for all
identifier screens. |
screenID |
This is the fully qualified class name for the
identifier screen and it is a mandatory attribute. |
defaultIdentifierId |
Determines the HTML file that should be used
to display the UI for an identifier when there is no corresponding
HTML defined for that identifier in the identifiers folder
of the extensions directory. |
IdentifierList |
This element is mandatory for a new screen.
It lists all the primary identifiers, for which HTMLs have been defined. |
description |
This is a mandatory attribute. It defines how
to access an identifier screen. For example: Open the Address tab
in customer details page for a customer with a France address to open
this identifier screen. |
identifierId |
This is a mandatory attribute and is required
to identify the primary identifiers in the identifier list. |
IdentifierMappings |
This is an optional element. Sometimes enterprises
may decide not to create separate HTMLs for each identifier but use
the primary identifier as a standard. For example, an enterprise may
decide to use the address display format of United States for India
as well. In the<IdentifierMapping> element
of the sample, identifierID represents the secondary
identifier, while baseIdentifierId represents the
primary identifier. Secondary identifiers do not have corresponding
HTML files. However, any HTMLs that may be defined for secondary identifiers,
are ignored by mapping with a primary identifier.
|
Table 6. Attributes in ExtnMetaData_custom.xml
| Attribute |
Description |
appScreen |
Specifies the screens provided in the application. |
extnScreen |
Specifies the newly created screen. |
type |
Specifies the method of using the newly created
identifier screen. For example, override. |
