About Authoring

User Guides / Authoring / About Authoring

Authoring is a term we use to describe how a template is created in Manifest. An Author could be a subject matter expert knowledgeable about specific procedures and equipment, or a user responsible for generating standardized work processes for an organization. Authoring can be done while you work, with an experienced operator documenting the work process to later guide other users; or authoring can be the process of building existing workflows into Manifest and optimizing them with augmented instructions using mixed reality. The Authoring in Manifest section of the User Guide is a resource for those looking to learn more about creating work templates using Manifest, across any of the offered platforms.  

Prerequisites

  • Users with Author permissions are able to create new templates or edit existing ones on any Manifest application with authoring capabilities.
  • Users with Admin permissions have access to create new templates or edit existing ones on the Manifest Web application.

About Templates

A template is a repeatable set of work instructions. When workers are doing their jobs with Manifest, they are following a procedure defined by a template. Manifest templates are characterized by numbered steps that must be completed in a sequential order. Templates could be a set of work instructions or an inspection checklist. They are stored at the ‘Asset Class’ (or class of equipment) level and can be accessed and viewed for that asset class as well as any associated asset (or specific piece of equipment).

Any user can view a template, but only users with Admin and Operator permissions can create a job from a template. Creating a job will generate a copy of the template for the specified asset and allow an assigned Operator to perform that procedure.

Which Manifest application should I use to author my template?

Templates can be created and edited using any of the following Manifest applications: Manifest Web, Manifest 3D (used with an AR headset such as HoloLens or Magic Leap), or the Manifest iPadOS application. Whether you want to author each step hands-free as you work or prefer to author from your desktop or tablet, is up to you.

Many users elect to ‘pre-author’ their templates in the Manifest Web Application, as using a keyboard and mouse is often quick for this step, and then manage the authoring of spatially anchored content (step markers, leader lines, pen notes, etc) using the Manifest 3D Application and a AR headset. Regardless of what option you choose, we recommend reviewing the available tools across all applications.

About Step Notes

Step Notes are an optional tool an Author can use to expand the instruction or paths available from a step. There are multiple note types and no limit to the number of notes that can be added to a step. We recommend being concise and consider the most impactful way to communicate an instruction to an operator, while also making it efficient for users to follow and complete the task.

Step Note Types & Specifications

Please find the standard description and specifications for step title and the various step note types below for your reference.

When pre-authoring in the Manifest Web Application, please be mindful of the required file formats and sizes before uploading the notes to your template. These requirements are automatically managed if you are authoring on a the Manifest 3D or iPadOS Application.

Note TypeDescriptionTips & Specification
Step titleA text note opens a new window with additional text added by the Author. When created in the Web Application, authors have the additional option of using html to change the size, style, and color of any text. Text notes are often used to go into additional detail about the step instruction or can also be used to communicate a Warning or Caution note for that step.No character limit. Step markers will expand to fit the step title. We recommend keeping step titles clear and concise; breaking up long instructions into multiple steps when possible.
TextUse text notes to expand on instructions, detail requirements, or to include a warning/caution notice.No character limit. Text note display will paginate to show longer text. We recommend keeping instructions clear and concise.
AudioAn audio note will play a voice recording to audibly narrate instructions to an operator. Audio notes can be recorded while using the Manifest 3D or iPadOS application, or by uploading a .wav file via the Web Application.File formats accepted: .wav
VideoA video note can be recorded by the author to demonstrate the instruction or information about the step. The video can be accessed by the operator and played at any stage during that step. Videos can help Operators better understand a particularly complex step or procedure. Video notes can be recorded while using the Manifest 3D or iPadOS application, or uploaded via the Web Application.File formats accepted: .mp4, .mpg, mpeg, or .MOV
Limited to size of 500mb

Optimal specifications:
– 720p
– 1280 x 720 pixels
– Aspect ration 16:9
PhotoPhoto notes can be added by the author to accompany a step instruction, providing additional reference or guidance to the operator. Image notes can be captured while using the Manifest 3D or iPadOS application or uploaded via the Web Application.File formats accepted: .png, .jpg, .jpeg

Optimal specifications:
– 720p
– 1280 x 720 pixels
– Aspect ration 16:9
BookmarkIf PDF documents have been associated to an Asset Class (via the Web Application), an author can bookmark a page within any document to make it available from a step. This can be used to link to diagrams or images in operation manuals or point the Operator to additional references.PDF file must be uploaded and associated to the asset class before a bookmark note can be added.
PenPen notes can be annotations inked on or around the asset, or shape notes (circle, square, or arrow) used to call special attention to the Operator. These notes can be authored using the Manifest 3D or iPadOS application and will render augmented in the Operator’s environment during that step.Pen notes can only be authored on the 3D application.
Action3D ModelAuthors can program a step to automatically render a specified 3D Model or to hide any 3D Model the Operator may have open. The 3D Model will remain open until the Operator closes or a subsequent step is programmed to hide or load a new model.

Authors can program a specified 3D Model to automatically render at this step. It will remain open for the time the Asset Tag is open, until the Operator manually closes the model or tag; or unless there is a subsequent 3D Model Action to load a new model or hide the model.
Limit of 1 3D Model action per step.
Action – MeterAuthors can program any 3D meter(s) to automatically render when the operator loads the related step. The 3D Meter will display any measurement date for that Asset’s meters accordingly. All Meters will close once the Operator completes that step.Meters must be associated with asset class. There is no limit to the number of Meter Action Notes per step.
Action – AlignmentWith any procedure that spans over a large asset/area, spatially anchored content may lose accuracy the further it is from the scanned Asset Tag. Alignment Actions will automatically prompt an Operator to scan an alignment tag, previously set-up by the author to realign to that location.Limit of 1 alignment action per step.
Template noteTemplate notes allow Authors to link another work template to a job step. Authors can embed any existing template from any Asset Class using a Template Note and the Operator will be prompted to complete that job associated with that template before returning to complete the step it originated from. Template Notes are ideal for linking to previously authored templates that can be sub-processes, standard preparation steps, safety procedures that recur across multiple templates, or even as a way to link  procedures for multiple assets.Limit of 1 Choice note (max of 5 options) OR Template note on each step.
Choice noteAuthors can use Choice Notes to program multiple options or paths for Operators to choose from, depending on the job or environmental conditions.  Authors can set an option to continue to the next step or go to a sub-procedure, linked to any existing templates on the current asset or another registered asset class.Limit of 1 Choice note (max of 5 options) OR Template note on each step.
Table of Contents
    Add a header to begin generating the table of contents