Template Creation
Summary: This document provides detailed instructions for creating task templates in the Onahiri platform. Templates standardize task creation, ensure consistency, and streamline workflows within your organization.
Getting Started
Accessing the Template Creator
To create a new template:
- Navigate to Side Menu Templates in the main navigation
- Click the “Create Template” button in the upper right corner
- Alternatively, click the “Create Template” tab in the navigation
Creation Paths
The system offers two approaches for template creation:
- Start from Scratch: Begin with a blank template for maximum customization
- Use Sample Template: Start with a pre-configured template as a foundation
Starting from Scratch
When starting from scratch:
- Select “Start from Scratch” on the creation type screen
- You’ll be presented with an empty template configuration form
- Default workflow steps and roles will be pre-populated
- No fields will be pre-configured
Using a Sample Template
When using a sample template:
- Select “Use a Sample Template” on the creation type screen
- Browse through available sample templates
- Click on a template to select it
- The configuration form will be pre-populated with fields, workflow steps, and roles
- You can modify any pre-configured elements to suit your needs
Template Configuration
Template Details
Start by defining the basic information:
- Template Name: Provide a descriptive name (required)
- Example: “Change Request” or “Bug Report”
- Best practice: Use concise, clear names that indicate purpose
- Description: Add context about when and how to use the template
- Example: “For requesting system configuration changes”
- Best practice: Include enough detail to help users select the right template
Custom Fields
Custom fields define what information will be collected when a task is created:
- Click “Add Field” to create a new field
- Configure field properties:
- Field Name: API name for the field (camelCase recommended)
- Display Label: User-facing field name
- Field Type: Type of data to be collected
- Required: Whether the field must be completed
- Type-specific settings: Additional options based on field type
Available Field Types
The system supports these field types:
Field Type | Purpose | Special Properties |
---|---|---|
Text Input | Short text entries | Character limits |
Text Area | Longer text entries | Multi-line support |
Number | Numeric values | Min/max constraints |
Currency | Monetary values | Currency symbol |
Date | Calendar dates | Date formatting |
Single Select | Choose one option | Option list |
Multiple Users | Assign multiple people | User picker |
Multiple Organization Units | Associate with units | Organization unit picker |
Yes/No | Boolean options | Default value |
Checklist | Multiple completion items | Default checklist items |
Configuring Type-Specific Properties
Different field types have unique configuration options:
For Select Fields:
- Add options by clicking “Add Option”
- Enter each option value
- You can remove options using the “×” button
For Checklist Fields:
- Add default items by clicking “Add Item”
- Enter each checklist item text
- You can remove items using the “×” button
For Currency Fields:
- Specify the currency symbol (defaults to $)
Workflow Steps
Workflow steps define the progression a task follows from creation to completion:
- The system pre-populates default steps:
- Not Started
- In Progress
- Under Review
- Completed
- To add a custom step:
- Enter the step name in the “Add step…” field
- Press Enter to add the step
- New steps are added to the end of the workflow
- To remove a step:
- Click the “×” button next to any step
- Best practice:
- Keep workflows as simple as possible
- Ensure steps follow a logical progression
- Use clear, action-oriented names for steps
Team Roles
Roles define the different participants who can be assigned to tasks:
- The system pre-populates default roles:
- Owner
- Assignee
- Reviewer
- Observer
- To add a custom role:
- Enter the role name in the “Add role…” field
- Press Enter to add the role
- To remove a role:
- Click the “×” button next to any role
- Best practice:
- Define clear responsibilities for each role
- Avoid creating too many roles
- Use role names that align with your organization’s terminology
Saving and Publishing
When your template configuration is complete:
- Review all fields, workflow steps, and roles
- Check for any validation errors or warnings
- Click “Create Template” to save and publish
Upon successful creation:
- You’ll receive a confirmation message
- The new template will appear in the Template Gallery
- The template will be available for task creation
Editing Existing Templates
To modify an existing template:
- Find the template in the Gallery
- Click the edit (pencil) icon
- Make your changes following the same process as creation
- Save changes to create a new version
Important Notes on Versioning:
- Editing creates a new version of the template
- Existing tasks based on previous versions remain unchanged
- New tasks will use the latest active version
Testing Templates
Before wide usage, it’s recommended to test your template:
- Create a test task using the new template
- Verify all fields display correctly
- Check workflow step transitions
- Confirm role assignments work as expected
- Make any necessary adjustments through the edit process