About this task
Traditional content is a standalone document. It is unrelated to templated content that generates content for a particular asset.
For example, an Amine System has a unique set of startup steps that are different than the startup steps for a Natural Gas System, therefore these two documents would be created as traditional documents.
Procedure
-
On the AcceleratorKMS menu, navigate to Manage and click Create > < Document >.
< Document > options are determined by your location but can include content such as procedure, training content, assessments, etc.
-
Complete the document information fields.
Document information fields
Name
Description
Title
Name of document used for searches, assignments, and reporting. The title must be unique. Although it is possible to have multiple pieces of content with the same title, the system enforces a unique title when publishing with message "Procedure title already exists! Please use a different title."
If exporting content from AcceleratorKMS, do not use the following symbols within
content titles as the export destination can misinterpret them: " * : < > ? / \ |
Description
Provide a few details describing the content.
Both the title and description fields are used when performing a document search.
Content type
Identifies the type of content you are building. For example, procedure or training material. Select the related content type from the list.
Domain
The name of a hierarchical tree structure containing documents and flows. Select required domain from the list to identify where the document is to be located within the Domain. This field cannot be left blank.
Access
Defines who has access to content. To add role, click List all to see all roles in AcceleratorKMS. This field cannot be left blank.
There are two icons associated with role access:
Role has access to this content (default) - Applied to content documents and flows. Roles are also used in definitions of various applications and are an important part of defining access within AcceleatorKMS.
Role has access and is associated with workflows and reporting - Provides access to content and also impacts Reports and Workflows.
Role access also impacts:
Reports - Reports are generated based on your role and domain access to content.
Workflows - Task definitions use roles to define the users to be included in the pool of resources when tasks are assigned within Workflows.
Dashboard - Widgets appear on your dashboard when the Administrator defines those widgets to include your role. The reported content in the widgets is based on your access or associated asset to the content.
Content Completions - A role is defined within a completable step, which then determines who can perform the completion for that content.
Users with associated roles do not need to perform steps or complete content but
could be users who must be aware of the content and the steps involved, such as supervisors
and training personnel. For example, content is performed by field technicians and
console technicians, but the field supervisor should be added as an associated role
to ensure awareness of the content. Be sure to include roles involved in performing
tasks related to the content, such as reviewing or approving changes.
Initial request
Use Initial request to link the document to a content request, if one exists. If the document is not linked, this field does not display.
To add a link, begin typing the content title used in the request form. Selecting Hide closed displays only the open requests for selection.
Related assets
Use related assets to create bi-directional links between one or more assets that are related to the document. Adding these links help to assess the impact of changes made to content and statements. When you add related assets to this field, a link gets added from the asset back to this document.
To add related assets, begin typing in this field and select assets from the drop-down list.
Relted content
Use related content to create bi-directional links between one or more pieces of content to assess the impact of changes made to content and statements. When you add related content to this field, a link gets added from the other content back to this one.
To add related content, begin typing in this field and select content from the drop-down list. The system displays this field after your first save of the content.
Completion sequence
Set the complete sequence for completing the document by selecting one of the following options:
None - Steps can be completed in any order.
Role - Steps for each role must be completed in order.
Strict - All steps are completed in order, regardless of role.
Sub documents retain their sequence setting and do not inherit from the parent document.
If you decouple a document and change its completion sequence, that sequence is retained when the document is recoupled to the template. It does not inherit the completion sequence setting of the template.
Published
Date on which the document was published. If the document is not published, this field does not display.
This field is auto-populated and cannot be edited.
Expires
Date on which the document expires. If there is no expiry date, this field does not display.
This field is auto-populated and cannot be edited.
Properties
Other information relevant to the document.
Attachments
Files or pictures relevant to the document. Maximum file size is 98 MB. Various file formats are supported. We recommend that you reach out to your administrator for the full list, as it is configurable.
Style set
List of available custom style sets that may be used for the document.
Custom styles are visible in only view or completion modes. They are not visible
in edit mode.
-
Click +Section to add a section or +Item to add a statement.
Refer to the following sections within this guide for details about working with
statements, variables, and blocks:
If a section appears with a coloured bar down the left and an information icon at
the top of the bar, this indicates that the section is set to be summarized in the
PDF output. Generating a PDF version of the content is recommended to ensure the desired
content is included in the summary sections.
-
Click Preview.
-
In the Version comment field, type a comment to identify the change that was made.
-
Click Save.
Results
The document is created with a draft status.
What to do next
After writing is complete, it is ready for the review and publish process. See AcceleratorKMS Workflow and Task Management