Managing statement types - AcceleratorKMS - Version 4.0 - Help - Hexagon

AcceleratorKMS Application Administration

Language
English
Product
AcceleratorKMS
Search by Category
Help
AcceleratorKMS Version
4.0

View, create, edit, or delete custom statement types.

Before you begin

Requires an account with the Administrator role

About this task

Create or modify custom statement types that are used within your content. Default statement types include: Procedural, Data Collection, Block, Branch, Sub Content, and Information (which can include types such as Caution, Warning, Note, etc.).

Procedure

  1. On the menu bar, click the gear icon > Statement types.

  2. Click Add new statement type to create or click an existing custom statement type to edit.

  3. Complete the following fields.

    Custom statement type fields

    Field

    Description

    Name (Required)

    This is the descriptive name for the type of statement you are creating. This statement type is selected when creating a new statement.

    Description

    Provides a description for the type of statement you are creating.

    Base type (Required)

    Base types include:

    Information

    Use for creating content such as Caution, Warning, and Note.

    Procedural

    Use for procedural steps: The Numbered check box is automatically selected but can be cleared if required.

    The Numbered check box is automatically selected but can be cleared if required.

    Branch

    Use for statements requiring a decision.

    Scan code

    Use for statements that require a code value to be scanned for equipment verification purposes. After saving the Scan code statement in your content, you are required to manually enter the code value or scan the code using the camera on a mobile device. During completions, the barcode or QR code is scanned using a camera on a mobile device to capture the code.

    Block

    Use for a group of statements, other blocks or sections requiring reuse.

    Data collection

    Use for content that requires data to be recorded, such as current temperature, date/time, pressure, and vibration level. After adding a data collection statement in a document or flow, click the "Data collection not defined" button to define the data collection key type and key ID. Optionally, during a completion, data collection statements can be configured to scan text and numeric inputs. A numeric range can be set on data collection statements. During completions, the field operator enters data.

    Table

    Use for content that has to be presented in a tabular view for completion, instead of vertically. It is useful for content such as inspections, operator rounds, and Lock Out/Tag Out (LOTO).

    Numbered

    Indicates whether the statement is numbered.

    Use when numbered statements are required.

    Procedural statements are numbered by default.

    Preview

    Displays a preview window.

    Displays the text and the formatting that is used based on the inherited formatting of the selected base type or other settings  you made. The preview adjusts in real-time as settings are adjusted.

    Text colour

    Indicates the text colour for the statement.

    The options are:

    Default - Inherits text colour from a stylesheet

    Specified - Specifies a text colour

    When Block is selected for Base type, the Text colour options are not displayed.

    Icon

    Indicates an icon for the statement type.

    The options are:

    None - No icon will be displayed

    Image - Add an image attachment

    Template - Use a template based on HTML and CSS (Contact AcceleratorKMS for more information)

    Insert {0} in the template as a placeholder that will be replaced by the statement type name. This feature helps to support multiple languages (e.g. CAUTION / AVERTISSEMENT).

    When Block is selected for Base type, the Icon options are not displayed.

    SHARED Tip You cannot delete a statement type if it is being used. A delete button only appears in the statement type window if that statement type is not being used.

  4. Click Save.

Results

The changes are saved.