Monitor supports 2 artifacts:
1.Dashboard : You can create a monitoring dashboard by defining its configuration in a JSON file
2.Custom Functions: You can write a custom function for the Anomaly detection model
How to create and import dashboard for Monitor
1. Dashboard JSON Schema for creating dashboard cards.
2. Hands On Lab for creating summary and instance dashboards for Anomalies models
Doc Summary Dashboard
Doc Instance Dashboard
How to create and register custom functions/model with Monitor
Adding IBM Maximo Asset Monitor Custom Content to Digital Twin Exchange
1. Getting Started
For a tutorial on creating custom Maximo Asset Monitor content and testing please see the following tutorial, as this guide assumes you have a functioning custom asset to add to the Digital Twin Exchange.
For general questions about being a content provider on the Digital Twin Exchange please see our FAQ! This guide assumes you have been onboarded onto DTE and already have a storefront.
2. Packaging Your Product
To get started download your product from your source control solution and zip the content to be distributed.
Also be sure to prepare any supporting documentation, licenses and product descriptions/screenshots ready.
3. Uploading Your Product
a) To upload your product, go to https://digitaltwinexchange.ibm.com/ and log in to your vendor account.
b) Click on “Admin” on the left side panel > click or hover and choose “Products”
c) Click on “Add New” on the upper right corner
d) Fill out the form with appropriate product name, descriptions, categories and tags. (We recommend adding the Maximo Asset Monitor tag)
e) Once your product submission looks complete, click on “Submit” on the bottom of the page.
f) Your product is now published and ready for purchase!
Scoring method template for illustrative purposes only
Health 8.1 Scoring Methods
Health Application supports 3 distinct scoring methods
1.Asset Health Score
•Weight based on Drivers and Factors
•Drivers and Factors are based on formulas
Scoring method is associated with a set of assets using Query
Manual approach to integrate Health scoring method with Digital Twin Exchange
Exporting scoring method
1.Export the scoring method from Maximo Health or create from scratch using the example payload
2.Use Digital Twin Exchange web interface to create a product and upload content exported as JSON
3.Make sure to document specifics about the scoring method
Importing scoring method
1.Download the content from Digital Twin Exchange
2.Perform any preinstallation steps to consume the contents
3.Import the scoring method into Maximo Health
4.Apply asset query and activate scoring method
Health 8.1 Scoring Methods –Exporting a Scoring Method
1.Make sure API Key is available to connect to Health. If not, go to the Maximo Health Administration app and generate a new API Key for a user
2.Install a REST API client tool like POSTMAN
3.Identify the Scoring Method Id
•Send a GET request using the following URL to figure out id used by the method. Make sure to include apikey header with the API key value
where <maximo-health-hostname>is the name of host where Maximo Health Application is running, and port is the <port>number and <method-name>is the name of the method for which content need to be extracted
•Look for the ahmethodologyid value in the response
4.Extract the Scoring Method content
•Send a GET request using the following URL. Make sure to include apikey header with the API key value
where <method-id>is the ahmethodologyid obtained from previous step
•Copy the response into a file called <method-name>.json
Health 8.1 Scoring Methods –Analyzing and Documenting Scoring Method
Once the scoring content is extracted, it must be analyzed for consumption by a customer. Use the following information to analyze the content and document for customers.
1.Identify the scoring method, whether it is for Health, Risk or Criticality and indicate that in the document. Note that Health scoring method involves multiple drivers and factors and document the weightage used for the drivers.
2.Check the query associated with the scoring method. A customer may or may not have this query in their system. Either instruct the customer to create the query prior to importing or change the query to AHISAMPLEQUERY in the JSON payload
•Look for the clausename attribute value in the scoring JSON content
3.Examine all the formula definitions included in the scoring method. A formula may have been constructed to use a custom attribute that may not be present in a customer Health Application system. If there are any custom attributes used, document how a customer can create these attributes and bring data related to this attribute into the Health Application.
•Look for curvalformula or normformulaattribute values in the scoring JSON content for Health scoring method
•Look for methodformula attribute values in the scoring JSON content for Risk or Criticality scoring method
4.Set the active attribute to false to make sure it is not active by default when imported
Health 8.1 Scoring Methods –Importing a Scoring Method
1.Make sure all prerequisite requirements to consume the scoring method are met. For ex: custom attributes, asset query etc. Refer to the documentation provided by the vendor that put the product in the Digital Twin Exchange.
2.Make sure API Key is available to connect to Health. If not, go to the Maximo Health Administration app and generate a new API Key for a user
3.Install a REST API client tool like POSTMAN
4.Create the scoring method
Send a POST request using the following URL, include the downloaded JSON content as payload. Make sure to include apikey header with the API key value and set the Content-Type header to application/json
where <maximo-health-hostname> is the name of host where Maximo Health Application is running, and port is the <port> number
5.Verify that the scoring method is successfully imported
•The POST response must indicate 200 success
•The scoring method must be present when viewed from Health Application
6.Update the query on the scoring method
7.Activate the scoring method
Model files for illustrative purposes only:
Note: additional information regarding the deployment of the custom models are included in the sample notebook.
There are two ways custom models can be deployed to work with Maximo –Predict as outlined below:
1. BRYOM (Bring Your Own Model): Typically a black box model, or physics based model, source code is not available, signature is available
•TBD (future release)
2. BDYOM (Build Your Own Model): This is a fully developed, readily deployable on Maximo –Predict. This involves using PMI wrapper types, with an option of deploying on either AS or WML. AS involves UI support and WML deployment does not provide UI support
•Custom Transformer, Estimator, Pipeline
–Documentation (this document)
– Two datasets are provided with this sample (to be used with the notebooks provided with this documentation)
•dtx_sample_for_failure_probability.csv : Sample dataset to predict the failure along with probability
•dtx_sample_for_time_to_failure.csv: Sample dataset to estimate the time left before a failure happens
– Load the data using the instructions and code in the notebook “DTX_1_CustomLoader.ipynb”
– Customize the wrapper types and the overridable functions to suit your dataset as illustrated in the notebook “DTX_2_FailurePredictionCustomModel.ipynb”
The steps outlined in this document can be used to build custom models using one of the following two approaches:
1.Generic Custom Model: Build a custom model that is deployable on IBM Watson Machine Learning, and register it with MAS –Predict runtime
•The DTX_GenCustom_*** artifacts included with this model illustrate this approach
•This approach lets the provider build any generic model as long as it is deployable on IBM Watson Machine Learning
•There is currently no UI support for models built and registered using this approach. The results of model invocation (scoring) will not be displayed on the MAS –Predict dashboard
2. Template Based Custom Model: Build a custom model based on one of the MAS –Predict predefined use case templates
•This approach is not illustrated in this version, and will be added at a later time
•Models built using this approach will display the results on the UI
Steps involved in building Generic Custom Model
Building Generic custom model involves the following broad steps:
–Train a classifier or regressor or other form of estimator as needed for use case using your own training data.
–Once trained and evaluated, deploy the trained model in IBM Watson Machine Learning.
–An example of the two steps outlined above is illustrated in the notebook DTX_GenCustom_Failure_Probability_Training.ipynb
–Load the sensor data and failure data in the MAS Datalakeand the EAM system (Maximo). This is illustrated in the notebook DTX_GenCustom_Load_Data.ipynb
–Register the model with MAS –Predict infrastructure. This is illustrated in the notebook DTX_GenCustom_Failure_Probability_Registration.ipynb
–Logon into the MAS –Predict dashboard and activate the registered model,and schedule it.
–Ensure the data is flowing into the datalake
–Use the MAS –Predict APIs to retrieve the results periodically to display on your own client dashboard
Digital downloads are stored with Industry-Standard AES-256 encryption and access controls limiting access unless purchased through the digital twin exchange, and Digital Twin Exchange uses secured and encrypted communications. Once purchased, downloads can be accessed and used per the content provider's usage terms and conditions.
The IBM Digital Twin Exchange is a ecosystem for content providers to share many different types of digital resources related to assets. Content providers use the IBM Digital Twin Exchange to easily upload equipment data such as Bill of Materials, as well as efficiently communicate with end users. The IBM Digital Twin Exchange also helps to mitigate accounting and taxes concerns by providing a standardized process of selling content.
Within the Exchange, these digital twin resources are generic to all assets that are related to the physical asset associated with the digital twin. Therefore, they may be applied to any instance of an asset. To expand to a true operating twin, you'll need to build upon the digital twin templates to connect sensors and operating history. This could be done through existing enterprise asset management solutions such as IBM Maximo, and asset performance management tools while connecting the IoT sensor data to the record.
To browse and purchase content from the IBM Digital Twin Exchange you need an account. End users pay only for the cost of the digital twin resources. If you'd like to become a content provider and join the IBM Digital Twin Exchange Content Program there is a yearly subscription charge of $99. Click here to learn more.
Switching accounts is as easy as logging out and logging back in with a different user name. Click on the user icon on the top navigation toolbar to log out once logged in.
If you are a content provider and have some digital twins you'd like to share with users of the IBM Digital Twin Exchange you can sign up to join the IBM Digital Twin Exchange Content Program. The program costs $99 per year and gives you a private dashboard to manage your digital twin resources. Signing up is easy using this page.
Currently, an end user has to find or request digital twin content such as Bill of Materials from vendors separately. After receiving a Bill of Materials document in PDF format, the end user may then spend over 20 hours manually entering data into enterprise asset management solutions such as IBM Maximo Asset Management.
The IBM Digital Twin Exchange is a ecosystem for end users to easily search and access many different types of digital resources related to assets. Upon purchasing your digital twin, if the digital twin is compatible with IBM Maximo, an user may import digital twin into IBM Maximo (view demo here). Ultimately, end users would be able to save time, as well as better understand and optimize the performance of installed assets.
Listing your content at the right price will help to reach your customers, and the right price might depend on your business priorities, pricing strategies, market dynamics, and more. If you are not sure how to price your content, you can look around on the Digital Twin Exchange for similar content to get an idea of what other content providers are charging. You can also talk to your end users to gauge their willingness to pay and the right price point. Finally, you are welcome to book a session with our IBM Consultants to go over different pricing options.
1) Click on Settings under the Admin panel or go here: https://digitaltwinexchange.ibm.com/store-manager/settings/
2) Select Store Policies:
As a content provider, you have full control over catalogue visibility, as well as customer access.
To change visibility on an individual product level:
1) Click into each product and select the desired catalog visibility level
To change visibility for multiple products:
1) Select multiple products
2) Click on bulk edit
3) Select the desired catalog visibility level for multiple products
Here is a list of sample content that we are currently accepting from content providers:
An Export Classification Number is a five-character alphanumeric key used in the Commerce Control List (CCL) to classify U.S. exports and determine whether an export license is needed from the Department of Commerce.
We require third parties to provide the export classification of their items listed on the IBM Digital Twin Exchange. Please obtain advice from your legal counsel or consultants familiar with this regulatory area.
We're always working to improve the IBM Digital Twin Exchange, so we'd love to hear what's working and how we can do better. Please send an email to firstname.lastname@example.org. We really appreciate it.
The refund policies vary between content providers. Be sure to check the refund policy for each digital twin before purchasing. However, regardless of the policy, it is possible to request a refund from an order and describe why you'd like the refund. Under "My Digital Twins" > "Orders", click on the "Refund" button next to the order.
Then within the popup opens, explain why you are requesting a refund. The content provider will handle the request.
If you do not hear from the content provider or wish to contact IBM regarding your refund request, please use the Contact us form.
It is the policy of International Business Machines Corporation (“IBM”) to respect the intellectual property of others and thus to respond to effective notices of alleged infringement of copyrighted material where (i) the copyrighted material is available at, or from, a system or network controlled or operated by or for IBM or where (ii) IBM, by providing or using an information location tool, such as a directory, index, reference, pointer, or hypertext link, refers or links a third party to a site that contains the copyrighted material.
If you are alleging that copyrighted material may have been or is being infringed, then you may notify IBM. Click on this page to learn more.
Your IBM Registration ID is your single point of access to IBM Web applications that use IBM Registration. You need just one IBM ID and one password to access any IBM Registration-based application. Furthermore, your information is centralized so you can update it in a convenient and secure location. The benefits of having an IBM Registration ID will increase over time as more and more IBM applications migrate to IBM Registration.