Features

Version and encoding: each Feature starts by announcing the version and encoding.

DataSet: each Feature starts by announcing the DataSet.

Feature Configuration

This will be detailed in the Feature Configuration section.

Scope

This will be detailed in the Scope section.

Screen

This will be detailed in the Screen section.

Operations

This will be detailed in the Operations section.

id

String

The id is the unique identifier of the Feature.
The id should be explicit for the purpose of the Feature since it will be used in the portal routes URL.

It is case sensitive and no special characters (except - or _) are allowed.

-

name

String

The Feature name.

The name may be different from the identifier.
Must be at least 4 characters long.

-

description

String

Used to describe the Feature that will be configured.

-

type

Type

Used to indicate the Feature type. It must be written in uppercase.

CREATE, READ, UPDATE, SEARCH, DEDUPLICATION, HUB, BULK, RAW_UPDATE, UI, UI_FOR_OBJECT

actions

action

NO

Allows to configure one or several actions (like Button Widget or Groovy action rule for example).

-

attributes

NO

List of Attributes on which the Operation applies.
If none is listed then the Operation can apply on all Attributes of the Object.

Configured Attributes

attribute

String

NO

Used to indicate the id of the Attribute.

Configured Attributes

checkInheritedAttributes

Boolean

NO

-

attributes

NO

List of Attributes on which the check applies.

Configured Attributes

attribute

String

NO

Used to indicate the id of the Attribute.

Configured Attributes

level

Enum

NO

Used to indicate the allowance level of the Attribute inheritance.

WARN, DO_NOTHING, FORBID

requestOptions

Option

NO

List of request options for create or update Features.

-

simulate

Boolean

NO

true, false

failOnFrozen

Boolean

NO

true, false

refreshRights

Enum

NO

Allows to choose the refresh mode of Role Assignments on an Identity, according to the configured Role Assignment Policies.

3 values are available:

• OFF: when modifying an Attribute, there is never a compute.

• FORCE: when modifying an Attribute, there is always a compute.

• AUTO: 

  • If the modified Attribute is configured in the Policy, there is a compute.

  • If the modified Attribute is not configured in the Policy, there is no compute.

Available on update and create Feature.

OFF, FORCE, AUTO

activationModes

-

NO

Allows to choose an activation mode for the enabled built-in attribute.

-

activationMode

Enum

NO

Used to indicate the activation mode.

AUTO, ADMIN

bypassValidation

Boolean

NO

Used to indicate if the update Feature is to be performed with a bypass of all validation rules or not.

true, false

bypassReferenceIntegrity

Boolean

NO

Used to indicate if the update Feature is to be performed with a bypass of the reference integrity checks or not.

true, false

type

Enum

YES

Used to the indicate operation type.

CREATE, READ, BULK,HUB, UI, SEARCH, UPDATE, CHANGE_PASSWORD

workflowStrategy

FeatureWorkflowStrategy

NO

Used to provide the id of a workflow that will be launched when the feature is validated.

• NoneFeatureWorkflowStrategy (no workflow will be triggered)

<workflowStrategy xsi:type="ctdbum:NoneFeatureWorkflowStrategy">
</workflowStrategy>

• FixedFeatureWorkflowStrategy (a constant workflow will be triggered)

<workflowStrategy xsi:type="ctdbum:FixedFeatureWorkflowStrategy">
   <workflowId>myWorkflowId</workflowId>
</workflowStrategy>

• ScriptFeatureWorkflowStrategy (conditional logic can be used with the operation patch and subject contexts to determine a workflow)

<workflowStrategy xsi:type="ctdbum:ScriptFeatureWorkflowStrategy">
   <ruleDefinition>
	  <script><![CDATA[
	
		LOG.info('Original object: ' + OPERATION.originalObject.toString());
		LOG.info('Requester: ' + ACTORS.requester.id);
		LOG.info('Feature patch' + OPERATION.objectPatch.toString());
		
		return "myWorkflowId";
		
		]]></script>
   </ruleDefinition>
</workflowStrategy>

deduplication

DEDUPLICATION

YES

initialization

CREATE, DEDUPLICATION

NO

scheduling

UPDATE

NO

formLabelOnTop

ALL

NO

immediateExecution

CREATE, UPDATE

NO

completionRedirectURL

CREATE, UPDATE

NO , but advised

rawUpdate

RAW_UPDATE

YES

pendingOperationBehavior

CREATE, UPDATE, RAW_UPDATE (if a Workflow is configured on it)

NO

submit

CREATE, UPDATE, RAW_UPDATE

NO

forceCreation

Boolean

YES

Used to indicate if the user can create the Object even if a duplicate was found. In this case, a "Create anyway" button is displayed.

Note that this will just result in allowing the user to navigate to a CREATE Feature and ask the deduplication process to be ignored. By default the deduplication will be ignored but one can forbid it on the OPERATION configuration of type CREATE by specifying a "bypassDeduplication" flag to false in its requestOptions.

true, false

allowSiblingCreation

Boolean

YES

Used to indicate if the user can create a sibling if a duplicate was found.
In that case, an "Add as sibling" button is displayed (only if an Object is selected).

true, false

columns

-

YES

Used to display the configured Attributes when a duplicate is found.

If you do not configure a column, the default value is created. You must add <dataKey> and <type> values in order to specify which Attribute(s) will be displayed.

-

updateFeature

String

YES

Used to indicate the id of the update Feature to redirect the user if the chosen option is “Update”.

-

createFeature

String

YES

Used to indicate the id of the create Feature to redirect the user if the chosen option is “Add as sibling” or “Create anyway”.

-

Property name

Type

Mandatory

Description

attributes

-

NO

Allows to declare the values of the Attributes that will be initialized (can only be used for static values).

entry

-

NO

Allows to declare the value of the Attribute.

key

String

NO

Used to indicate the id of the Attribute.

value

String

NO

Used to indicate the static initialization value.

The value must be compatible with the value type of the Attribute (Boolean, String, Integer...)

initRule

Groovy script

NO

Allows to configure an initialization rule of type COMPUTE to execute for initializing the value of the Attributes (should only be used if dynamic values are required).
This rule must return an Api Object containing all Attribute values to be initialized in the model.

In this case, the status "ACTIVE" was created automatically when an Objet was created.
The user can check this in the execution preview.

<options>     
	<initialization>
		<attributes>
			<entry>
				<key>status</key>
				<value> xsi:type="xs:string">ACTIVE</value>
			</entry>
        </attributes>
    </initialization>
</options>

In this case, the status "ACTIVE" was created automatically when an Objet was created.
The user can check this in the execution preview.

<options>         
	<initialization>
    	<initRule type="COMPUTE" category="OBJECT" engineType="GROOVY">
			<script><![CDATA[import java.time.temporal.ChronoUnit
                    final def attributes = []					
					attributes.add(AttributeValue.from("status", "NORMAL"))
					attributes.add(AttributeValue.from("authMethodPasswordFrom", Instant.now()))
					new ApiObject(attributes)
			]]></script>
		</initRule>
	</initialization>
</options>

maxDurationDays

Integer

NO

Used to limit the choice of the planned execution date.

For example: maxDurationDays = 20

• the user updates the Object on 09.20.2021.

• then the user will not be able to schedule the execution later than 10.10.2021

By default, the execution time is equal to the update time.

The execution is pending and the new value of Attribute will be displayed at the date and time defined by the user.

0, 1, 2, 3...

schedulable

Boolean

NO

Used to indicate if the Feature can be scheduled or not.

By default, the execution time is equal to the update time.

If the Feature is schedulable:

• a calendar is displayed and allows to select a date respecting the configured condition (if any).

• a warning icon is displayed next to the updated Attribute(s) in order to inform that the scheduled operation is pending.

• the value of Attribute(s) will be updated when the configured date is reached.

true, false

formLabelOnTop

Boolean

NO

Used to define where the label of the Attributes will be displayed on the whole Feature.

If false, the label of the Attributes are displayed at the left of the value.
If true, the label of the Attributes are displayed
above the value.

true, false

displayChanges

Boolean

NO

Allows to display changes after the execution.

true, false

attributePatches

-

NO

Allows to list Attribute patches to be performed by the Feature action.

-

patch

-

NO

Allows to list Attribute patches to be performed by the Feature action.

-

id

String

NO

Used to indicate the id of the Attribute.

-

values

-

NO

Allows to configure values of the Attributes patches.

-

multiValuedState

String

NO

Used to indicate the static execution value.

The value must be compatible with the value type of the Attribute (Boolean, String, Integer...)

UNKNOWN, MONO

origin

String

NO

INTERNAL, EXTERNAL

operation

String

NO

ADD, DELETE, REMOVE, SET

executionRule

Groovy script

NO

Allows to configure an execution rule.
Use if the execution is more complex than just setting a value on an Attribute.

-

completionRedirectURL

String

NO

Used to indicate the id of the Feature to redirect.

The link can use the feature:// scheme to validate access to the feature.

Alternatively, if one requires to redirect to a user task the task:// scheme can be used.

• task://to-approve/<taskInstanceId>

• task://about-me/<operationId>

• task://submitted-by-me/<operationId>

• task://admin/<operationId>

excludeAttributes

List<Attributes>

NO

Allows to define attributes excluded from the feature.

-

excludeSecretAttributes

Boolean

NO

Allows to define if secret attributes are excluded or not from the feature.

true, false

layout

Enum

NO

Allows to define the graphical layout of the Feature.

SINGLE, TWO_EQUAL, TWO_LEFT_SMALL, TWO_RIGHT_SMALL, THREE_EQUAL, THREE_RIGHT_LEFT_SMALL

searchField

Boolean

NO

Allows to display or not the search bar.

true, false

pendingOperationBehaviour

String

NO

Used to choose the action that the user will be able to perform once a Workflow has been triggered.

FORBID: the value of the Attribute cannot be modified (the field is grayed out) and the user is informed by a warning icon that a Workflow is already in progress.

DO_NOTHING: the value of the Attribute can be modified and the user is not informed that a Workflow is already in progress. If the user changes the Attribute's value, a new Workflow will be triggered.

WARN: the value of the Attribute can be modified and the user is informed by a warning icon that a Workflow is already in progress. If the user changes the Attribute's value, a new Workflow will be triggered.

The warning icon is displayed next to the value of the Attribute and the warning text is visible by the user when the mouse passes over it.

FORBID, DO_NOTHING, WARN

reportDisplay

String

NO

Used to choose the display of the confirmation pop-up.

DISPLAY_ALL: Execution preview and execution successful confirmation pop-ups are displayed.

RESULTS_ONLY: Only execution successful confirmation pop-up is displayed.

HIDE_ALL: Neither execution preview nor execution successful confirmation pop-ups are displayed.
Only a small confirmation pop-up is displayed.

For the ​​"RESULTS_ONLY" and 'HIDE_ALL ", the user will be able to view the pop-ups by clicking on the "..." button next to the "Create" or "Update" button.

DISPLAY_ALL, RESULTS_ONLY, HIDE_ALL

authenticationLevel

String

NO

Allows to define the authentication level to access Features.
The possible values ​​come from the configuration of the BUM setting.

It is mandatory to configure the following setting: authentication.levels.mapping before to configure tag.

-

authenticationLevelComparison

Enum

NO

The comparison used to indicate which Authentication Level is accessible, in association with the <authenticationLevel> property.

BETTER: the authentication level(s) above the one defined is/are taken into account.

EXACT: only the configured authentication level is valid.

MINIMUM: higher levels of authentication are also taken into account.

BETTER, EXACT, MINIMUM

authenticationLevelForceGracePeriod

Duration

NO

Allows to force authentication at a specific frequency.

Java data time : PnDTnHnMn.nS
Example: PT20M

Step 1: configure the BUM setting.

Step 2: define the authentication on Feature.

operationOnSelf

Boolean

NO

Allows you to configure a Feature for "self" usage.

true, false

color

String

NO

Allows to define the color of the homeTile.

For available colors, see Metronic Color Library

icon

String

NO

Allows to define the icon that will be displayed inside the homeTile.

Link to find the icons : https://fontawesome.com/v4.7.0/icons/

fa-fa-star

url

String

NO

Used to indicate the website url for redirection when you click on the icon.

-

feature

String

NO

Used to indicate the id of the Feature to redirect when you click on the icon.

-

id

String

YES

Used to indicate the tile id.

-

label

String

NO

Allows to configure the text that will be displayed below the icon.

-