WORKFLOW

Update object property

Use an Update object property object to change or delete the content of a property on the object specified in the Event rule when the Event rule occurs. E.g. if the Event rule is defined to find red KPIs you may want to change the icon on those KPIs.

Configuring an Update object property object

Create an Update object property object by right clicking an Event schedule or Follow-up schedule and choosing Add -> Action -> Update object property.

Properties

General

Name - the name of the object "Update object property" is generated automatically but it may be changed
Description - an optional text describing the object

Configuration

Property - the property that should be changed. Only properties that are relevant for the specified object, and may be changed, will be available in the list. Enter the property you want in the field, or click on the icon to the right to bring up a new panel where you can select the context variables to include.
Value function type - the type of function that should be used to calculate the value; click the icon on the right to open the editor/calculator
Token value/Function - the heading and content of this field changes depending on what you select in Value function type:
- Token string - use text combined with token tags to refer to other properties

To insert only text, choose "Token string" in Value function type and enter your text directly in the Token value field.

- Function - find the value by using a function that you create in the calculator
- Date function - use the date calculator to create an expression that results in a date

To use "Now" as the date property, i.e. the exact time when the property is updated, leave the Function field blank. As an alternative, you can enter - or +1mi, which will give the time one minute before or after the property is updated.

Example 1:

To update a custom property called 'Version number' on all KPIs,

- - Create the custom numeric property in Property settings, give it ID "versno", and copy it to KPI in Type management
  - Configure your Update object property object like this:
    - select the custom property ${this.object.versno} in the Property field
    - select 'Function' in Value function type
    - add ${this.object.versno}+1 in Function

Example 2:

Similarly, to update a custom date property called 'Date stamp'

Create a custom date property in Property settings, give it ID "datest", and copy it to KPI in Type management
Configure the Update object property object like this:
- select the custom date property ${this.object.datest} in the Property field
- select 'Date function' in Value function type
- leave Function empty to set the custom date property to the exact time when the when it is updated or select the desired function for the time stamp in the date calculator

When updating a Status or Trend property, the value you enter in Value is a relative value (relvalue):

- Manual status: 0-1 = red
- Manual status: 1-2 = yellow
- Manual status: 2-3 = green
- Any value below 0 will give red, and any value above 3 will give green

Update date, relative to parent schedule - in which period the property should be updated. This only applies to historical properties. E.g. if the parent schedule of this update action was run in November and the value of this field is "-1M", the selected historical property will be updated in the previous month, i.e. October. If the Update date is empty the property will be updated based on runtime of parent schedule.

If the Update object property object is under an Event rule, this date is calculated relative to the Event rule date. If the Update object property object is under an Action group, then this date is calculated relative to the date selected on the web, i.e. the context date when the update takes place.

Audit

Modified by - the name of the last user to make changes to the object.
Last modified - the date and time when the object was last changed.
Created by - the name of the user who created the object.
Created - the date and time when the object was created.

Modified by for objects that are updated via Update object property and Created by for objects added via Add object will be the user specified in Run as.

You may want objects that are added or updated by Workflow to be marked as such. You can do this by creating a separate Workflow user in Users and Groups, and giving it Workflow access. Then select that user in Run as.

Advanced

ID - a unique ID for the object.

By default, Corporater BMP assigns consecutive numbers to new objects.

You can change the ID to a value of choice that can include either letters or letter and number combinations.

The ID mustn't contain only numbers, include special characters such as ) ( . * } { + < > [ ], or match the name of a default object type in Corporater BMP.

Access control

Read accessors - click the Edit button () and authorize one or more users and user groups to view the object on Web.
Add accessors - click the Edit button() and authorize one or more users and user groups to add new objects to the object on Web.
Write accessors - click the Edit button() and authorize one or more users and user groups to edit the object on Web.
Delete accessors - click the Edit button() and authorize one or more users and user groups to delete the object on Web.
Ownership - click the Edit button () and grant ownership of the object to one or more users and user groups.

Users and user groups who own the object have full access rights to it.
Override access profile - select for the object's access control setting to outrank the object's corresponding access settings in profiles.