Fields

Name for the field that can be referenced in code as the variable name in which the field's value is stored.

Avoid using the following field names:

accept
accept-charset
action
autocomplete
enctype
method
name
novalidate
target

As well as global attributes:

accesskey
class
contenteditable
contextmenu,data-*
dir
draggable
dropzone
hidden
id
itemid
itemprop
itemref
itemscpe
itemtype
lang
spellcheck
style
tabindex
title

Label for the field; can be text or a message key.

Tool tip help text; can be text or a localizable message key.

Example:

<Field name="firstName" displayName="First Name" helpKey="Enter the person's first name" />

Field datatype; influences the display widget used to display the field on a form.

Valid values are:
string, int, long, boolean, date, and SailPoint object types (Identity, Bundle, Permission, Rule, Application), default is string.

SailPoint objects are displayed as dropdown lists or combo boxes if multi="true" is also specified.

Specifying type="boolean" renders the field as a checkbox; specifying type="date" adds a calendar from which the date can be selected.

To preselect an object in the list, specify the name of the object (not an actual object) as the "value" attribute.

Example:

<Field name="role" displayName="Role" type="Bundle" value="TRAKK Basic" />

Boolean indicating whether the field is multi-selectable.

This attribute is only appropriate to drop-down lists, which are then displayed as combo boxes. Used this with SailPoint object field types or with a nested AllowedValues / AllowedValuesDefinition element that populates a selection list for the field.

Example:

<Field name="apps" displayName="Applications" type="Application" multi="true"/>

Boolean indicating that the field cannot be edited on the form. The value is displayed as text, not in an editable box.
Not necessary to specify on fields in a datatable section, since they are already read-only.

Boolean that, when true, prevents the field from being displayed on the form.

This attribute is used in reporting to make fields available for inclusion on the report detail grid but not actually include them by default.

This can be used in any form, but might not be commonly implemented:

• In role / application provisioning policies, fields are only shown if the user needs to enter data, so forcing fields to be hidden is not helpful.

• In workflows, the hideIncompleteFields attribute on the Form object is more likely to be used with the dependencies attribute on Field to defer field display until dependencies are fulfilled.

• In Identity provisioning policy, fields that should be hidden can be omitted from the form instead, however, this could be used for fields that always contain the same value for all users to set that value and suppress the field from the data entry form. For example, <Field name="status" hidden="true" value="NewHire" /

Attributes marked hidden are not included in the plan. You must manually add the includeHiddenFields property to the form to include the hidden fields in the plan.

<entry key="includeHiddenFields" value="true"/>

Boolean indicating whether a value is mandatory for the field; required="true" marks the field with * on the form to indicate that a value is required, and prevents form submission without a value for the field.

Example:<Field name="myfield" displayName="My Field" required="true"/>

Boolean that, when true, causes the form to refresh when the field's data value changes, running any rules or scripts that run on form load.

<Field name="application" displayName="Application" type="Application" postBack="true"/>

Supports conditional display / editing of sections or fields based on other field attributes values, automatic population of fields based on other fields, and validation of fields based on actions taken on the form. It only runs when a field loses focus, so it can be used on selection fields or text entry fields.

Used when the section is configured with multiple columns; specifies the number of columns the field should span.

<Section columns="2" label="Identity Info" name="identInfo">

<Field name="fname" displayName="First Name" columnSpan="2"/>

Used for fields where type is a SailPointObject class to specify a filter to restrict the set of selectable objects presented in the drop-down list.

filterString is specified according to the filter string syntax and should be specified in single quotes, so that double quotes can be used within the string.

Example:
<Field displayName="Role" name="role" type="Bundle" filterString='name.startsWith("TRAKK")' />

Statically defined fields in a form's XML are defined within a section element, so any section attribute specified on those fields is ignored. However, the section attribute can be used to organize fields in an application or role provisioning policy or on a dynamically rendered form.

Application and role provisioning policy forms do not have section elements, so the section attribute can be used to force fields to be grouped differently than the default (default is by application or by role).

Example:

These two fields are put on the form in separate sections, labeled "Important Items" and "Optional Items" respectively.

<Field name="myField" displayName="My Field" section="Important Items"/>

<Field name="optField" displayName="Optional Field" section="Optional Items"/>

The section attribute on fields is also used in dynamically created forms (such as in Reports where fields are added to the form programmatically through an initialization script). This attribute enables the code to specify the section of the form into which the field should be added.

Forces string fields to display as specified, used only for string fields.

Valid displayTypes are: radio, combobox, textarea, and label

displayType="radio" and "combobox" are used to override the default display format for permitted-values fields (radio is the default for 2 options while >2 options is rendered as comboBox by default). textarea is used to make a string field display as a text area instead of a regular entry field.

For label, you can use the field displayName for the text / message key of the label.

<Field name="dept" displayName="Department" displayType="radio"<AllowedValues>


<String>Accounting</String>

<String>Manufacturing</String>

<String>Engineering</String>

</AllowedValues>

</Field>

<Field name="comments" displayName="Comments" displayType="textarea" />

Sets the default / initial value for the field. This can be overwritten on the form in most cases, as long as the field is not marked readOnly. This is used within sections of type="text" to specify the text to display

For application or role provisioning policies, setting a value (whether with this attribute or through a nested <Value>, <RuleRef>, or <Script> element) prevents the field from being included on the form unless reviewRequired is specified since provisioning policies only collect values from a user that they cannot determine or calculate independently.

In workflow approvals, value can be specified by string, rule, script, call, or reference (string is default).

In reports forms, the value is a reference to the report taskDefinition's input parameter from which to retrieve the starting / default value for the field, for example, value="ref:applications".

Example:

<Field name="role" displayName="Role" type="Bundle" value="TRAKK Basic"/>

List (CSV) of other fields that must be evaluated before this field.

Dependencies on the provisioning policy (form) field cause that field to be deferred to a subsequent form that is presented after the form on which its dependencies are presented. The field might also be calculated based on those dependencies instead of presenting it on a later form.

This attribute can also be used with dynamic / allowedValues fields. Values of dependencies fields are made available to the allowedValues script or rule, even if the field is presented on a different form.

Enables a default value to be assigned to the field while still including the field on the form displayed to a user. This enables the default to be edited. If reviewRequired="true" is not specified, the provisioning policy form fields with a default value (or value script / rule that returns a value) are omitted from the user-facing form and the default value is automatically used.

Field description, used for XML self-documentation. Not displayed in user interface.

<Description>
This field stores the Identity's first name.
</Description>

Attribute map used to control field rendering, specific to the field type. The most common attributes are height and width which are usually specified for textarea fields and for entry boxes that need to be other than the default rendering size. Units for height and width are in pixels.

<Attributes>
<Map>
<entry key="height" value="200"/>
<entry key="width" value="100"/>
</Map>
</Attributes>


Alternative to "value" attribute on <Field>. This is required when specifying complex datatypes such as Map or List.

<Value>
<List>
<String>Thing 1</String>
<String>Thing 2</String>
</List>
</Value>

Also needed for fields of type Date, which are specified as the utime representation of the date:

<Value>
<Date>1231971297</Date>
</Value>

Can be used to specify simpler types like String, Boolean, etc. but not commonly done because value attribute is simpler.

Script used to initialize the value of the field, alternative to the value element / attribute. Automatically created for fields whose value is set by script through user interface specification.

Example:

<Script>
<Source>
[BeanShell code goes here]
return [value or variable that contains value to assign to the field];
</Source>
</Script>

Reference to a reusable rule for initializing field value. Alternative to <Script> (and value attribute). Automatically created for fields whose value is set by script through user interface specification.

<RuleRef>
<Reference class="Rule" name="My Rule" id="402839343985ff930d" />
</RuleRef>

Specifies a set of values from which the user can select to assign the field value. Automatically created for fields with an allowed values property set to Value (with a list of values specified) through user interface specification.

<Field name="dept" …>
<AllowedValues>
<String>Accounting</String>
<String>Manufacturing</String>
<String>Engineering</String>
</AllowedValues>
</Field>

The list renders as radio buttons when only two options exist (and multi is not allowed), as a listbox for more than two options, and as a combobox for multi-selectable fields.

Populates a list of values from which the user can select a value for the field. This field contains either a <Script> block that specifies the list programmatically or a <RuleRef> that points to a rule containing the beanshell for generating the list. Automatically created for fields with an allowed values property set to Script or Rule through user interface specification.

<AllowedValuesDefinition>
<Script>
<Source>
import sailpoint.object.*;
List l = new ArrayList();
for(WorkItem.State enumItem : WorkItem.State.values()) {
List l2 = new ArrayList();
l2.add(enumItem.toString());
l2.add(enumItem.getMessageKey());
l.add(l2);
}
return l;
</Source>
</Script>
</AllowedValuesDefinition>

Alternative to AllowedValues element and more commonly used. The list renders as radio buttons when only two options exist (and multi is not allowed), as a listbox for more than two options, and as a combo box for multi-selectable fields.

Script used to examine and validate the field value entered by the user. The value entered is passed to the validation script in the variable named "value."

<ValidationScript>
<Source>
if (value > 10) {
return "Value must be less than or equal to 10";
else
return null;
</Source>
</ValidationScript>

Returns null if no errors and an error message (as string or SailPoint.tools.message object) if validation errors exist.

Reference to reusable rule for field validation. This is the alternative to ValidationScript.

<ValidationRule>
<Reference class="Rule" name="My Validation Rule" id="4028392342f5ff9301" />
</ValidationRule>

Used only for application and role provisioning policies to determine the Identity to whom the fields should be presented. This enables specification of a RuleRef, script, a Value element or a Value attribute:

<OwnerDefinition>
<RuleRef>
<Reference class="rule" name="My Owner Rule" id="4038293483598523" />
</RuleRef>
</OwnerDefinition>
or
<OwnerDefinition>
<Script>
<Source>
import sailpoint.object.*;
Identity myIdentity=context.getObjectByName(Identity,"Walter.Henderson");
return myIdentity;
</Source>
</Script>
</OwnerDefinition>
or
<OwnerDefinition value="IIQApplicationOwner"/>

Can provide either the string name of owning Identity or the Identity object.

As with Field value, OwnerDefinition value can also be expressed as a nested element. It can be a string Identity name or an Identity object:

<OwnerDefinition>
<Value>
<String>Walter.Henderson</String>
</Value>
</OwnerDefinition>

Three special names exist that are translated by IdentityIQ into the appropriate Identity so an OwnerDefinition script is not required for them:

• IIQParentOwner – owner of the role or application containing the provisioning policy form

• IIQApplicationOwner – owner of the application associated with the provisioning policy form

• IIQRoleOwner – owner of the role containing the provisioning policy form

<OwnerDefinition value=""/> assigns and presents the field to the access requester.

The user interface offers these options for setting field owners: Requester (sets OwnerDefinition to ""), Application Owner (sets to "IIQApplicationOwner"), Role Owner on Role Provisioning Policies(sets to "IIQRoleOwner"), and Rule and Script (save as OwnerDefinition with nested RuleRef or Script, as shown above).