- 30 May 2023
- 10 Minutes to read
- Print
- DarkLight
Creating & Configuring a Batch Template & Unit Operations
- Updated on 30 May 2023
- 10 Minutes to read
- Print
- DarkLight
This article provides an introduction to creating a batch template. Once the batch template has been created in Tempo, batch authors can add unit operations and procedure templates, manage process parameters, and add documents. This article includes the following topics:
- Creating a new batch template
- Building & configuring a batch template
Creating a new batch template
Batch templates are made up of procedure templates composed into unit operations. Prior to creating a batch template, ensure that the relevant procedure templates for the batch have gone through review and approval and are in an Effective stage.
Follow the steps below to begin the process of creating a new batch template in the Tempo web application.
- Click cloud Tempo > Batches > Templates. The Batch Templates page displays.
- Click Create New Batch Template. The Create New Batch Template dialog displays.
- Select or enter the information in the required fields:
- Batch Template ID: The name of the batch template. Each batch template ID needs to be unique.
- Select or enter the information in the optional fields:
- Product Material(s): Select the materials that can be made using this template.
- Program: Programs are a tool for filtering templates. Select or add a program, if applicable to this batch template. (To add a program, click the field and begin typing, then click Create New Program.)
- Phase: Phases are a tool for filtering templates. Select or add a phase of the program, if applicable to this batch template. (To add a phase, click the field and begin typing, then click Create New.)
- Tags: Tags are a tool for filtering templates. If relevant, enter one or more tags for the batch template.
- Click Next. The Author Information dialog displays.
- (OPTIONAL) To assign additional users as batch authors, click the checkbox next to their name.
- When you are done selecting authors, click Next. The Configure Batch Template dialog displays.
- Review the batch template configuration settings. Enable or disable settings according to the needs of this batch template:
- Review an Approval is Required for This Batch Template (enabled by default): If enabled, the batch will be required to go through a review and approval process before it can be executed.
- Enforce Sequentiality (enabled by default): If enabled, users will be required to progress through every procedure and step in sequential order.
- Required documents must be uploaded to complete a batch run: If enabled, users will be required to upload any specified documents to the batch run before the batch run can be released.
- Allow using retired procedure template versions: If enabled, users will be able to start batch runs using this batch template even if it contains procedure templates in retired state.
- Enable PI Event Frame Generation (requires integration): If enabled, the batch will automatically create PI Event Frames with all Relevant Step Details in the target PI Integration. A PI integration must be configured before this setting can be activated.
- PI Integrations (requires integration): Select the relevant PI Integration.
- Click Create. The new batch template displays.
Building & configuring a batch template
Each draft batch template includes four tabs. Click any of the links below to skip to related content.
- Operations: Add and manage unit operations and their procedure templates.
- Process Parameters: View and modify process parameters from all procedure templates that are part of this batch template.
- PREREQUISITE: Add procedure templates that have parameters to unit operations on the Operations tab.
- Managing process parameters
- Documents: Add placeholders for any required documents that will be part of a batch run that uses this template, or add specific documents that will be relevant to all batch runs that use this template.
- Parameter Groups: View any parameter groups that have been created for this specific batch template version.
- PREREQUISITE: Add procedure templates to unit operations on the Operations tab, and create one or more parameter groups for this batch template version. For more information about creating batch parameter groups, review the Creating & Managing Batch Parameter Groups article.
Additionally, the batch template header provides visibility into the batch template lifecycle and offers access to additional options, such as assigning authors and tags.
For more information about the batch template lifecycle, including submitting a batch template draft for review and approval, review the Batch Template Lifecycle & Stages Overview article. Otherwise, click any of the links below to skip to related content.
- Printing a batch template report
- Adding batch template authors
- Adding tags
- Accessing batch template configuration options
Adding a unit operation & procedure template
- Click Add a Unit Operation.
- Enter a Unit Operation Name then click the β checkmark icon.
- Click Add a Procedure beneath the unit operation name.
- Select a procedure template from the dropdown menu, then click Add. This adds the procedure template to the this unit operation in the batch template.
- (OPTIONAL) Click Add an alias to add an alias for this procedure. This can assist an operator in differentiating between duplicate procedures within a batch.
- Continue to build the batch template as required:
- Click Add a Procedure to add another procedure to this unit operation.
- Click Add a Unit Operation to add another unit operation to the batch template.
- To rename a unit operation, click the current name of the unit operation, then make any required updates. Click the β checkmark icon to save changes.
- To rename the alias for a procedure template, click the current alias of the procedure template, then make any required updates. Click the β checkmark icon to save changes.
Configuring a unit operation
The more_horiz More Options icon to the right of the unit operation name provides access to the following configuration options:
- Configure Unit Operation: Click to access the Enforce Sequentiality checkbox. This setting is checked by default; if checked, this unit operation will enforce that an operator progresses sequentially among the unit operation's procedure templates.
- Move Left / Move Right: Click one of these options to move a unit operation to before or after a different unit operation in the same batch template.
- Delete: Click to delete this unit operation.
Within a unit operation, the more_horiz More Options icon to the right of a procedure name provides access to the following options:
- View Procedure Template: Opens the procedure template in a new tab.
- Move Up / Move Down: Click one of these options to move a procedure template to before or after a different procedure template in the same unit operation.
- Delete: Click to delete this procedure template from the unit operation.
Managing process parameters
Process parameters are added at the procedure template level and can then be managed on the batch template and batch run level. To manage process parameters within a batch template, ensure that you have added the procedure template(s) with parameters to a unit operation within the batch template.
On the Process Parameters tab, batch authors may scroll to review all relevant parameter values or use the links on the left side of the page to skip from one section of the page to another.
- To edit a parameter value, click the edit Edit icon, then review editable fields and make any necessary updates.
- Value Type: Choose between Static or Dynamic, if applicable. (Static values are fixed. Dynamic values are determined by an input or action from a previous procedure in the batch template.)
- Default Value: Set the default value for this parameter at the batch template level.
- Click Override to save changes.
Adding a placeholder or document
Adding a placeholder
- Click Add Placeholder.
- Select whether the placeholder document should be treated as Required during the batch run. (Disabled by default.)
- Enter a Document Name following your organization's naming conventions.
- (OPTIONAL) Select a Unit Operation to associate this placeholder with a specific unit operation. Then, optionally, select a Procedure Title to associate this placeholder with a specific procedure within the unit operation.
- Click Add Placeholder.
Once a placeholder has been added, options display to the right of the placeholder row that allow a batch template author to edit Edit or delete Remove the placeholder, if required.
Adding a document
- Click Add Document.
- Click Choose your file then select a PDF, DOCX, PNG, or JPG file from your computer.
- Enter a Document Name following your organization's naming conventions.
- (OPTIONAL) Select a Unit Operation to associate this placeholder with a specific unit operation. Then, optionally, select a Procedure Title to associate this placeholder with a specific procedure within the unit operation.
- Click Add Document.
Once a document has been added, options display to the right of the document row that allow a batch template author to zoom_in View File, cloud_download Download File, edit Edit File, or delete Remove the document, if required.
Printing a batch template report
- Click the Batch Template Report button near the upper right corner of the page. The Batch Template Report dialog opens with the checkbox for every tab selected by default.
- Deselect the checkboxes for any tab names that you do not want to print, if applicable.
- Click Print. The system generates a batch template report as a webpage. To print the webpage, click the print Print icon, then follow any additional instructions in the print dialogue.
- Click close Close to dismiss the batch template report webpage.
Adding batch template authors
As mentioned in the Creating a new batch template section of this article, batch template authors can be added during initial batch template creation. To add batch template author groups or authors after template creation, follow the steps below:
- Click the group Authors icon near the upper right corner of the page.
- Determine whether you are adding author groups or individual authors:
- To add author groups, click Edit beside Author Groups.
- To add individual authors, click Edit beside Additional Authors.
- Select the relevant authors to add, then click Save to save changes.
Adding tags
As mentioned in the Creating a new batch template section of this article, tags can be added during initial batch template creation. To add tags after template creation, follow the steps below:
- Click the sell Tags icon near the upper right corner of the page.
- Add one or more tags, then click Save Changes to save.
Accessing batch template configuration options
After a batch author has created a new batch template, any batch author can view and manage batch configuration options by clicking the more_horiz More Options icon located in the upper right corner of the page.
The following items display on the more_horiz More Options menu:
- Template Configuration Settings
- Template Information Settings
- Duplicate Template
- Export Batch Template
- Archive Batch Template
Template Configuration Settings
Each batch template allows the batch author to configure certain batch review and execution requirements. The Template Configuration Settings menu provides access to the settings described in Step 8 of the Creating a new batch template section of this article.
Template Information Settings
Each batch template allows the batch author to configure batch information settings. The Template Information Settings menu provides access to the settings described in Step 4 of the Creating a new batch template section of this article.
Duplicate Template
The Duplicate Template menu item enables a batch authorβ to make a copy of this batch template. A new batch template ID must be provided and configuration settings can be reviewed prior to duplicating the template.
This functionality is distinct from creating a new version of a single batch template. The Duplicate Template option can expedite the creation of a different batch template that is similar to the one being duplicated.
Export Batch Template
The Export Batch Template menu item enables a batch author to export an effective batch template, including all unit operations and procedures.
Archive Batch Template
The Archive Batch Template menu item enables a batch author to archive an effective batch template; this should only be done if no version of the batch template will be needed for future execution.
Next steps
- Review the Batch Template Lifecycle & Stages Overview article to learn more about submitting a batch template draft for review and approval, as well as general information about batch template stages and versions.
- Review the links in the Creating a new batch template section of the Batch Templates Overview article to determine next steps in creating a batch template, if applicable.
- Review the Starting a batch run article to learn more about starting a new batch run based on an effective batch template.
- For high-level information about Tempo MES, begin with the following article: