Within AcceleratorKMS, there are two types of documents: traditional and templated. Both are structured the same: basic information, sections, and statements. The key difference between the two types is how they are generated.
-
Traditional content -- Contains a unique set of statements that do not apply to any other assets and stand on their own. Can be content such as a procedure, assessment document, or flow.
-
Templated content -- Contains a set of statements that are generally applicable to several assets of the same type (all assets do not have to require the exact same statements). Templated content is created with a specific asset type in mind and applicable to most assets of that type.
Traditional and templated content can also share common statements. The following diagram shows the flow of content for traditional and templated content, and how common statements can be used in both.
Asset types, asset profiles, and document templates combine to generate asset documents.
Assets are grouped into asset types, so that all assets of the same type are grouped together and common items, such as templates and properties, can be applied to each asset. Within the asset type, each asset has its own asset profile that contains an asset ID and any other information specific to the asset. For example, the asset profile might contain a serial number and location. To simplify the creation of asset documents, you can use templates. So instead of creating an individual document for every asset of the same type, you can create a template for the asset type. Using the asset profiles, the template automatically generates content for each asset within the selected asset type. For example, when a template called Startup is created for the asset type Pump, startup content is generated for all pumps within the Pump asset type.
Examples of asset types are Pumps and Fin Fans. An asset type contains the set of basic information, properties, and attributes that are used with each asset to create its profile. AcceleratorKMS uses this information in conjunction with the document templates to determine which statements to include in an asset’s documents.
-
Basic information consists of the asset type's name, description, and class. You can use an asset class for additional data validation if AcceleratorKMS is integrated to an Asset Management system. This integration requires custom system configuration implemented by the AcceleratorKMS team. You cannot create a new asset class from within AcceleratorKMS.
-
Properties are supporting information associated with the asset. They can be anything you want, 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 only informational purposes.
-
Attributes are characteristics of an asset that can have different values. For example, the asset type Pump can have an attribute of Driver Type. The possible values for the Driver Type might include electric or steam. You can set statements within a document template to display based on the attributes of the asset. For example, you can set a statement to show only when Driver Type is set to steam. So a document for a pump with an electric driver, generated from the document template, does not include that statement.
All attributes are set in the asset type, but the attribute values for a specific asset are set in the asset profile. Properties can be assigned at the asset type, and cascaded to, or overwritten at the asset profile, template, or individual generated procedure.
If you attempt to delete property values that are currently in use, you receive a
warning, and the deletion is prevented.