Skip to main content

Lifecycle Configuration Guide

This guide explains how to configure a lifecycle from the admin application.

Configure a lifecycle​

  1. Sign in to the admin application with an administrator account.

    Admin sign-in screen

  2. Open Schema, then select Lifecycles. Click Create to open the lifecycle editor.

    Lifecycles list

  3. Enter the lifecycle details, including the lifecycle name, display name. Lifecycle versioning keeps a saved history of lifecycle changes, so existing records can continue to follow the lifecycle version they were created with while newer records use the latest published configuration.

    After creating or modifying a versioned lifecycle, administrators must Save and Publish the lifecycle before assigning it to a type or creating new instances. Publishing establishes the version that new instances will use, including its initial state.

    If a versioned lifecycle is modified after it has been published, administrators must republish the lifecycle for the changes to become the version used by newly created instances.

    To verify the configuration, create a new instance through the documented creation flow and confirm that it uses the expected published lifecycle version or the initial state.

    Lifecycle details

  4. After creating the lifecycle successfully, a default state is added as State. Click the edit/pencil icon to change the name.

    Default State

  5. Enter New as the name and display name for the state. Keep the background color unchanged. Enable Show Promote Reminder if required, then click Save.

    Starting state selection

  6. Add the other states in the order users should understand the process. CLick on the Add State button.

    Adding states

  7. Enter Active as the name and Active as the display name. Change the background color to blue, then click Add. Adding states

  8. Similarly add all the states required.

    All States Added

  9. Configure state-wise permissions for viewing, editing, linking, unlinking, deleting, and promoting.

    Add Permissions

  10. In the Permissions tab, configure the expression column for permissions. Users can perform operations on an instance only when they have the role specified for the permission and the configured expression evaluates to true for that instance. Protrak expressions follow C# language syntax. For example, expressions can use the System.String, System.DateTime, and System.Math namespaces. Permissions

  11. Add a promote action for each state. In the Promote Action tab, click Create to add a new promote action. Promote Action

  12. Enter the promote action details. Add the name and display name, select the action type, choose the target state, and configure visibility or an access policy rule. If required, enable options such as mobile-scan-only promotion, version creation, asynchronous execution, or geofence-only promotion. Configure the promote comment mode, comment display label, and promote success message, then click Add. Promote Action

  13. After adding all the promote actions, project lifecycle looks as below. Project Lifecycle

  14. In the Attribute Access tab, configure which attributes are viewable and editable for the lifecycle. Select All to allow access to every attribute, or select Specific and choose the attributes that users can view or edit in this lifecycle state. Attribute Access

  15. Assign the lifecycle to a type from the Type Details tab.

  16. Validate the flow with users in each role, including blocked actions and required comments.

Notes​

  • Use clear state names that describe the record's status, such as Draft, In Review, Approved, or Completed.
  • Use promote action names that describe what the user does, such as Submit, Approve, Reject, or Complete.
  • Keep lifecycle permissions aligned with the business process so users can only perform the actions expected for their role and state.
  • Test the lifecycle after saving, especially role restrictions, required comments, commands, and terminal states.