Difference between revisions of "Manage Activity Templates"

From Hornbill
Jump to navigation Jump to search
 
(21 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{Section|
 
{{Section|
 
==Introduction==
 
==Introduction==
−
[[file:ActivityTemplate.png|right|350px|link=https://wiki.hornbill.com/images/0/02/ActivityTemplate.png]]
 
 
Activity Templates can be set up to provide users with selectable, pre-defined templates the are used for common activities.  This ensures that all users that perform a particular activity are using the same configuration.  Templates are only available to use when manually creating an activity.
 
Activity Templates can be set up to provide users with selectable, pre-defined templates the are used for common activities.  This ensures that all users that perform a particular activity are using the same configuration.  Templates are only available to use when manually creating an activity.
−
 
+
[[file:ActivityTemplate.png|right|border|350px|link=https://wiki.hornbill.com/images/0/02/ActivityTemplate.png]]
 +
<br>
 
Templates allow you to set up the following:
 
Templates allow you to set up the following:
 
:* Title
 
:* Title
Line 21: Line 21:
 
:* [[#Outcomes|Outcomes]]
 
:* [[#Outcomes|Outcomes]]
 
:* [[#Checklists|Checklists]]
 
:* [[#Checklists|Checklists]]
 +
:* [[#Managing Existing Templates|Managing Existing Templates]]
 
}}
 
}}
 
{{RightBox|Related Articles|
 
{{RightBox|Related Articles|
Line 51: Line 52:
 
==Add a New Template==
 
==Add a New Template==
 
===Key Fields===
 
===Key Fields===
−
Click on [[File:template_add_new.png]] to create a new template. A blank form will be displayed on the righthand side.
+
Click on [[File:template_add_new.png]] to create a new template. A blank form will be displayed on the right hand side.
 
{{bullet1|Template Name|This is the only mandatory field.  This will be displayed within a list of available templates on an Activity form. This is only used to identify the template and is not used within the activity itself.}}
 
{{bullet1|Template Name|This is the only mandatory field.  This will be displayed within a list of available templates on an Activity form. This is only used to identify the template and is not used within the activity itself.}}
−
{{bullet1|Title|This will populate title field of the activity which is visible within the Activity list and in any component where activities are displayed}}
+
{{bullet1|Title|This will populate the title field of the activity which is visible within the Activity list and in any component where activities are displayed}}
 
{{bullet1|Description|This will populate the description field of the activity.  Here you will provide details of the activity that needs to be carried out.}}
 
{{bullet1|Description|This will populate the description field of the activity.  Here you will provide details of the activity that needs to be carried out.}}
 
{{bullet1|Category|This will populate the category field. Information on creating and managing the available categories can be found '''[[Manage Activity Categories|here]]'''}}
 
{{bullet1|Category|This will populate the category field. Information on creating and managing the available categories can be found '''[[Manage Activity Categories|here]]'''}}
Line 62: Line 63:
 
{{bullet1|Show ''Start On''|Checking this option will expose the ''Starts On'' field on the activity}}
 
{{bullet1|Show ''Start On''|Checking this option will expose the ''Starts On'' field on the activity}}
 
{{bullet1|Add a Checklist|Add a list of things that need to be done as part of this activity.  See '''[[#Checklists|Checklists]]'''}}
 
{{bullet1|Add a Checklist|Add a list of things that need to be done as part of this activity.  See '''[[#Checklists|Checklists]]'''}}
−
|}}
+
|
 +
{{rightBox|Selecting a Template From a New Activity|
 +
[[file:activityTemplateSelection.png|400px|border|link=https://wiki.hornbill.com/images/a/a5/ActivityTemplateSelection.png]]
 +
}}
 +
}}
 
{{TOP}}
 
{{TOP}}
 
{{Section|
 
{{Section|
Line 81: Line 86:
 
{{TOP}}
 
{{TOP}}
  
 +
{{Section|
 
==Checklists==
 
==Checklists==
−
[[File:activity_template_checklists.png|500px|right]]
+
One or more checklists can be added to a Template.  These checklists will be presented to the user on the Activity Form where they can check off each item as they are completed. This can complement the description of the task with a definitive list of items that need to be done as part of the activity. Checklists interact with the Progress Bar of an activity and with each item that is checked, the Progress Bar will be reflected.
 +
[[File:activityTemplateChecklist.png|border|right|link=https://wiki.hornbill.com/images/4/4f/ActivityTemplateChecklist.png]]
 +
{{bullet1|List|More than one list can be configured. Enter the name of the list and add additional lists if required}}
 +
{{bullet1|Item|Each list is made up of items.  Each item will be displayed with a checkbox within the activity that can be selected by the user when completed}}
 +
{{bullet1|Enforce Completion|When selected, all ''Items'' must be checked before the activity can be completed.}}
 +
|}}
 +
{{TOP}}
 +
{{Section|
 +
==Managing Existing Templates==
 +
A list of all existing Activity Templates are displayed under the '''Activity Templates''' view, select an existing template to do the following:
  
−
Optionally add one or multiple checklists to the activity template. 
+
{{bullet1|Edit|Edit the content of an existing activity template and then use the '''Update''' button to apply the changes. The Changes will only apply to new activities which use the template from that point forward}}
−
* Each checklist can have multiple items added to it
+
{{bullet1|Remove|Click on the ''Remove'' button to remove the activity template. This will permanently delete the activity template. This will not effect existing activities which were created using the template}}
−
 
+
{{bullet1|Copy|Copy an existing activity template by using the '''Save as New''' button and giving the new template a different name}}
−
Select the '''Add Checklist''' option and give the checklist a name
+
|}}
−
* Add one or multiple checklist items to the checklist by using the '''+ Add Item''' icon and giving each item a name - repeat for as many items as needed in the each checklist
+
{{TOP}}
−
 
 
−
Remove checklist items or checklists by selecting the '''Trash Can''' next to each checklist or checklist item
 
−
 
 
−
* '''Enforce Completion''' - Mark if the checklist must be complete before the activity can be completed
 
−
 
 
−
Use the '''Create''' option to create the '''Activity Template'''
 
−
 
 
−
==Managing Existing Template==
 
−
 
 
−
A list of all existing Activity Templates is displayed under the '''Activity Templates''' view, select a template to do the following:
 
−
 
 
−
* Use the '''Remove''' button to remove the activity template - this will delete the activity template and mean it is not available to use when creating new activities, it will not effect existing activities which are already using the template
 
−
* Edit the content of an existing activity template and then use the '''Update''' button to apply the changes.  The Changes will only apply to new activities which use the template from that point forward
 
−
* Copy an existing activity template by using the '''Save as New''' button and giving the new template a different name
 
  
 
[[Category:Collaboration]]
 
[[Category:Collaboration]]

Latest revision as of 14:56, 4 November 2022

Home > Collaboration > My Activities > Manage Activity Templates Index

Introduction

Activity Templates can be set up to provide users with selectable, pre-defined templates the are used for common activities. This ensures that all users that perform a particular activity are using the same configuration. Templates are only available to use when manually creating an activity.

ActivityTemplate.png


Templates allow you to set up the following:

  • Title
  • Description
  • Category
  • Priority
  • Assign to
  • Outcomes
  • Show Time Spent
  • Show Start On
  • Add a Checklist

Access

Roles

A user must have one of the following roles in order to access the option for managing templates.

  • Admin Role
Any user with the Admin Role will have access to manage the Activity Templates
  • Activities Template Manager
This roles allows you to provide access to non-administrative users

Manage Templates

The Manage Templates option can be accessed from the main toolbar located in the Activities view. This option will only be visible if one of the above roles have been assigned to the user.

  1. Select the Home icon in the left hand Application Bar
  2. Select My Activities
  3. In the Activities Tool Bar select the drop down option on the far right
  4. Select Manage Templates

(Top of Page)

Add a New Template

Key Fields

Click on Template add new.png to create a new template. A blank form will be displayed on the right hand side.

  • Template Name
This is the only mandatory field. This will be displayed within a list of available templates on an Activity form. This is only used to identify the template and is not used within the activity itself.
  • Title
This will populate the title field of the activity which is visible within the Activity list and in any component where activities are displayed
  • Description
This will populate the description field of the activity. Here you will provide details of the activity that needs to be carried out.
  • Category
This will populate the category field. Information on creating and managing the available categories can be found here
  • Priority
Options include High, Normal, and Low
  • Assign to
Predefine the user, role, or group that the activity will be assigned to.
  • Outcomes
The default outcome is Done. This can be modified and additional outcomes can also be defined. See Outcomes
  • Show Time Spent
Checking this option will expose the Time Spent field when completing an activity. This is useful if you want to track the amount of time that the activity took.
  • Show Start On
Checking this option will expose the Starts On field on the activity
  • Add a Checklist
Add a list of things that need to be done as part of this activity. See Checklists
Selecting a Template From a New Activity

ActivityTemplateSelection.png

(Top of Page)

Outcomes

When an Activity is being completed, a user can select the outcome of the activity. New Templates have the default outcome set to Done. You may want to change this or add more outcomes to allow a user to select alternative outcomes such as Not Done, Passed, Failed, etc.

Add an Outcome

ActivityTemplateOutcome.png

Click on the + to add a new Outcome

  • Label
The display name for the outcome which will be seen by the user when completing the activity
  • Code
The code which will be attributed to the outcome and could be used for reporting purposes
  • Colour
Choose a colour which will be used for the outcome when the user is completing the activity
  • Require Reason
Tick if you want to make it mandatory for the user completing the activity to have to provide a note when choosing this outcome for the activity.

Manage Existing Outcomes

  • Update
Click on an existing Outcome to display the properties box. Make any required changes and click on Save
  • Remove
Click on an existing Outcome to display the properties box. Click on the Remove button.

(Top of Page)

Checklists

One or more checklists can be added to a Template. These checklists will be presented to the user on the Activity Form where they can check off each item as they are completed. This can complement the description of the task with a definitive list of items that need to be done as part of the activity. Checklists interact with the Progress Bar of an activity and with each item that is checked, the Progress Bar will be reflected.

ActivityTemplateChecklist.png
  • List
More than one list can be configured. Enter the name of the list and add additional lists if required
  • Item
Each list is made up of items. Each item will be displayed with a checkbox within the activity that can be selected by the user when completed
  • Enforce Completion
When selected, all Items must be checked before the activity can be completed.

(Top of Page)

Managing Existing Templates

A list of all existing Activity Templates are displayed under the Activity Templates view, select an existing template to do the following:

  • Edit
Edit the content of an existing activity template and then use the Update button to apply the changes. The Changes will only apply to new activities which use the template from that point forward
  • Remove
Click on the Remove button to remove the activity template. This will permanently delete the activity template. This will not effect existing activities which were created using the template
  • Copy
Copy an existing activity template by using the Save as New button and giving the new template a different name

(Top of Page)

Retrieved from "https://wiki.hornbill.com/index.php?title=Manage_Activity_Templates&oldid=30179"