ActionTypes

String

Mandatory

Comma-separated list of section names for action types. The order in which the names are on the list is the order they are listed in the action editor in QPR Portal.

DatabaseId

Integer

Mandatory

Database ID for the action type. If you are modifying an existing action type, do not change the ID. If you are creating a new action type, the number for the database ID has to be 10000 or bigger. Database IDs must be unique so do not give the same ID to two action types.

The database IDs of the standard action types are as follows:

•Comment: 1

•Lesson: 2

•Action plan: 3

•Document: 4

•Folder: 5

•Risk: 14

•Strategy Item: 15

Name

String

Mandatory

Name of the action.

PluralName

String

Mandatory

Name of the action in plural.

Attributes

String

Optional

Comma-separated list of action section names for attributes.

Hidden

Integer

Optional

If the value is 1, all existing actions of this type are hidden and new actions of this type cannot be created. If the value is 0 (or the parameter does not exist), the actions are visible and you can create new actions of this type.

DoNotLocalize

Integer

Optional

Defines whether the name of the action is translated in the language of the UI. If the value is 1, the name will not be localized. If the value is 0, the name will be localized if a translation exists in the dictionary. If the translation cannot be found, the original name is used.

DefaultHeader

String

Optional

Default header text to be used.

DefaultDescription

String

Optional

Default description text to be used.

DefaultPublishType

Integer

Optional

Defines the persons the action is published to. The following values are supported:

•0 = Me only: publishes the action only to the person who created it.

•1 = Users of linked elements: publishes the action to users who have authorization to an element the action is linked to.

•2 = Selected users: publishes the action to a certain group of users only.

•3 = Everyone: publishes the action to every user

EnableChangeLog

Integer

Optional

Defines whether the change log is enabled for the action type. 0 = disabled, 1 = enabled (default). Note that this setting controls the change log of only a specific action type. For change logs to be in use at all, they must be enabled using the EnableActionChangeLog key in QPR_Servers.ini.

HasSymbol

Integer

Optional

Defines whether the action type has the 'symbol' attribute. 0 = action type does not have the symbol attribute, 1 = action type has the symbol attribute.

DatabaseId

Integer

Mandatory

Database ID for the attribute. Database IDs must be unique so do not give the same ID to two attributes. However, different action types can use the same attribute definitions.

Label

String

Mandatory

Label of the attribute.

Type

String

Mandatory

Attribute type. The following types are supported:

•Integer

•Boolean

•Float

•Percentage

•String

•MultiLineString

•OptionString

•DateTime

•Date

•Time

•Period

•Users

•User

•EmbeddedFile (used to store any kind of a file inside the attribute)

Note: If the attribute type is OptionString, then the action attribute section must also list all the available optional values in the following format:

Option_<sequence number starting from 1>=<value>

Example:

Option_1=Draft

Option_2=Proposed

Option_3=Under modification

Option_4=Waiting for approval

Option_5=Approved

Option_6=Archived

DefaultValue

String

Optional

String representation of the default value.

Group

String

Optional

Group the attribute belongs to. The group determines where the action attribute is positioned in action editor and details views in QPR Portal. You can customize the positioning by defining parameters in the [<Group #1...>] section.

ValueChangeEvent

String

Optional

Defines the name of the callback event that is triggered by QPR Web Services Foundation when the attribute value is changed. If this is left unspecified, change events will not be triggered for the attribute.

CausesResponsibility

Integer

Optional

This attribute is valid only for action attributes of the user type. If the value is 1, all users listed in the attribute value are responsible for the action.

This means that these users receive, for example, email notifications of the action and the action is visible in the My Responsibilities view of these users in QPR Portal.

ActionOwner

Integer

Optional

This attribute is valid only for action attributes of the user type. If the value is 1, the user listed in the attribute value is the owner of the action. This means that the user will always have update rights for the action even if the user would otherwise have only view rights, provided that the user's license allows such an operation. For example, this setting does not provide update rights to a user with only a Viewer license. Note that only one attribute with this value set to 1 is allowed per action type. If more than one is discovered, only the first entry is used and others are ignored.

DoNotLocalize

Integer

Optional

Defines whether the attribute name is translated in the language of the UI. If the value is 1, the name will not  be localized. If the value is 0, the name will be localized if a translation exists in the dictionary. If the translation cannot be found, the original name is used.

Mandatory

Integer

Optional

Defines whether the attribute must be given a value before the action can be saved. If the value is 1, entering a value for the attribute is mandatory. If the value is 0 (default), entering a value for the attribute is not mandatory. This setting is applicable only to String, MultiLineString, User, and number fields. Attributes that must be given a value are shown with an asterisk after their name in QPR Portal.

WriteOnce

Integer

Optional

Defines whether the value of the attribute can be set only when created, i.e. the attribute's value cannot be modified afterwards by anyone. If the value is 1, the value of the attribute can be set only when the action is created and it cannot be edited once the action is saved. If the value is 0, the value of the attribute can be edited even after the action is saved.

CopyAtReply

Integer

Optional

Defines whether the action attribute value is copied from the immediate parent action when creating a reply. If the value is 0 (default), the value of the immediate parent action is not copied. If the value is 1, the value of the immediate parent action is copied.

StringDictionary

String

Optional

Can be used to add any number of key/value string pairs into a single attribute. Any single value can be accessed by giving the key as sub attribute for the attribute name (for example, status.previousresult). The key must always be a valid script name.

LayoutPosition

String

Optional

The name of the layout group in the template used for this attribute group. The value is case sensitive. Default value is Left.

OrderNumber

Integer

Optional

Defines the attribute group order in the layout position group. If inappropriate value is given, the order is last.

GroupHeader

String

Optional

Defines the translated header text. For more information on customized translations see the Customizing Terminology in QPR Applications topic.

[UMS Document Status Options]

[DocumentStatus]

[UMS Initiative Status Options]

[ActionPlanStatus]

[UMS Comment Category Options]

[CommentCategory]

[UMS Action Plan Category Options]

[ActionPlanCategory]

[UMS Lesson Category Options]

[LessonCategory]

[UMS Document Category Options]

[DocumentCategory]

[UMS Risk Category Options]

[RiskCategory]

[UMS Risk Status Options]

[RiskStatus]

[UMS Risk Severity Options]

[Severity]

[UMS Strategy Item Category Options]

[StrategyItemCategory]

[UMS Strategy Item Status Options]

[StrategyItemStatus]