Change requests
Change requests are used to track change within a standard or study through a predefined workflow. You can define as many change request templates as you want, each with their own properties and lifecycle states. Your workflow can be as simple or as complex as required.
Creating a change request template with properties and states can be carried out in the following order:
- Create template.
- Add workflow states.
- Set transitions for each workflow state.
- Set Initial state.
- Activate template.
Change request templates can be in one of three of the following states:
- Template ready for use
- Template requires activation. See Activating a template.
- Template invalid. See Making initial state. If the Workflow is invalid, see Adding a state to a change request template
Creating a change request template
To create a change request template:
- Select Admin from the Navigation bar and select Repository.
- Select the Change requests tab.
- Select Create template.
- Enter the Name and select the Context.
- Select Save.
Change request contexts:
None - Not related to specific standards, studies or assets
Standards - Related to specific standards
Studies - Related to specific studies
Standards and studies - Related to specific standards and studies
Standard assets - Related to specific assets within a standard
Study assets - Related to specific assets within a study
Standard and study assets - Related to specific assets within a standard or study
Editing a template
To edit a change request template:
- Select Admin from the Navigation bar and select Repository.
- Select the Change requests tab.
- Select the options icon next to the change request template you want to edit and select Edit template.
- Edit the template as required.
- Select Update.
You cannot edit a template after it has been activated.
Cloning a template
To clone a change request template:
- Select Admin from the Navigation bar and select Repository.
- Select the Change request tab.
Select the options icon next to the change request template you want to clone and select Clone template. The cloned change request template appears in the list with (CLONE) after its name.
Activating a template
You can activate as many change request templates as you wish.
To activate a change request template:
- Select Admin from the Navigation bar and select Repository.
- Select the Change request tab.
- Select the options icon next to the change request template you want to activate and select Activate template.
- Select Activate.
You must set one of the states within a change request template to "initial state" or else that template is invalid.
Deleting a template
To delete a change request template:
- Select Admin from the Navigation bar and select Repository.
- Select the Change request tab.
- Select the options icon next to the change request template you want to delete and select Delete template.
- Select Delete.
You can delete a template after it has been activated but you cannot edit it.
Adding properties to change request templates
You can define properties for change requests.
The types of custom properties are:
- Text
- Note
- Number
- Date Time
- Select - use this to add a number of options to a custom property, for example, situations where a choice or multiple answers are applicable.
You can add a custom property if the change request template has not been activated.
To add a custom property:
- Select Admin from the Navigation bar and select Repository.
- Select the Change request tab.
- Select the options icon next to Properties and select Add.
- Enter the Name and select Type from the dropdown list.
- (Optional) Select the Mandatory check box to make the property mandatory.
- Select Save.
Custom property - Select available options
You can include a property that has a number of options to pick from. You can allow users to choose one option for selection or allow multiple options to be selected.
To do this:
- Enter the Name and select Type = Select from the dropdown list.
- (Optional) Select the Mandatory check box to make the property mandatory.
- (Optional) Enter an Available option and press return on your keyboard. Repeat this step until you have entered all the available options required.
- (Optional) Select Multiselect so that more than one option can be selected.
To remove available options:
- Select the delete icon next to the available option you wish to remove.
To edit a custom property:
Select the edit icon next to the custom property you want to edit.
- (Optional) You can update the Name and Type.
- Select if the custom property is to be Mandatory.
- Select Save.
To remove a custom property:
- Select the delete icon next to the custom property you wish to remove.
Filtering properties
You can filter properties for change requests:
To filter properties:
- Select the options icon next to Properties.
- Enter the properties you want to filter in the Filter properties text box.
To remove a filter:
- Select the cross icon next to the filter you wish to remove above the search results.
Adding a state to a change request template
You can define the workflow states for a change request template.
To add a state:
- Select Admin from the Navigation bar and select Repository.
- Select the Change request tab.
- Select the options icon next to Workflow and select Add.
- Enter the Name and select a Category.
- (Optional) Enter a label name into List of approvers and press return. This label can then be assigned to a user, see Transitioning the workflow. You can enter more than one label to assign approvers to.
- (Optional) Select Can transition to from the list. You may not be able to set "Can transition to" until all states have been added. If this is the case see Editing a state.
- Select Save.
If you add more than one approver, it will not be possible for the change request state to be transitioned until each approver has approved the change request.
Editing a state
You can edit a state for a workflow:
- Select Admin from the Navigation bar and select Repository.
- Select the Change request tab.
- Select the options icon next to Workflow.
- Select the options icon next to the workflow state you want to edit and select Edit state.
- (Mandatory) You can update the Name and Category.
- (Optional) You can enter labels for approvers, then select return on your keyboard. Examples of labels could be Quality Assurance, Test, Development etc. These can then be assigned to users in change requests. See Transitioning the workflow.
- (Optional) You can select which state or states this state can transition by selecting from the drop down list.
- (Optional) If you have added a label to the list of approvers, you can select the Requires approval check box. This means that approval must be granted before a transition to the next state is allowed.
- Select Update.
To remove a transition for a state:
- Select the trash icon next to the transition you want to delete.
Making initial state
You can set the initial state of the workflow in a change request template. You can add, edit and delete workflow states after the initial state has been set.
To set an initial state:
- Select the options icon next to Workflow.
- Select Make initial state.
If the initial state is not set, the change request template is invalid and cannot be activated.
Filtering states
You can filter states in the workflow.
To filter states:
- Select the options icon next to Workflow.
- Enter the states you want to filter in the Filter states text box.
To remove a filter:
- Select the cross icon next to the filter you wish to remove above the search results.
Deleting a state
To delete a state:
- Select Admin from the Navigation bar and select Repository.
- Select the Change request tab.
- Select the options icon next to the change request template you want to delete and select Delete template.
- Select Delete.