Creating a Model

Launch the Models app.

Choose New.

In the New Model dialog box, enter the following details:

In the Type field, select if the model is relevant for equipment, systems, or functional locations.
In the Model ID field, enter the ID for the model.

Note

Provide a unique model ID, as ID is unique for a specific manufacturer.
In the Short Description field, enter a short description for the model.
In the Long Description field, enter a long description for the model.
In the Tracking drop-down, select the type of tracking you want to assign to an item of equipment that is based on the model.
The following list helps you to select an appropriate value:
- Serial number tracking at model level: As a manufacturer, you want to track an item of equipment within a model using unique serial number. An operator uses the unique serial number while creating an item of equipment.
- Serial number tracking at manufacturer levelAs a manufacturer, you want to track all items of equipment using unique serial number. An operator uses the unique serial number while creating an item of equipment.
- Batch number tracking at batch levelAs a manufacturer, you want to track all items of equipment within a batch using a batch number. An operator uses the batch number while creating an item of equipment.
Note

This field is not relevant when creating models for functional location.
In the Parent Subclass/Model Template field, select a subclass or model templates.

If you select more than one template, then the Primary Template field is displayed where you need to select one of the templates as the primary template.

You can assign one or more parent subclasses or model templates to a model. If you enter more than one parent subclass/model template, you must additionally select a primary template in the dropdown of field <Primary Template>. This primary template is used for class/subclass/template display in the breadcrumb as well as in the model list. The assignment of the primary template can later be changed in the Data Sheet section of the model.

Note

All assigned templates and subclasses (as well as associated classes) are available in the Model Information section. If there are more than one class/subclass/template, count values are displayed in the respective fields. When clicking on one of the count values, you can view the complete template hierarchy for your model.
In the Manufacturer field, select the manufacturer name.

Note

This field is not relevant when creating models for functional location.
Choose OK.

You can view the header information for the model like manufacturer, external IDs, languages, model type and so on.

External IDs:

You can view the Object ID and also view the IDs used for the object in the external systems. You can also use Add button to add external IDs. The dialog box displays the Object ID in the top and list of External IDs maintained for that object. You can copy the object ID using the copy button .

To add values to the attributes of the underlying templates, choose Start of the navigation path

INFORMATION Next navigation step

Data Sheet End of the navigation path

and perform the following steps:

Choose Edit and enter values for the attributes as defined by the underlying templates.
You can reorder the attribute groups using Reorder Groups.
You can display the alternate unit of measure using Show Alternate UoM.

You can set the default unit of measurement system in the Unit of Measure Variant under User Account(icon on the left corner of the launchpad) Settings Unit of Measure.
You can add additional Templates or Subclasses using Add Template.
If there are multiple templates assigned, you get filtering options on the data sheet:
- All = displays all attribute groups and attributes.
- <Industry Standard> = displays all attribute groups and attributes that have the respective industry standard maintained.
- <Custom> = displays all attribute groups and attributes that are coming from customer-created model templates.
If there are multiple Subclasses and Templates assigned, you can change the Primary Template using Update Primary Template.
If there are multiple Subclasses and Templates assigned, you can remove assigned objects using Remove Template.

Note

It is mandatory to have at least one parent object assigned, that is, it is not possible to remove all assigned objects.
Choose Save.

You can now add model templates with nested structures, but will not be able to maintain the values. You can only maintain the values using the value PUT API.

To add model-specific information, choose Start of the navigation path

INFORMATION Next navigation step

Model Information End of the navigation path

and perform the following steps:

Choose EditAs a manufacturer, you want and enter the following fields:

Field	Description
Tracking	Update the tracking mechanism, if necessary.
Manufacturer Part Number	Enter the Manufacturer Part Number.
Original Manufacturer Part Number	Enter the Original Manufacturer Part Number.
Safety Risk	Select a recommended safety risk for the model during its operating condition.
Generation	Specify a number that indicates the version of the model.
AIN Global ID	Enter the Global ID.
Model Release Date	Enter a date by which the model will be released.
Description	Enter a model description.
Firmware Support	Specify if the model supports firmware.

To assign a tag, choose Add/Remove Tags.
In the Add/Remove Tags dialog box, assign a tag.
Choose OK.

You can assign such tags that logically categorize model information, maintenance, and other model-relevant data.
Choose Save.

In the Model Usage section, you can view the extent of model's usage.

If consumer or operator is sharing equipment based on the model relation, the usage is linked to the related equipment and operators.

To update a model as the successor to the current model, choose Start of the navigation path

INFORMATION Next navigation step

Life Cycle Information End of the navigation path

and perform the following steps:

Choose Assign in the Successor Model section.
In the Assign Successors popup, select the model you want to assign as successor.
Choose OK.

Note

The successor model you want to assign must have the same subclass as the current model.

To add the model to a group, go to INFORMATION → Groups→ Add.

You can view the list of groups to which the model is added.

To add model components, perform the following:

Choose STRUCTURE AND PARTS Structure→ Edit.

Choose Assign. From the Select Component dialog box, select the model component.
Choose Add.
You can define if an assigned structure component is mandatory or optional for a model.
You can adjust the quantity and the item description for the structure components. You can change the Quantity to a quantity range using the Define Quantity Range.
You can select an enum attribute to define default list of description to be assigned to the components using Select Description Attribute.
Choose Save.

To assign spare parts to a model, perform the following:

Choose STRUCTURE AND PARTS Spare Parts Assign.

From the Assign Spare Parts dialog box, select the spare part, and choose Provide Quantity.
In the Provide Quantity dialog box, enter values for Default Delivered Quantity, Advised Stock Quantity, and BoM Quantity. You can also enter a comment if necessary.
Choose Assign.

To assign a visual part to a model, perform the following steps:

Go to Documentation Documentssection.
Choose Add. You can assign an existing or a new document.
To assign a visual part, you must add a document of type .vds.
Choose Assign. You can now view the visual parts under Structure & Parts Visual Parts.

The viewer search is extended to search for part name, description, manufacturer part number, and EAM number. You can select search result and display it in the viewer window.

To add an instruction to the model, choose the Start of the navigation path

Documentation Next navigation step

Instructions End of the navigation path

tab and perform the following tasks:

In the Instructions section, choose Assign to perform the following steps:
In the Assign Instructions to a Model dialog box, search for an appropriate instruction.
From the Instructions search results list, select an instruction.

Note

You can assign instructions that are in a published state only to a model.
Choose OK.

You can view the different instruction types in the following tabs: Planned Maintenance, Breakdown, Installation, Operations, and Disposal.

To add, or assign, or edit an existing document to the model, choose the Start of the navigation path

Documentation Next navigation step

Documents

tab, and perform the following tasks:

In the Documents section, choose Add menu to upload a new document, and perform the following steps.

Choose Add Add Image to add an image
1. In the Add Image pop-up, browse for a file.
2. In the Additional Information section:
  - Assign a Main Category to classify the document.
    You can also assign additional categories in the More Categories field. You can also assign a Phase, if necessary.
  - Select the type of sensitive data available in the document from the Data Sensitivity list.
    
    Note
    
    This selection is only one of the metadata information for the document. Currently, there are no other actions performed based on the different value selected for this field.
  - Select the language from the dropdown that corresponds to the documents.
  - Enter a description. You can also enter a long description, if necessary.
  - You can block the replication of files in certain countries (relevant data centers in that country) by selecting the countries in the Blocked Data Center Countries.
    
    Only the owner of the document can edit this list.
    
    Others can view the blocked countries and data centers.
    
    If the document is already shared, then you will not be allowed to block countries and data centers.
    
    When editing the document, you can change the blocked country and data center list.
  - Select the confidentiality of the document if it’s not shared with everyone.
    
    Note
    
    If you are a premium account holder, all the private documents uploaded by your invitees can be accessed by you. Your invitees cannot have private documents without your knowledge.
    
    Confidentiality set by your invitee for a particular document applies to you as well.
3. Choose Upload.
  
  You can use Check and Upload to check if there are any duplicates that exist in the system. If duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then can Continue Uploading the New File or you can select a file from the duplicate file list and Use Selected File option to upload it.
Choose Add Add Document to add a document.
1. In the Add Document popup browse for a file.
  Note
  - Maximum upload file size for a document is 2 GB.
  - Different files with different MIME types can be uploaded for a document. You can assign the same or different languages for each file. For example, a document can now have files with “.doc”, “.pdf”, “.txt” extensions.
2. In the Additional Information section:
  - Assign a Main Category to classify the document.
    You can also assign additional categories in the More Categories field. You can also assign a Phase, if necessary.
  - Select the type of sensitive data available in the document from the Data Sensitivity list.
    
    Note
    
    This selection is only one of the metadata information for the document. Currently, there are no other actions performed based on the different value selected for this field.
  - Select the language from the dropdown that corresponds to the documents.
  - Enter a description. You can also enter a long description, if necessary.
  - You can block the replication of files in certain countries (relevant data centers in that country) by selecting the countries in the Blocked Data Center Countries.
    
    Only the owner of the document can edit this list.
    
    Others can view the blocked countries and data centers.
    
    If the document is already shared, then you will not be allowed to block countries and data centers.
    
    When editing the document, you can change the blocked country and data center list.
  - Select the confidentiality of the document if it’s not shared with everyone.
    
    Note
    
    If you are a premium account holder, all the private documents uploaded by your invitees can be accessed by you. Your invitees cannot have private documents without your knowledge.
    
    Confidentiality set by your invitee for a particular document applies to you as well.
3. Choose Upload.
  
  You can use Check and Upload to check if there are any duplicates that exist in the system. If duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then can Continue Uploading the New File or you can select a file from the duplicate file list and Use Selected File option to upload it.
Choose Add Add Link to add a document link.
1. In the Add Link popup, provide a URL link to the document along with a Display Name.
  Note
  
  You cannot upload private domains such as .corp as links.
  
  Different files with different MIME types can be uploaded for a document. You can assign the same or different languages for each file. For example, a document can now have files with “.doc”, “.pdf”, “.txt” extensions.
2. In the Additional Information section:
  - Assign a Main Category to classify the document.
    You can also assign additional categories in the More Categories field. You can also assign a Phase, if necessary.
  - Select the type of sensitive data available in the document from the Data Sensitivity list.
    
    Note
    
    This selection is only one of the metadata information for the document. Currently, there are no other actions performed based on the different value selected for this field.
  - Select the language from the dropdown that corresponds to the documents.
  - Enter a description. You can also enter a long description, if necessary.
  - You can block the replication of files in certain countries (relevant data centers in that country) by selecting the countries in the Blocked Data Center Countries.
    
    Only the owner of the document can edit this list.
    
    Others can view the blocked countries and data centers.
    
    If the document is already shared, then you will not be allowed to block countries and data centers.
    
    When editing the document, you can change the blocked country and data center list.
  - Select the confidentiality of the document if it’s not shared with everyone.
    
    Note
    
    If you are a premium account holder, all the private documents uploaded by your invitees can be accessed by you. Your invitees cannot have private documents without your knowledge.
    
    Confidentiality set by your invitee for a particular document applies to you as well.
3. Choose Upload.
  
  You can use Check and Upload to check if there are any duplicates that exist in the system. If duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then can Continue Uploading the New File or you can select a file from the duplicate file list and Use Selected File option to upload it.
You can add a new version of a document by selecting the document from the list and choose Add Add New Version.
1. In the Add New Version popup browse for a file.
  Note
  - Maximum upload file size for a document is 2 GB.
  - Different files with different MIME types can be uploaded for a document. You can assign the same or different languages for each file. For example, a document can now have files with “.doc”, “.pdf”, “.txt” extensions.
2. In the Additional Information section, enter a Description for the document. You can also enter a long description, if necessary.
3. Choose Upload.

In the Documents section, from the Add menu choose Assign to upload an existing document and perform the following steps:

In the Select Documents dialog box, search for an appropriate file.
From the Documents search results list, select a document.
Choose OK.

You can also use Remove and Download to remove or download any of the documents assigned to the model.

To add a hotspot to an image select an image in the Documents section, see Creating Hotspots.

To assign a failure mode, choose Start of the navigation path

Documentation Next navigation step

Failure Modes End of the navigation path

perform the following steps:

Choose Assign.
In the Select Failure Modes dialog box, select the failure modes that you want to assign to the model.
Choose OK.
You can create a copy of the failure mode using Copy.
Note

When you copy a failure mode and Save & Publish it:
- A new failure mode is created with the same causes and instructions from the source failure mode
- The newly created failure mode is directly assigned to the object
- The new failure mode is in published state
- You navigate to the new failure mode instance page that includes all the copied failure mode instances: effects, causes, instructions, and detection method
- The new failure mode appears in the failure mode section list
If you have write access to the model even though you do not have write access to the failure mode, you can edit the failure mode instance page of the model.
In the failure mode instance page:
- You can add new effects using Add New or assign existing effects using Add Assign in the Effects section. For each effect, you can Add Effect Details like:
  
  Local Effect Description: describes the direct effect on the model or the how it affects the model it is part of.
  
  Higher-Level Effect Description: describes how is the system affected the model is part of.
  
  End Effect Description: describes the ultimate effect that the failure has on safety and/or the environment (if any) and any impact on production or operational capability.
  
  Potential Worst-Case Effect Description: specifies what would happen in case no measures would be taken to anticipate, prevent, or detect the failure.
- You can add new causes using Add New or assign existing causes using Add Assign in the Causes section. You can assign a Low Level Failure Mode to the new causes that you create.
- You can assign existing spare parts to the failure mode instance using Assign in the Spare Parts section.
  
  You can select the assigned spare parts from the list and choose Remove to unassign them.
  
  Spare parts that can be assigned to the failure mode instance are displayed in the assign dialog box. Spare parts already assigned to the failure mode are filtered out from the list.
- You can assign existing instructions to the failure mode instance using Instructions Assign.
  
  Once you have assigned instructions, you can assign causes for the selected the instructions using Manage Cause.
  
  You can also select instructions from the list and unassign them using Remove.

In the

Documentation Next navigation step

Alert Types End of the navigation path

section, you can, Assign or Remove alert type group.

To add an announcement to the model, choose the Start of the navigation path

Documentation Next navigation step

ANNOUNCEMENTS End of the navigation path

tab and perform the following steps:

In the Announcements section, choose Assign to assign an existing announcement and perform the following steps.
In the Assign Announcements to a Model dialog box, search for an appropriate announcement using the filters – Announcement Type, or Priority, or Status.
From the Announcements search results list, select an announcement.
Choose OK.

You can create an improvement request for the model using Start of the navigation path

Documentation Next navigation step

Improvement Requests Next navigation step

New Improvement Requests End of the navigation path

.

You can enter the details in the New Improvement Request dialog box. Choose OK.

You are navigated to the new improvement request object page where you can further edit the request and save it.

You can view the list of functions assigned to the model under Start of the navigation path

DOCUMENTATION Next navigation step

Functions

.

Choose Assign.
Select a function.
Choose OK.

You can select a function and choose Remove to unassign a function.

For more information, refer to Functions.

In the

Monitoring Next navigation step

Indicators End of the navigation path

section, you can view the list of indicators associated with the model. You can select an indicator from the list and use Configure to define the Threshold values for the indicator.

For Numeric and Numeric Flexible datatypes, you can also define the <Reset>, <Min>, <Max>, and <Normal> values. You can also define threshold range for these datatypes. Reset button is functional only for these two datatypes and will delete all the existing values and insert the reset value wherever applicable.

Note

You can set up to a maximum of 10 thresholds. For data type Boolean, the maximum number of thresholds selected must be two with values True and False. Anything else can lead to inconsistency.
You can personalize the indicator filters and columns in the Indicator section. When you log in again the same filters and columns are displayed.
If you are assigned the role AC_CUSTOMER_ADMIN, then a new variant Default Indicators is available to display the indicators marked as default at model and equipment level in the Indicators section.
You can select a maximum of four Primary Thresholds. The primary threshold is used in the indicator chart of SAP Predictive Asset Insights.
Values of indicator are displayed based on Display UoM that is maintained at the template level.

In the

Monitoring Next navigation step

Nested Structure Indicators End of the navigation path

section, you can view the list of indicators inherited by the model from the associated nested structures.

To publish model, choose Publish.

System publishes the model and creates a first revision of the model in SAP Asset Intelligence Network. Users of your organization can view the published model. If you navigate away from the Models application without saving the model, the model remains in the unpublished state and is not visible to any users in the organization until you publish the model.

You can view the changes made on the model data in the Timeline section.

You can click the model date range to open the Filter By dialog box. You can select to show the event for a particular object and define the time range during which you want to see the changes.

For each change entry, you can view changes made in other languages on the timelines using the Show Details button.

To create revisions of a model and to switch between the published and revision states, see Creating Revisions and Switching Between Revisions and Published State.

Creating a Model

Prerequisites

Procedure