Reference property

A Reference property can hold a reference to another object. You can configure which model and which object type(s) in that model users should be allowed to select. Multi-select can be chosen to enable multiple references to be selected in the same property.

 

This property replaces User reference property that was available in previous versions.

Reference properties are available in the rule configuration in Filtered lists and Workflow as well as in Template listings.

 We recommend that users make new Reference properties rather than change existing ones, in cases where they want to change or clear Reference properties.

Properties

General

• Name - the name "Reference property" is generated automatically, but we recommend giving the property a different name

• Description - an optional text describing the property

Configuration

• Category - the category in the object's configuration in which the property should be placed.

   Change the property's placement in the configuration dialog by changing this value. Default is "General". E.g. by changing the value to "Configuration" the property will be grouped with the other properties under Configuration.

• Overridden column name in tables - an alternative, shorter property name to be used in column headings.

   If this property has a value, it will use this as the column header in tables

  Name changes made here will not affect Reporter token tags for the property.

• Display in tables as - how the property should be displayed in the table when there isn't enough room

   Properties that are never shown in tables or that cannot be truncated or wrapped, such as dates, statuses, icons, numbers, and progress, do not have this option. They will always be shown in full text.

  • Full text - the text shows in its full length on a single line

  • Wrapped - the text shows in multiple lines if there is not enough space on one line

  • Truncated - the text is cut off with '...' if there is not enough space to show the full text. Full text is shown on mouse over.

• Allow blank - allows the reference to be empty

• Multi select - allows selection of multiple references, to create a list with more than one reference.

• Advanced - select to configure the reference property based on the results of an extended expression.

• Expression - applies only if you select Advanced. Enter the extended expression. 
   Corporater BMP requires the syntax to be correct. To check it, click the Extended Interface quick access button () and verify the expression in the Extended Interface. 
  In executing the expression, Corporater BMP retrieves all objects that match the query, regardless of their visibility settings and time scope. Hence, construct your expression to accommodate potential object start and end date parameters. 
  lf the expression references users, you can configure it to target users who belong to a specific user group or are the responsibles for a specific object.

• Root references - an expression that indicates what subtrees should be shown and selectable. Click the icon to the right to open an editor that suggests relative and absolute reference tags that are commonly used when making Reference properties. The tags used here must return a business object or a list of business objects.

  When you expand +this +object in Root references, you will see that scorecard, perspective and strategicObjective are in both singular and plural forms. By using the singular form, you look up in the tree from the current object (this.object), i.e. only one object. If you select the plural form you look down the tree from the current object, i.e. potentially more than one object.

  Example:

  On a KPI use ${this.object.perspective}; on a scorecard use ${this.object.perspectives}

• Filtered - turns on/off the filter configuration; the filter is configured in the same way as in a Filtered list

• Types - choose the object types it will be possible to select.

   The list contains all the object types in the system. Some object types may not be relevant for the Reference tag(s) selected in Root references. The object type(s) is not automatically changed if Root references is changed.

  To find a specific object type, place the cursor in the white area and start typing its name, e.g. to find "KPI" just type "k".

  Either the Filter or Types can be used, so when Filtered is selected Types is deactivated.

• Display selector as - select how the reference property displays on Web.

  • Flat list - as a single-level list.

  • Tree - available only if Advanced is deselected. As a multi-level, hierarchical list.

  • Search-only - as a search field.

• Hide icons - select for Corporater BMP to display each item with no corresponding icon in the reference property on Web.
   lf the items are root.portal items, they display with no corresponding icons by default. 
  lf the value for Display selector as is 'Tree' or 'Search only' and the items are business model objects, they display with corresponding icons by default. 

• Sorting - the sorting type for the referenced items. Based on the value that you select, when a user edits the reference property on Web, the items display in the drop-down list for the property as follows:

  • Alphabetical - in alphabetical order.
     lf the referenced items are user names, they display in alphabetical order based on Last name values. 

  • By index - in the order in which they display in Configuration Studio.
     This applies only if the items are of the same object type or belong to the same parent object. 
     lf the value for Display selector as is 'Tree', the items display by index by default. 

  • None - in no specific order.
     lf you selected Advanced and entered an extended expression, the items display in the order of the results of the extended expression. 
    lf the expression too includes a. sort() method, the items display in the order of the method. 

Features

• Features - select how the object should appear on the web:

  • Visible

  • Not visible

  • Visible when value

Web editability

• Editable on web - whether users who are not administrators should have access to edit the property on the web page; choose between

  • Restricted - the property will not be visible for non-administrators

  • Unrestricted - the property can be edited by users who are not administrators

   Users who are to be able to edit properties on the web page must be given Property access in addition to Web access in Users and Groups, and they must also be mapped with the Full access profile to the scorecard where the objects they should be able to edit are located.

Information

• Information - enter helpful text for users who view the object that includes this property on Web. For example, a note on how to input data in that property field for the object.

  Click the Lookup () icon and enter the text.

   The property supports both plain and rich text.

   For Corporater BMP to display text that's specific to the object, add a text property to the object and then include a tag that references that property in the Information property. For example, a myInfo property and a ${this.object.myInfo} tag in Information.

   Corporater BMP attaches an Info icon to the property on Web. The icon is visible for the property as follows:

  When a user clicks the icon, your text displays in a collapsible Info section.

  • On the Edit page for the object that includes the property.

  • On the Add page for the object that includes the property.

  • In the inline editing mode of a description view for the object that includes the property.

  When a user clicks the icon, your text displays in a collapsible Info section.

• Linked to - available only after you paste link the property to an object type. The name of the original property type, as listed in the Property settings panel.

Version 5.1.2.0

This document contains confidential information. Not to be copied by third parties without written authorization.

© Copyright Corporater AS - All rights reserved.