Creating a statement within a document - AcceleratorKMS - Version 3.12 - Help - Hexagon

Statements are used to build content within a document.

Before you begin

You must open the content in edit mode.

About this task

All documents, regardless of the document type, are built using statements. During content creation or editing, you can add existing statements or create new ones.

Branch statements are used as decision points to determine the remaining statements in the document. A branch statement prompts the user to select either Yes or No. If the user selects Yes, then branched statements are displayed for the completion. If the user selects No, then the branched statements remain hidden and the user can continue to the next statement. After selecting Yes or No, the user can deselect it by clicking the decision button again.

The following can be added by your Administrator:

• Scan code statements are used when a code value is required to be scanned for equipment verification purposes. After a scan code statement is created, the code value is manually entered or the code is scanned 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.

• Data collection statements allow operators to record data, such as current temperature, pressure, vibration level, or any other required data they need to record. You add the statement, define the key type (such as All, Text, Numeric, Date/Time, Single select list, Multi-select list), and the 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.

Procedure

Content is saved differently depending on the following:

• Content is automatically saved to the database as it is created. You must click Preview on the document if you want to save it to your document.

• Newly added content with a block is saved when you click Preview for the block. If your document did not get saved, the content added to the block is still preserved.

Modifications to existing statements are saved after you click Preview on the statement. You do not need to click Preview on the document to preserve your changes.

1. In the main section of the document, click the gear icon > +Item.

   A statement text box appears.

   If you want to add a statement in a new or existing block, see the section Blocks - Create and manage within this guide.

2. Click the Type drop-down list, and select from one of the following:

   • Information

   • Procedural

   • Branch

   • Block

   • Other types, such as, Scan code, Data collection and Table might be listed if created by your Administrator

3. If you select either Procedural or Branch types, click the Role drop-down list, and select a role.

   The role drop-down list is only required when procedural and branch types are selected and only roles defined with role operation "Can complete content" will appear for selection in the role drop-down list.

   When adding an item of any type using Quick add, the system performs a search on existing items to maximize reuse potential. A search toggle is now available to turn search on or off. When Quick add search is on as shown in the following figure, the system performs a search and returns results of existing items. When search is off, the system does not perform a search. To maximize reuse, it is recommended to keep search turned on. However, in some cases where reuse is not relevant, it might be desirable to turn search off to avoid unnecessary searching.

   

   You can copy/paste text to build new statements or to easily find existing statements.

   If there is an existing statement that is similar to what you want, you can select it and modify it. After you modify the statement, the Reuse button changes to Create, which allows you to quickly build a new statement from an existing statement.

4. In the Quick add field, start typing the text you want to add and then choose one of the following:

   • Select a statement from the list of existing statements, and click Reuse.

   • Complete entering your new statement text, and click Create.

5. Click Preview and Save. This ensures the newly added statements are fully added to the document.

Results

The statement is added to the document.

What to do next

• If you want to add more details and attachments to the statement, you must edit the statement. For more details, see Creating a statement using the statement editor.

• If the statement contains a variable, define a value for the variable; otherwise, the variable remains undefined. Content drafts cannot be published until all undefined variables are resolved.

• If the statement was added to a document template, you can change the conditions within the template to determine when the statement is displayed. These settings allow you to set the statement to be shown for a specific asset or attribute, or you can hide the statement for a specific asset.

• If the added statement was a branch statement, add the additional statements that are required if the user selects Yes for the branch statement. After the additional statements are added to the document, place them under the originating branch statement using drag-and-drop.

• If the added statement was a data collection statement, add an existing data collection key or define a new one by entering the key's type and id. Content drafts cannot be published until all undefined data collection keys are resolved for any data collection statements.

• If the added statement needs sub-statements, create each of the required statements and place them under the originating statement as subordinates using drag and drop. For details, see Organizing content using drag and drop.

Statement fields

Use these fields when you create or edit a statement.