Skip to main content

Models

Environment access level

This section describes all operations that an Environment access level user can perform with Models.

What are models in Inimco.facts?​

In Inimco Facts, a model refers to a structured definition that outlines the properties, interfaces, components, and schema of digital twin entities. It is an integral part of the data structure setup in the Facts Platform. Unlike content presentation, a model is focused on the underlying structure and behavior of data entities.

A model, based on the Digital Twins Definition Language (DTDL), is crucial for configuring and customizing digital twin models within the platform. The development of a model library in Inimco Facts would enable platform administrators to effectively define, organize, and manage these models.

The application of models in Inimco Facts can be exemplified in scenarios like Lean Manufacturing, where customers have the flexibility to define their own platform models. These customer-defined models can then be shared across different subscriptions, facilitating tailored and efficient digital twin configurations.

Blank Models​

In the context of creating a new model in Inimco.facts, Blank refers to a template option for creating a model that doesn't inherit or extend from any predefined or built-in model types. Essentially, it offers a clean slate to define a new model from scratch.

Generated Model for Blank: 

{ 

  "@id": "dtmi:com:inimco:facts:randomstringhere;1", 

  "@type": "Interface", 

  "@context": "dtmi:dtdl:context;3", 

  "displayName": "", 

  "contents": [] 

}

When the Blank option is selected, the system automatically generates an identifier with a random string to ensure uniqueness. This model doesn't have predefined fields or behavior inherited from other models.

A platform user might select the Blank option if they want to create a completely new model type that doesn't match any of the platform's existing model definitions. It provides flexibility for unique model requirements.

DataSet​

DataSet appears to be one of the built-in or predefined model types from which a new model can be derived or extended. The DataSet seems to provide a structure for organizing and representing a collection of data in the platform.

Generated Model for DataSet: 

{ 

  "@id": "dtmi:com:inimco:facts:datasetgyjvo;1", 

  "@type": "Interface", 

  "@context": "dtmi:dtdl:context;3", 

  "displayName": "DataSet gyjvordem", 

  "extends": "dtmi:com:inimco:facts:base:dataset;1", 

  "contents": [] 

}

When a platform admin selects the DataSet option, the system generates a model that extends the properties and behaviors of the base DataSet. The generated model will have specific fields that match the DataSet type and might include additional metadata or characteristics.

If a platform admin wants to define a new model that organizes data in a manner similar to the existing DataSet model but with specific customizations or extensions, they might choose the DataSet option.

What can we do with the models in Inimco.facts?​

Create Models​

  • Add a New DataSet Model: Integrate a model designed specifically for handling and structuring datasets.

  • Add a New Blank Model: Start from scratch by creating a new, undefined model that you can customize as needed.

Manage Existing Models​

  • Clone a Model: Make a copy of an existing model, useful for creating similar models with minor variations.

  • Delete a Model: Remove a model that is no longer needed or relevant, ensuring your model library remains up-to-date.

  • Create a New Version of a Model: Update a model with new features or changes while keeping its original structure, allowing for version control and evolution over time.

View Model Information​

  • View a Model's Fields: Examine the specific attributes or properties defined within a model.

  • View a Model's DTDL Schema: Access the Digital Twins Definition Language (DTDL) schema of a model, which outlines its structure and behavior.

  • View a Model's Subscriptions: Check which subscriptions are using a particular model.

Subscription Management​

  • Add a Subscription to a Model: Associate a model with a subscription, allowing users under that subscription to utilize the model.

Procedures​

Add a new DataSet model​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the + icon in the top right corner.
  4. Select DataSet.
  5. Click NEXT.
  6. Enter the model definition into the Add model field.
  7. Click Submit.

Add a new blank model​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the + icon in the top right corner.
  4. Select Bank.
  5. Click NEXT.
  6. Enter the model definition into the Add model field.
  7. Click SUBMIT.

Clone a model​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the ellipsis (...) in the model row that you want to clone.
  4. Click Clone model.
  5. Click SUBMIT

Delete a model​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the ellipsis (...) in the model row that you want to delete.
  4. Click Delete model.
  5. Confirm deletion.

Create a new version of a model​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the ellipsis (...) in the model row that you want to create a new version of.
  4. Click Create new version.
  5. Enter the model definition into the Create new version field.
  6. Click SUBMIT.

View a model's fields​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the model row that you want to view fields of.

View a model's DTDL schema​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the model row that you want to view DTDL schema of.
  4. Click the DTDL tab.

View a model's subscriptions​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the model row that you want to view subscriptions of.
  4. Click the ACCESS CONTROL tab.

Add a subscription to a model​

  1. Log in to Inimco.facts. You will be taken to the Home screen.
  2. Navigate to Models.
  3. Click the model row that you want to add a subscriptions to.
  4. Click the ACCESS CONTROL tab.
  5. Click +.
  6. Select the subscription from the Subscription field.
  7. Click ADD SUBSCRIPTION.