Glossary - AcceleratorKMS - Version 3.12 - Help - Hexagon

My Account (user access)

Identifies your login access ID and email address. Also identifies the domains to which you have access and the roles you have been provided within those domains.

Located on the upper-right corner of the main menu bar. Your access to content is determined by the domains and roles you have been assigned.

Administrators create user accounts and assign your domain access and roles.

Asset Profile

Used when creating templates. Encompasses the Basic information, Properties, and Attributes of an asset type.

On the menu, navigate to Manage > Asset Type.

Attributes

Provides unique identifying features of an asset.

Required for the conditional display of content in document templates.

Completions

Actionable steps within published content that are performed by assigned roles for content (documents and process flows.

You can only complete content if you have a role that includes procedural steps within the content.

Process flow completions - Subdocuments and subflows can be jump started or restarted. Content completions - Can be started when AcceleratorKMS is:

• Online

• Offline using Offline mobile app (manual sync)

• Online and internet connection is disconnected (automatic sync when connection is restored)

See also Completion sequence.

Completion sequence

Determines the completion order of content statements.

Completion sequence can be the following:

• 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.

Content

Generic term to refer to a traditional document, flow, or template.

Produces traditional documents or flows, or generated asset documents.

Decouple/Recouple templates

Decouple - Separates an asset document from the document template and becomes a standalone document. Recouple - Joins document to its original template.

Used when required changes no longer relate to the document template.

Any changes made to a decoupled document are lost if the content is recoupled to the template.

Domain  

Domains are the nodes in the Index that are used for content classification.

The Index provides a hierarchical tree structure of all domains and descendant domains. User accounts are assigned to specific domains.

Content documents and flows are each assigned to one domain node in the Index. Domains are used to control user access to content according to roles assigned to each.

The user can only see the content that is within their assigned domains and has access based on their defined role assignments.

Administrators build and manage the domain hierarchy for your organization.

See also My Account.

Process Flow

A graphical view of completable steps in a flow-based process.

Produces a process flow that can include elements such as statements, decisions, and other sub documents or sub flows.

Properties (for an asset document)

Supporting information associated with an asset. Properties can include information such as the location of the asset, drawings, or links to external information that is pertinent to the asset.

This information is shown with the asset information when a document is open. It has no impact to the document and is shown for informational purposes only.

Properties (for traditional content)

Metadata assigned to content that describes the content and assists in search capability.

Identifies company, department, content type, domain, access, etc. Can be used as additional search criteria.

Quick add statement functionality

Content is built into your document as you create statements.

Use the +Item to quickly build content into your document to enter text, build variables, and define the Statement Type and Role. See also Statement.

Reusable variable

A placeholder for a value. Can be used in a template or traditional content.

Values are entered once.

For traditional content: 

• Values are entered at the top of the content

• All occurrences of that variable use the same value

For generated content: 

• Values are defined in the asset profile

• The values are used throughout all generated content for that asset

Roles

Identifies the type of access a user is given. See also Role operations.

Administrators create roles and assign operations to those roles.

• Access roles are assigned to content to control viewing.

• Associated roles are assigned to content to control reporting and inclusion in workflow tasks.

• Completion roles are assigned to procedural statements to control authorization for completions.

For example, the Administrator may create a junior Writer role with "Add or edit statement" and "Add or edit content" role operations. A senior Writer role may also contain the "Add or edit document templates" role operation.

Role operations

Used in conjunction with roles to grant authorization for certain actions. Each role has one or more role operations. See also Roles.

A user with an assigned role is granted all operations defined in that role.

Domain and domain descendants - Users with role operations that are domain dependent are applicable only to content document and flows within the domain in which the role, including the operation, is assigned to the user. An example of such an operation is Add or edit content and Publish and retract content.

Global - Users with roles operations that are identified as Global operations are granted system-wide capabilities and are not limited within the domain. An example of such an operation is Add or edit statements and Add or edit users.

Single use variable

A placeholder for a value. Can be used in traditional content at the statement level.

Values are defined each time the statement is used and the values are entered in-line.

Reference link

Within a document, reference links can be used to take the reader from one place in the document to another place within the same document. For example, Go to step 27.

Values are defined each time a reference link is used.

Statement

Statements are used to build content into a document. If configured by your Administrator, statement types can include procedural, information, block, branch, data collection, and scan code.

Grouped statements can form a section, block, or a procedural task. Statements can be built using the quick add functionality or the statement editor.

See also Quick add statement functionality.

Statement editor

Use the statement editor to create new statements.

Located in the Statement search area. Statements are created outside of the document and added to your document at a later time.

Task Flow

Tasks are used to manage the life cycle of content through the use of workflows.

The task is assigned and the required work is completed for the assigned workflow step. The task is then transitioned to the next step in the workflow. The sequence of completing work and transitioning the task continues until the last step in the workflow is reached. At this point the content is published and the task is changed to complete.

Templated content

Contains a set of statements that are generally applicable to several assets of the same type (all assets do not require the exact same statements). Used in place of creating traditional content.

Created for a specific asset type and applicable to most assets of that type. Document templates can generate several asset documents from a single template.

Traditional content

Contains a unique set of statements that do not apply to any other assets.

Content stands on its own.