Admin Tasks › Choose Tabs for the Task › Profile Tabs and Profile Screens › Field Properties on a Profile Screen › History Editor Field Properties

History Editor Field Properties

The history editor is a text area which creates new history entries, if this text area contains text when the task is submitted. The history editor can include an optional submit button, which allows the creation of history entries without submitting the task.

The history editor has the following field property settings:

• Attribute Name

  The name of the attribute in the directory.xml file.

  Note: The Attribute Name can only be associated with the (Separator) attribute name because it is not compatible with a real or logical attribute.

• Style

  The presentation of the field. This should be set to "HistoryEditor".

• Name

  The label you want for this attribute in the task.

• Label span

  The number of columns that the label will span.

• Field span

  The number of columns that the field will span (excluding the label)

• CSS Class

  The Cascading Style Sheet class that controls the presentation of this field.

• CSS Style

  Field properties and style defined using HTML property tags.

  Use this to set the width of a field. For example, to set the width of a field with the Drop Down style to 300 pixels, specify the following in the CSS Style field: {width: 300px}

  By default, the width of fields that include a list of values, such as a drop down or multi-selector box, is set to auto ({width:auto}). This setting sizes the field to accommodate the longest string in the field.

  Note: You can also use the CSS Style to control other display properties, such as text size and background color.

• Label

  The label text which appears over or to the left of the text area. This can be a string or a localization key, specified according to Identity Manager localization rules.

• Stakeholder

  This is a label attached to history log entries which describes the role of the user who created the log entry. For example, the following description would appear in the "Source" column of a history display for a user with an "Approver" stakeholder label:

  User comment by SalesMgr (John Doe) acting as Approver

  This can be a string or a localization key, specified according to Identity Manager localization rules. The stakeholder type is blank by default, and is optional.

• Rows

  The number of rows in the history text area.

• Columns

  The number of columns in the history text area.

• History Level

  Status level information:

  • Task Level—For approval tasks it is the task belonging to the event being approved. For non-approval tasks, this is the current task.
  • Event Level—For approval tasks, this is the event being approved. For non-approval tasks, this returns no results.
• Add Button Label

  The text to label for the submission button. This can be a string or a localization key, specified according to Identity Manager localization rules. If it is blank (the default value), then the button label is "Add History Event".

• Add Button CSS Class

  These strings will be included in the <input> element in the profile screen, as the contents of the 'style' and 'class' elements respectively.

• Add Button CSS Style

  These strings will be included in the <input> element in the profile screen, as the contents of the 'style' and 'class' elements respectively.

• Enable Add Button

  If checked, the history editor includes its own independent submission button. This button submit only the new history entry, not the entire task.