Skip to main content

Loading Models

Overview​

This page gives instructions, and an example, on how Models and related data can be loaded through the Maximo Integration Framework (MIF).

A Model represents the as-designed configuration of a complex asset.
An individual Model consists of a series of data elements, some of which must be loaded in a specific order.

In order to facilitate the loading of a Model, an MXLoader Excel template is provided in the link below. The example provided gives the as-designed configuration representing a helicoper: AW159 WILDCAT

This is an actual aircraft used in a military capacity but the different data elements (Part Numbers, Build Items etc) of the Model provided are ficticious in nature.

AW159 Wildcat Helicopter - Model Example​

Download AW159 WILDCAT Model - MXLoader

An explanation of the individual data elements and worksheets contained within the MXLoader file is described below. The worksheets are ordered in the necessary way to support the loading of the Models individual data elements.

Part Numbers​

The Part Numbers worksheet provides the mechanism to load Part Number Master (ITEM) records.
These must be loaded first as they are referenced by the Model itself.

If the default Part Status (defined in the Organization record within Maximo) is PENDING (and not) ACTIVE then it is recommended that the status of the Part Number records is changed from PENDING to ACTIVE within the Part Number Master application. This is so the option "Roll New Status to Organizations and Inventory?" can be chosen to ensure the status of the Part Number record is set to ACTIVE for all records related to the Part.

Model​

The Model worksheet is used to create the main Model record: PLUSACMMODEL
The primary key attributes of a Model are: MODEL, ITEMSETID

Build Items​

A Build Item represents a component or assembly. It is used as part of the definition ofthe hierarchical structure of a Model.

Each Build Item must reference at least one Label an one Part Number

Model - Part Numbers​

The "Model - Part Numbers" worksheet is used to load the Part Numbers related to each Build Item.
There must be at least one Part Number for each Build Item. If more than one Part Number is specified for a Build Item then it is recommended that one is marked as the default.

Each Part Number, related to a specifc Build Item, performs the same fit, form and function and are by default two-way interchangeable.

Labels​

Each Build Item must be related to at least one Label.
A label is used (together with the Build Item name and Postiion) to identify a specific component within the build hierarchy of a model.
It may represent the functional system or some other manufacturer provided coding system. Eg an ATA Code

If there is more than one Label for a Build Item then the combination of Label and Default for Position should be unique.

Build Hierarchy​

The Build Hierarchy is used to define the hierarchy of positions which make up the as-designed configuration represented by the Model. It is typically structured in such a way as to represent the physical structure of the complex asset.

Each line in the worksheet represents an indiviudal "Build Position".

The LCN is used to determine the parent/child relationship between build positions and as such should be unique.

It is recommended that if the same Build Item is used mulitple times within the same parent assembly, at the same level of indenture, then a unique Position value is used for each build position. This is so users can easily identify which position is being referenced without ambiguity.

Configuration​

The Configurations worksheet is used to load one or more VARIANT Configuration for each Model. Each Model must have at least one Variant Configuration which is non-abstract to allow users to create Assets using the Model.

The example given contains a base "abstract" variant and two non-abstract variants representing different configurations of the Model.

An abstract Variant Configuration cannot be used in the creation of Aircraft or Equipment records (assets).

Revisions​

At least one ACTIVE revision record must exist for each Model before users are able to create Assets from it.

Configuration Rules​

Configuration Rules define additional criteria that must be obeyed for the Asset to be deemed to be in valid configuration.

The configuration rules within a Model are defined within the context of a specific revision of the Model. Each rule is applicable to the revision which it was defined against, and in addition, all later revisions of the Model. This is unless a later rule of the same type exists to override this.

A full matrix of the configuration rules, which it is possible to define, is provided in the separate BDI topic "Configuration Rule Matrix".

Explanation of PLUSAMXACMAPPLE data attributes.

AttributeDescription
CONFIGRULEA string representation of the configuration rule. The string contains the rule type, and the various data elements which are needed to make up the rule.
The rule is interprested by the inbound Object Structure processing class to determine the data required.
APPLETYPEA two character code which identifies the rule (applicability element) type.
RULEPOSITIVEIndicates if the rule is negative or positive. Rules are normally negative to indicate an exception to the standard behaviour.
REVISIONThe Revision of the Model to which the rule relates. Rules are applied to the revision indicated and any subsequent revisions unless a rule of the same type supercedes this.
ISPRIMARYIndicates if the rule is a Primary or Secondary Rule. Most rules are defined to be primary.
Specific rule types have the option to define a secondary rule which extends the primary rule to provide further restrictions.

Model Flags​

Model Flags are used to indicate specific Yes or No type options which exist against a specific position in relation to a Model and a Configuration. The most common usage is to indicate whether a build position is mandatory for specific Variant (or Role).

AttributeDescription
VARIATIONThe name of the configuration (normally a Variant name).
LCNThe LCN of the Build Position within the Model to which the flag record relates
FOREIGNENTITYThis should always be set to: PLUSACMCONFIG
REVISIONThe Revision of the Model to which the flag rule relates. Rules are applied to the revision indicated and any subsequent revisions unless a flag rule of the same type for the same build position and variant supercedes this.
FLAGTYPEThe type of Flag, options are:
MANDATORY - If the position is mandatory
CREATEWO - When a mandatory position becomes empty, indicates whether a WO should be created automatically (against the parent assembly).
EVENTSINACTIVE - If true all PMs for the Asset in the position will be made INACTIVE.
ALLOWANYPART - If true the system should consider any CM Item installed into the position to be valid.
FLAG1 or 0 to indicate the flag value