Creating & Managing Steps in a Procedure Template
- 07 Feb 2024
- 10 読む分
- 印刷する
- 闇光
Creating & Managing Steps in a Procedure Template
- 更新日 07 Feb 2024
- 10 読む分
- 印刷する
- 闇光
The content is currently unavailable in Ja - 日本語. You are viewing the default English version.
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Procedure authors use steps (also called augmented steps) to build out instructions for operators to follow during procedure execution.
Each step can include any or all of the following elements:
- Provide direction and visual guidance using Instructions and Technique Media.
- Build the elements of your process using Process Actions, such as inputs and actions.
- Confirm that each step has occurred using Signatures and Verification.
- Prepare for “what ifs” using Step Navigation.
This article is divided into two key topics:
PREREQUISITE:
Prior to completing the steps in any of the sections below, create or open the relevant draft procedure template in the Tempo web app.
NOTES:
- To edit a procedure template, it must be in the Draft stage.
- Only the user who created a procedure template and any users assigned as a procedure co-author can edit a procedure template.
Creating, editing, and deleting a step
A procedure template needs to have at least one step to convey directions, process actions, and more to an operator or scientist.
The initial process to add a step differs slightly depending on whether the procedure template is PDF-based or has been built entirely within Tempo, but the steps to edit and delete a step are the same.
- Adding a step to a PDF-based procedure template
- Adding a step to a procedure template built with List Builder
- Adding a step to a procedure template built with Visual Builder
- Editing a step
- Deleting a step
NOTE:
Once created, steps can be managed within sections. Sections allow for certain sections of a procedure to support parallel execution or for certain sections to require completion in a particular order. For more information about step sections in a procedure, review the Creating & Managing Step Sections article.
Adding a step to a PDF-based procedure template
To determine the placement of a step on uploaded document, click and drag to select the text that represents your step.
Next, create a step based on this text in one of two ways:
- Click the subtitles New Step icon to create a completely new step. To add information to the new step, follow the steps in theAdding or editing information in a step section of this article.
- Click the download Import Step icon to import one step at a time from an existing procedure template. Refer to the Best Practices: Managing an Imported Step in a Procedure Template article for full directions regarding this process as well as information about best practices and limitations in using this tool. Once the step has been imported, it can be edited by following the steps in the Adding or editing information in a step section of this article.
The new step displays in the Steps (Augmented Steps) panel on the right.
NOTES:
- When steps are added to a PDF-based procedure document, the order in which steps display is based on each step's text placement within the document from top to bottom, left to right.
- The system also renames steps that use the default naming system (Step #) if the step order changes.
- To change which words are associated with a step on an uploaded document, select more_vert More Options to the right of the step name, then select Move Annotation on PDF, then click and drag the edge of the highlighted area to update the associated words.
Adding a step to a procedure template built with List Builder
To add a step to a procedure that uses the List Builder within Tempo, create the step in one of two ways:
- Click Add Step to create a completely new step. To add information to the new step, follow the steps in the Adding or editing information in a step section of this article.
- Click Import Step to import one or more steps from an existing procedure template. Refer to the Best Practices: Managing an Imported Step in a Procedure Template article for full directions regarding this process as well as information about best practices and limitations in using this tool. Once the step has been imported, it can be edited by following the steps in the Adding or editing information in a step section of this article.
Adding a step to a procedure template built with Visual Builder
VERSION NOTE:
Visual Builder is available in Tempo v7.0.X and subsequent versions.
NOTE
Visual Builder does not support the Import Step feature.
Click Add Step to create a completely new step. To add information to the new step, follow the steps in the Adding or editing information in a step section of this article.
Editing a step
To edit a step, click the name of the step within the Steps (Augmented Steps) tab or section of the page. The step displays in the Steps (Augmented Steps) panel on the right. From here, you can make edits by following the detail in the Adding information to an augmented step section of this article.
Deleting a step
To delete a step, locate or click into a step, then select more_vert More Options > Delete Step. All information for that step will be immediately deleted.
Adding or editing information in a step
Once you have created a step, you can add or edit the information within the step by clicking the step name (PDF or List Builder) or the step name > edit Edit icon (Visual Builder). A step builder panel displays on the right side of the page.
Step header options
Step header options display above all tabs within the step builder.
| Name | Description |
|---|---|
| Step X of Y | The number of the step you are currently viewing and how many steps have been added. |
| < and > | Review the previous or next step. |
| more_vert More Options | Access additional options like Delete Step and Move Annotation on PDF (if applicable). |
| keyboard_tab Collapse | Minimize the step builder. (The step builder can be launched again by selecting a step name in the Augmented Steps section.) |
| Step Name | The name of the step. Click the current step name to edit the name of the step. |
VERSION NOTE:
In Tempo v7.0.X, an Add Step button displays in the step header as well, allowing the procedure template author to save changes and add a new step after the current step.
Step Summary tab
The step builder's Step Summary tab displays by default and includes a variety of options that can be managed for each augmented step. Procedure authors may add one or more of the following to a step, depending on the overall design and requirements of the procedure.
- Text and Audio Instructions
- Technique Media
- Process Actions, such as inputs and actions
- Signatures and Verification
- Step Navigation
Text and Audio Instructions & Technique Media
Instructions and technique media allow a procedure author to assist the operator or scientist in understanding what they are expected to do next.
- Text and Audio Instructions: Area dedicated to providing detailed instructions to your Operators on how to complete this step.
NOTES:
- The Mirror Text & Audio checkbox is checked by default. If the procedure author unchecks this checkbox, the procedure author can manage written and audio instructions separately using two different fields: Text Instruction and Audio Instruction.
- The volume_up Preview Audio icon allows the procedure author to preview the audio instructions.
- Although the instruction field permits limited formatting for procedure author convenience, it is a best practice to ensure that instruction meaning does not rely on text formatting.
- Technique Media: Include supporting images or videos, which can be uploaded from a computer or captured via the Tempo iOS app.
- To upload technique media from your computer, select Add (Add Technique Media) > Upload from Computer A file upload pop-up displays. Locate and select the image or video file you would like to upload, then click Open. The file uploads.
- To upload technique media captured within the Tempo iOS app, select Add (Add Technique Media) > Technique Media, then select the relevant image or video.
- To learn more about creating and uploading technique media using the Tempo iOS app, refer to the Adding Technique Media on the iOS app article.
NOTES:
- There is a 1 GB size limit on technique media.
- After technique media has uploaded, the procedure author can click the file to view and manage the technique media details, including viewing or updating the file name, adding a caption, downloading the file, or deleting the file.
Process Actions
Process actions allow a procedure author to build in any inputs, resource actions, formulas, linked procedures, or integration actions that are part of the procedure process.
The Process Actions (or Inputs and Actions) section(s) of the augmented step builder may have a different user interface display, depending upon the version of Tempo that your organization uses.
To learn how to create process actions, refer to the relevant articles for your release:
- Tempo v6.5
- Tempo v7.0
Signatures and Verification
The procedure author can determine how many signatures are required for this step.
- How many signatures are required on this step?: Choose whether zero (none), one, or two signatures are required to complete this step.
- Action Prompt Signature: Prompt for the first signature, if applicable.
- Require signer to be a member of the following group: Choose which group the first signer must be part of, if applicable.
- Action Prompt 2nd-Person Verification: Prompt for the second signature, if applicable.
- Require verifier to be a member of the following group: Choose which group the second signer must be part of, if applicable.
Complete all required information, then click Save Signatures.
NOTES:
- For procedure templates based on a PDF, once a signature requirement has been added, the procedure author has the option to select Add Output Field to place a signature field on the PDF. The system automatically places the signature field near the associated step. The signature field can be moved by selecting and then clicking and dragging the signature field to the desired location.
- Selecting Remove Output Field will remove the signature field from the PDF.
Step Navigation
The procedure author can determine conditions that would allow an operator to proceed to the next step. The procedure author can also determine what the operator should do if those conditions are not met.
The Add Step Navigation Conditions page allows the operator to build those conditions using if / then logic.
- If: Select a step input.
- Condition: Select the correct condition information to produce the acceptable value.
- Else: Determine what step the operator should go to if the previous condition is not met.
- Repeat Step: Check Repeat Step to allow this step to be repeated during execution, if appropriate.
Complete all required information, then click Add Step Navigation (or Save Step Navigation) to save.
Draft Comments tab
The step builder's Draft Comments tab allows the procedure author to leave comments for themselves or other authors during the process of creating the procedure template.
The procedure author may type a comment in the Add a Comment field, then click Add Comment to save the comment.
Once a comment has been added, it can be removed or edited by selecting more_vert More Options, then clicking Remove Comment or Edit Comment, as applicable.
NOTE:
The system removes comments when the procedure template advances to the next stage in the cycle.
Review tab
The step builder's Compare Versions (Review) tab allows for a review of revisions to the step since the last version, as well as the capture of a rationale to explain what changed between the current version and previous version.
The procedure author may type a rationale in the Rationale field, then click Add Rationale to save the rationale.
Once a rationale has been added, it can be removed or edited by selecting more_vert More Options, then clicking Remove Rationale or Edit Rationale, as applicable.
NOTE:
A rationale can only be added during the Draft stage. Once added, the rationale can be viewed when the procedure template version is in any stage.
Next steps
- To learn more about augmented step sections in a procedure, review the Creating & Managing Augmented Step Sections article.
- For content creators and others who wish to learn more about authoring and managing procedure templates, begin with the relevant article for your release:
- To learn more about executing and managing procedure runs, begin with the following article:
- For high-level information about packages that include this functionality, review one or more of the following articles: