Skip to main content
Version: 1.8.0

Customize State Model

tip

Role required: admin. If you are a project leader and do not have this role, contact the administrator of your instance with the request to customize state models. Users with the pda_user and pda_admin roles can only view state models and transitions.

You can modify the state models of the first, second, and third-level tasks, as well as create your own state models to better suit your development process.

warning

When making a decision to modify a state model, take the following into account:

  • There must always be a transition into the state with the highest Order in the state models of all task types. Only the tasks in these states are considered completed when publishing a release.
  • If more than one state model suits a task by Table and Condition, the system behavior may differ on the task form and the project board. The system does not include the option to configure the order of state models in this case.
  • The "out-of-the-box" application includes an inactive state model for the SDLC Task (pda_backlog_item) table. Do not activate it or specify on the forms of task types and state models in projects. The use of this model will cause errors.
  • Do not change state models' Condition manually.

To customize a state model, complete the following steps:

  1. Create required options for the State field
  2. Configure transitions between the model's states
  3. Configure state models
  4. Configure columns

Create choice options​

warning

Before creating choice options, ensure that the SDLC application is selected in the Admin Preferences of the sidebar.

To create choice options for a new state, complete the following steps:

  1. Navigate to System Settings → All Tables.

  2. Find the Task (task) table and open its form.

  3. Go to the Related Lists area and open the Columns tab.

  4. Find the State (state) column and open its form.

  5. Go to the Related Lists area and open the Choice tab.

  6. Click New and fill in the fields:

    FieldDescription
    TableSelect a child table of the SDLC Task (pda_backlog_item) table depending on the state model you need to modify.
    TitleSpecify the state title. It is recommended to make it unique for the selected Table.
    Language

    Specify the language for which the option is created:

    • ru for Russian
    • en for English
    ValueSpecify the value that will be used in the system logic. Use latin letters and digits. The value must not match any of the "out-of-the-box" states. It is recommended to make the value unique for the selected Table. The Value is case-sensitive, so avoid creating choice options with identical values spelled in different cases.
    OrderEnter a number to determine the position of the new state in the drop-down list relative to the existing states. The states are sorted in ascending order. It is recommended to assign order with an increment of 10 for an option in the middle of the list, and 100 for an option in the end of the list. The order of choice options also defines the order of the columns initially created for a new board: the higher is the order, the more to the right a column is located. You can change the order of the columns after the initial creation.

  7. Click Save or Save and exit to apply the changes.

  8. If necessary, repeat steps 6–7 for all languages used in the system. As a result, each state should have a choice option for each language that only differ by the Title and Language field values.

  9. (optional) To have the tasks in the new state highlighted with a color in the lists, create a corresponding style rule.

  10. Open the forms of the boards for which the state is relevant to synchronize columns. The Order of each new column added to the board after the initial column creation is calculated as The highest order among existing columns + 100, so the new state's column will be the last by default. It will also be inactive by default. To display the column on the board, configure it.

tip

Read the Choice Fields article to learn more about creating choice options.

Delete custom state​

If you need to delete a custom state choice option:

  1. Delete the choice options with the Value corresponding to the state on all languages. You can do it from the Choice related list on the form of the State column of the Task (task) table.
  2. Check if there are state transitions from or to the deleted state. To do so, navigate to State Flow Designer → State Transitions and filter the list to find the transitions from and to the deleted state. If you find such records, delete or edit them.
  3. Open the forms of the boards for which the state is relevant to synchronize columns.

Configure state transitions​

To configure the transitions between states, complete the following steps:

  1. Navigate to State Flow Designer → State Models.

  2. Find the state model record for which you need to configure transitions and open its form.

    info

    The application contains default state models for all "out-of-the-box" task types. Their names are generated according to the following template: Default {Task type name}. When a custom task type is created, a default state model is automatically created for it as well. Its name is generated according to the same template.

  3. Go to the Related Lists area and open the State Transition tab.

  4. Create incoming transitions:

    1. Click the title of the state, from which you need to make available the transition into the new state.
    2. Add the new state into the Available transitions field and click Save.

  5. Return to the state model form and, if necessary, repeat step 4 for all incoming transitions.

  6. Create outgoing transitions:

    1. Click New in the State Transition related list.
    2. Specify the new state in the State field.
    3. Add all states, into which you need to make available the transition from the new state, in the Available transitions field.
    4. Click Save.

Do not create duplicate transitions for the same state model.

tip

Read the State Flow Designer article to learn more about configuring state models.

Configure state models​

When a task type is added to a project, the state model specified on the State Models in Project form is applied to it. If there is no state model in project record for a task type, in this project:

  • On the board: all state transitions are allowed for this task type.
  • On the task form: if there is a suitable state model for this task type, it is applied. If there is no such state model, all transitions are allowed.

Read more about it in the State Models in Projects article.

For tasks that do not belong to projects, a State model specified on the Task type form is applied. To change the state model applied to tasks of a specific type that do not belong to a project, complele the following steps:

  1. Navigate to SDLC → General Settings → Task Types and open the form of a task type for which you need to change the state model.

  2. Specify a new model in the State model field. In this field, you can only specify a state model that meets both of the following conditions:

    • The state model Condition has a part "Project is empty" separated from the other parts of the condition with the OR operator;
    • The Table of the state model matches the table the State options of which are applied for the task type. This must be the task type table. Do not specify the SDLC Task (pda_backlog_item) table in this field, if you configure a state model for its child table: this will result in errors.

  3. Click Save or Save and exit.

tip

Detailed information about the creation of state models is avaialble in the State Models article. When you add a state model, do not change its Condition manually. The condition is updated automatically when the task type that utilizes the state model is added to a project.