A Procedure is a group of Versions. The Version is the electronic document that details the Procedure.
This document provide details on:
- What is a Procedure and Procedure Version?
- Structure of Content in a Procedure
- Creating a Procedure
- Creating first Version of Procedure
- Building Template for Procedure Version
What is a Procedure and Procedure Version?
The procedure was architected to support versions natively. While you may only have one version of your standardized operating procedure now, with time you may need to make changes to it. Versions allow you to make a new version of the procedure without releasing it for your team to run as an instances until you are ready to do so.
The diagram below illustrates how a Procedure can have one or more Versions. The Version is the document of the process for the procedure. Then a Version of a Procedure can be run which creates an Instance. The Instance is where your teams conduct the Procedure as outlined in the Version that is currently Active. Multiple Instances of a Version can be run independently.
Structure of Content in a Procedure
The contents for a Procedure are documented in a Version. To help you understand the structure of the content documented in a Version, we have created the diagram below.
A Version will have at least one Group. The group is illustrated in the diagram as the outer box. A Group has a name. There is an option for a Description to be specified for each Group as well.
The Group then contains a table that consists of Columns and Rows. The combination of a Column and Row creates a Cell. Depending on the type of the Column, a value for a cell is editable or only viewable. We explain when a value for a cell is editable vs viewable in the following section.
The table in the Group can contain one or more Columns. We have created various types of columns to create provide specific user experiences to make creating Procedures and running them as Instances both user-friendly and powerful. The name for each Column can be specified.
The table can contain one or more Rows. Based on the type of the Column, the corresponding Cell in each row functions accordingly. Learn more about: Column Types for Versions.
Creating a Procedure
You can create a Procedure via one of two ways. The first method is by clicking the New button in the left Navigation. This allows you to create a new Procedure or a New Folder.
The other option to create a Procedure is from the main Procedures page. To the right of the page title, click the button for Create Procedure.
The first option, opens the model as shown in the example below. In this modal you can name your procedure. If you want to organize the procedure in a folder, you can select the folder as well.
Then click the button to Create Procedure.
The new Procedure will be created and you will be redirected to its view page. At this point, the procedure does not have a Version that documents the details for the process or workflow.
Creating first Version of Procedure
Once you have created a Procedure, you can create the first Version of the Procedure that documents the workflow and/or process.
When viewing a Procedure in the header of the Versions panel, click the button to Create a version.
This will create a new Version for the Procedure. The name for the Version is automatically defined by using the name of the Procedure and appending a version number. Since it is the first version, the version is 1.0.
Learn more about Versioning Procedures.
Learn more about Version Numbering.
Building Template for Procedure Version
Now that you have a procedure with a procedure version, you will need to build the template for your procedure using our editor.