CAPITULO VII La Reconquista
D. Ponce ensanchando los términos de su Obispado». (1)
The following tables provide a quick overview of the XML elements and attributes that are most commonly used in the data models.
Note
● XML elements can contain other XML elements nested inside them. For example, the hris-element XML element can contain label and hris-field XML elements:
<hris-element id=”location”>
<label>Location</label>
<hris-field max-length="32" id="externalCode" visibility="both"
required="true" pii="false" showTrailingZeros="false" >
<label>Code</label>
</hris-field>
<hris-associations>
<association id=”id” multiplicity=”ONE_TO_ONE” destination-entity=”geozone” required=”false” />
</hris-associations>
<search-criteria>
<search-field id=”corporateAddress.city” />
</search-criteria>
</hris-element>
● XML elements can contain several attributes, for example, the XML element hris-field contains the attributes max-length and id:
<hris-field max-length=”256” id=”amount”>
● Attributes are name-value pairs; it is predefined which values can be entered for which attributes. In the following example, the attribute with the name max-length can have a number as value:
max-length=”256”
Table 14: <hris-element>
...can include these XML elements or attributes: How to use this XML element or attrib
ute:
Attribute id This is the identifier for an HRIS element,
which represents one foundation object, or one person or employment object.
You cannot change the ID; to find out which data object has which ID, refer to the hris-element id of the data object ta
bles:
● Foundation Object Tables [page 384]
● Person Object Tables [page 448]
● Employment Object Tables [page 472]
...can include these XML elements or attributes: How to use this XML element or attrib
ute:
Element description This is where you enter a text that de
scribes an XML element, or what the data model is used for, for example. This description does not appear on the UI.
Element label This is the text that is shown on the UI.
You can change it if the customer wants to use a different naming. This text is also translatable.
Element trigger-rule This is used to assign a configurable rule
the customer has created to a user ac
tion on the user interface. For example, when a page is loaded or saved, a spe
cific system behavior defined in the con
figurable rule is triggered.
For more information, see Setting up configurable rules [page 207].
Element hris-field With hris-field you define each in
dividual field within this HRIS element.
Element hris-associations Associations define the relationship be
tween foundation objects.
Note
Associations can only be defined in the Corporate Data Model.
Element search-criteria Search criteria define what fields can be
used to search this HRIS element.
Table 15: <hris-field>
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Attribute max-length 256 This defines the maximum
length of this field on the UI.
For boolean fields, you can leave out this attribute.
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Attribute id start-date This is the identifier for a field
within an HRIS element.
You cannot change the ID; to find out which HRIS field has which ID, refer to the column Field ID in the data object ta
bles:
The visibility defines if this field is visible on the UI:
● “none”: Field is hidden.
You cannot import data for this field via CSV files.
● “view”: Field is read-only. You cannot import data for this field via CSV files. that means a user entry is re
quired — and is marked as such on the UI.
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Attribute pii ● true
● false
If this setting is true (pii=”true”), it defines that the field is a sensitive field; as such, it will be masked on the screen for se
curity reasons. This is a set
ting used for password fields, for example. When the user enters his data, only asterisks or similar symbols are shown on the UI instead of the actual data entered. This is done to prevent over-the-shoulder snooping for the user's pass
word.
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
With this XML attribute you define how many decimal dig
its are shown after the deci
mal point. Depending on the number of decimal digits you indicate here, the numbers displayed in the system get rounded up or down.
You can use this property only for HRIS fields with the data type DOUBLE, and you can define up to 5 decimal places. If you do not use this attribute for a DOUBLE data type, the number is rounded to three decimal places by de
fault. If you define a value higher than 5, the system uses the maximum value, which is 5. If you define a neg
ative value, for example, -1, the default value of 3 decimal places is used. Example:
maximumFractionDigit s=”2”
If the user enters 4.394 on the UI and the
maximumFractionDigit s have been defined to 2, the system reduces the decimal digits from 3 to 2 as defined in the data model and rounds down the value to show the following:
4.39
Note
Make sure that the follow
ing HRIS fields use the same
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute: field of the pay component foundation object is reused in the compensa
tion information. If you then choose to override this field and the value of the
maximumFractionDig its attribute is different for the fields, it leads to an error.
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Attribute showTrailingZeros ● true
● false
With this XML attribute you define if trailing zeros after a decimal number are dis
played, and how many. You can use this attribute only for HRIS fields with the data type DOUBLE. If you do not use this attribute for a DOUBLE data type in the XML file, by default no trailing zeros are shown.
Element label — This is the text that is shown
on the UI. You can change it if the customer wants to use a different naming. This text is also translatable.
Element trigger-rule — This is used to assign rules
the customer has created in the Rules Engine to a user ac
tion on the user interface.
When a field is changed, a specific system behavior de
fined in the rule is triggered.
For more information, see:
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Element picklist — If the value of this HRIS field
comes from a picklist, define the associated picklist infor
mation.
You can find more informa
tion about picklists in Working with ECV2 (Legacy) Picklists [page 345]
Table 16: <hris-associations> (only valid for Corporate Data Model)
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Element association — Associations define relation
ships between foundation ob
jects, or between a foundation object and a generic object.
Attribute id The only possible value is:
id
This is the identifier for an as
sociation between this foun
dation object and another ob
ject; do not change this value.
Attribute multiplicity ● ONE_TO_ONE
This is where you define the other foundation object or ge
neric object that this object has a relationship with. You enter the HRIS-element ID of that foundation object or the external code of the generic object as attribute value. The destination entity is the con
trolling object of the associa
tion.
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Attribute required ● true
● false
If this is set to “true”, the field becomes mandatory — that means a user entry is re
quired — and is marked as such on the UI.
Table 17: <search-criteria>
...can include these XML elements or attributes: How to use this XML element or attrib
ute:
Element search-field This defines a searchable field of this
HRIS element.
You can define search criteria that are used to find an entry in the system. In the following example, you define that you can search for a location by entering a city or a country. The system then tries to find a match with the information stored in the corporate address and shows the corresponding result.
Attribute id This is the ID that the system is search
ing for. You use the HRIS-element ID fol
lowed by the HRIS-field ID, separated by a period.
Table 18: <label>
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
Attribute xml:lang ● en-GB
● fr-CA
● it-IT
The label that appears on the UI can also be translated into other languages using the xml:lang attribute and the corresponding language code. The corresponding translations are stored in the XML file for the data model.
If the system does not find a corresponding label for the system language, it applies what the language it comes across first (in the following order) : (1)Locale of the user logged in, (2) company's de
fault locale, (3) label config
ured without xml:lang and (4) if none of these exist, it uses the default system label.
Table 19: <trigger-rule>
...can include these XML elements or attributes: These are possible attribute values:
How to use this XML ele
ment or attribute:
ecution of the rule. Possible values are:
● onInit: Rule is trig
gered when the page is loaded
● onSave: Rule is trig
gered when a page or HRIS-element is saved
● onChange: Rule is trig
gered when a field is page is opened in edit mode
● saveAlert: Rule is triggered when a data re
cord change has taken place and the current date is equal or after the effective date of the de
Attribute rule external code of the rule This is the rule that is trig
gered when the event on the user interface takes place.
You must have defined this rule in the Rules Engine and refer to the external code of the rule.