Item Templates

Definition

Item Template - an individual blueprint that is leveraged to create Items (services).

Usage

Clicking on the Item Templates option in the left-hand pane brings up a tabular view of all of the Item Templates you have setup within your WorkRails instance.

Create

  • To create a new Item Template, click the "New Custom Template" button.

  • In the Item Template creation view, give your item a Name, Description, and Label.

  • Click the "Add Field" button to start adding Fields to your Item Template.

  • After you have added your Fields, click on the "Save" button to save the template, and make it available to create Items.

Note: Item Templates contain many different types of Fields, each with specific logic. For more information on Fields, see the Fields - Type Dictionary reference within this Administrator Guide.

Shared Attributes

Regardless of which Field type you choose, every Field has shared attributes.

  • Label - provides a name for the field, which appears on the front-end.

  • Type - designates how the Field will function.

  • Order - designates where the Field will appear on the front-end.

  • Hint Text - provides the ability to hover over a Field on the front-end, and see helpful instructions.

  • Display Options - allows you to customize how a Field will be displayed on the front-end. Please see Display Options for additional details.

  • Accessibility Options - allows you to customize who will see a Field on the front-end. Please see Accessibility Options for additional details.

  • Tag - used to associate custom functionality to a given Field.

Clone

  • To clone an existing Item Template, highlight an Item Template in the table, click the Actions pane, and select "Clone".

  • This will create a cloned representation of the existing Item Template that you have selected, and will pre-populate it with details that you can then override.

  • After you have added your Fields, click on the "Save" button to save the template, and make it available to create Items.

Edit

  • To clone an existing Item Template, highlight an Item Template in the table, and click on the Item Template Name.

  • This will bring you into the Item Template edit screen, where you can add or modify fields as needed.

  • After you have finished your updates, click on the "Save" button to save the template.

Note: If your Item Template is associated with any existing Items, a prompt will ask you to confirm if you want to make the change. Changes to an Item Template that has Items based on it will take effect immediately, so make sure to test your changes against Sandbox Items before associating to a Production Catalog.

Delete

  • To clone an existing Item Template, highlight an Item Template in the table, click the Actions pane, and select "Delete".

  • This will prompt a dialog box that asks you to confirm the deletion of that Item Template.

Note: Deleting an Item Template will delete any associated Items. Do not delete an existing Item Template unless you are certain you want the Item Template and any associated Items to be removed.