Devices

Organization structure

Purpose: Organization functionality in Upkip Administration allows to create hierarchical structure of the factory with base units – Factory, Department and Machine. Machines are defined with their properties, tags and alarms. Machine can be added to factory layout floors selecting visualization model. Machine models can be moved, resized and arranged on the factory floors. Created layout design with factory machines is shown in the Upkip Visualization application.

Add Factory

Purpose: By selecting menu Organization user can add the main unit in the organization Factory.

Precondition: User is logged in Upkip Administration by Microsoft account.

Select the left menu Organization

Click on Add button.

Figure 1: Upkip Administration - Add Factory

When selecting menu Add/Factory is opened form Properties.

Figure 2: Upkip Administration - Add Factory properties

Enter or select the following data:

Click Add.

Add Department

Precondition: The main element in organization tree is added – Factory. Select the created factory in the organization tree. Then is possible only to add department.

Purpose: There is possible to create different departments corresponding to factory structure. Departments are connected with user groups in Azure Active Directory (AAD). Users added to this azure group can see only machines from this department.

Figure 3: Upkip Administration - Add Department under Factory

When selecting Add/Department is opened form for new department.

Figure 4: Upkip Administration - New department properties

  1. Enter Department name
  2. Select Group from drop down (Groups are created in AAD)
  3. Click Add
    • The created department is added under node Factory.

Add Machine

Precondition: The main element in organization tree is added – Factory. Under the Factory are added Departments. Select some department to add Sensor (Machine).

Purpose: There is possible to add under departments different sensors or machines by selecting Add/Sensor.

Figure 5: Upkip Administration - Add Sensor under department

Fill in the form the following data:

Figure 6: Upkip Administration - New machine properties

Click Add button

Figure 7: Upkip Administration - Configured machine under department

Factory layout

Purpose: User can design factory layout with floors and machines locations. Created layout is automatically visualized in the Upkip Visualization. In the section are described:

Configure Factory Floors

Precondition: User has logged in Upkip Administration. Organization menu is selected.

User clicked on configuration icon on top right of organization tree

Purpose: The form is used to define main properties and upload the pictures for the factory floors.

Figure 8: Upkip Administration - Configure factory layout and floors

User can define:

To upload pictures for the factory floors:

Figure 9: Configure factory floors

Add machine to Factory Floor

Precondition: Machine is added in organization tree.

Purpose: Selected machine can be added to some of defined floors of the enterprise.

Figure 10: Add machine to factory floor

Select machine in organization tree. Click button Add to floor and select from menu one of the configured floors.

Figure 11: Organization - Add machine to floor

Connect animation with machine statuses

When machine is added to the floor and selected at the right appears Machine Data. Machine models is possible to develop with some animation.

Figure 12: Selected machine on the floor – Animations

In the section Animations is possible to select machine status to connect it with animation.

This means on the Factory Layout when machine has selected status the machine animation will be played.

There is possible to collapse and expand the main menu.

Collapsing the main menu increases the floor design area and shows all main menus only with icons.

Expanding the main menu shows all menus with icon and text.


Figure 13: Upkip Administration -collapse main menu

Figure 14: Upkip Administration - expand main menu

Actions with machine

Select machine on the organization tree/floor

Precondition: Organization tree with departments and machines is created. Machine is added to the factory floor.

When selecting machine in the organization tree:

Figure 15: Select machine from the tree - show machine selected on the floor

Figure 16: Select machine from the tree - shows machine properties

In reverse when selecting some machine in the factory layout floor, machine appears selected in the organization tree.

*Figure 17: Select machine on the floor - show machine selected on the organization tree

Move machine on the floor layout

Precondition: Click machine on the floor layout.

Clicking on the machine without releasing the mouse is possible to move the machine to another location on the floor area.

On Machine Data form X and Y positions are changed.

Figure 18: Factory floor - move machine on the floor layout

Pressing Save button will save the floor with last machine location.

Resize and rotate machine on the floor layout

Precondition: Click machine on the floor layout.

Machine models can be resized and rotated.

Figure 19: Machine model - resize or rotate

By clicking on (1) machine can be resized, by clicking on (2) machine can be rotated on the map.

When machines are located on their places on the floor map click button Save to save the created floor with machines locations.

Change machine floor

Precondition: Click machine on the floor layout.

Figure 20: Factory Design layout - move machine to other floor

From Machine Data change current floor from drop down.

Deselect machine on the floor layout

Precondition: Machine is selected on the floor layout.

Figure 21: Factory design layout - selected machine in the tree and on the floor

Deselecting machine is possible by clicking again on the selected machine.

Figure 22: Factory design layout - deselect machine by clicking on the selected machine

Deselecting machine is also possible also by clicking Refresh button at the top right of the organization tree.

Figure 23: Organization tree and layout - deselect machine by refresh

After clicking the Refresh button

View machine properties

Precondition: Machine is configured in organization tree.

Selecting different machines on organization tree at the right are shown tabs Floor (if machine is added to the floor layout), Properties, Tabs, Alarms.

Figure 24: Machine added to floor - tabs Floor, Properties, Tags, Alarms

Selecting tab Properties are visible machine properties. Selected model is visualized at the right.

Figure 25: Machine Properties with visualization model selected

For different machine types are configured different properties. To see machine properties go to Machine Types. For each machine type are shown configuration of the properties.

View machine alarms

Precondition: Machine is configured in organization tree.

Select machine in organization tree. Select at the right tab Alarms.

Figure 26: Machine Alarms

Selecting some alarm (or alarms) is possible automatically to create event, alarm and notification for these alarms. Go to Notifications from machine alarms.

There is indication with icon on the first column if for some alarm is created notification.

Actions with Factory Floors

View Configure all floors

Precondition: Factory floors are configured (Configure Factory Floors). Machines are added to factory floors and layout is saved.

Click on Configure icon at the top right of organization tree opens tabs: Configure and Factory layout are shown. In the factory layout is possible to go to different floors.

Figure 27: Factory layout - go to next floor

Zoom in and Zoom out

Precondition: Factory floors are shown at the factory layout area. It is possible to zoon in or zoom out the floor area to see better the machines and their locations. When mouse is over some machine the zoom is executed and machine remains at the center of the layout.

Change point of view on floor

Precondition: Factory floors are shown at the factory layout area.

Clicking on picture uploaded for factory floors is possible to move floors in the design map area to change point of view.

Save the floor layout

Precondition: Factory floors are designed with added machines.

Click on the Save button to save floors layouts.

Visualize Factory Layout

Precondition: Factory floors with machines are configured in Upkip Administration.

Log in Upkip Visualization following the steps in Upkip Visualization Sign in

Selecting from main menu Factory Layout opens dashboard Factory Layout.

To Factory Layout dashboard

Machine Tags and Alarms

Purpose: Machine tags are used for receiving data from machine. Received data is analyzed and used for visualization in different dashboards presenting by user friendly view the received data from machines. In the section are described functionalities:

Machine Tags

Precondition: Machine is selected in organization tree. At the right select TAGS.

Figure 28: Upkip Administration - Machine tags

Source of the tag indicates tag origin with specific icon before description:

Filtering machine tags – machine tags can be filtered by typing in the filter field

Figure 29: Machine tags - Filtering the tags

Created alarms for tags are indicated with icon in the first column after the Tag ID.

Figure 30: Machine tags - icon for created alarms from tag

Edit Tag

Precondition: Machine is selected in organization tree. At right select TAGS.

Select some tag and click Edit.

Tag with value type String has the following data:

Figure 31: Upkip Administration -Edit machine - Add new tag

Tag of type INT or Float has 3 additional fields – Min, Max and Set Point.

Figure 32: Upkip Administration -Edit machine - Add new tag Min and Max limits

`Min and Max fields are used to enter integers/floats for minimal and maximal value.

Set Point is used to enter the optimal value as integer/float.

Min and/or Max values can be used for create warnings for them following the steps

Add Tag

Precondition: Machine is selected in organization. Select tab TAGS.

To add new tag click New button and select menu Tag

Figure 33: Machine - Tags - Add new tag

Figure 34: Machine - Tags - Add new tag

When adding new tag user has to fill in data in the same fields as in Edit Tag.

Configure external sensor

Precondition: Machine is selected in organization. Select tab TAGS.

The external sensors can be connected to:

Data received from external sensors are visualized as charts showing min, max, average values and current values.

Upkip supports external sensors of the following types:

How to install external sensors is described in documentаtion Installer support/External sensors setup

To configure external sensors open menu Organization. Find machine under departments and select. Open Tags. Find the tag connected with external sensor by filtering.

Figure 35: Upkip Administration -External sensors connected to machine tags

Select tag and click Edit

Figure 36: Upkip Administration -Edit machine tag with connected external sensor

In addition to fields described in Add Tag tags connected to external sensors have attributes:

When adding tag connected to external sensor expand the drop down External source and select type of the sensors.

Figure 37: Add tag - Select external sensor type

When selecting type of the external sensors additional fields are shown for configuration.

ReMoni

When ReMoni sensors have been configured and data is confirmed to be flowing, then the next steps should be undertaken in our IIoT platform configuration portal. There are two types of data that can be integrated: data from sensors, and alarms. Alarms are generated within the ReCalc system per sensor. Which means that for the alarms of each sensor a separate dedicated tag should be created within the platform.

  1. Login, go to your organization and open your tree structure of organizational elements
  2. Create all appropriate hierarchy levels and leaf devices to adequately represent your real facilities. This should be done in a way that logically splits different objects in your environment. Usually each ReMoni sensor channel would be registered as a separate data tag for e leaf device. Thus it would make sense that the leaf device represents the object for which ReMoni sensors measure data.
  3. Select the desired leaf device and proceed to create a new data tag:

Figure 38: Select leaf device

For the new tag the following should be specified:

Figure 39: New data/alarm tag

Important: External source properties should be configured only once and if changed, they will affect all data tags with this type of external source.

Important: this type is intended for integration of sensor measurements.

Important: please get in contact with us if your Data Type is not listed.

Important: this type is intended for integration of sensor alarms. The alarms are generated automatically by the ReCalc platform. Please, refer to ReMoni documentation for more information.

Figure 40: ReMoni tag type

On the figure above the Create/Select Tag Type dialog is presented. Under “Available Tag Types”, you can filter to select an existing type that logically describes the data that the sensor will output. The Type ID should match with the Data Type that you have selected from above. If such a Type ID is not available, then create it. Description of properties:

Disruptive Technologies (DT)

After all DT Studio configurations have been done, the next steps should be undertaken in our Upkip Platform configuration portal.

  1. Login, go to your organization and open your tree structure of organizational elements
  2. Create all appropriate hierarchy levels and leaf devices to adequately represent your real facilities. This should be done in a way that logically splits different objects in your environment. Usually each DT sensor would be registered as a separate data tag for e leaf device. Thus it would make sense that the leaf device represents the object for which DT sensors measure data.
  3. Select the desired leaf device and proceed to create a new data tag:

Figure 41: Select leaf device and create new tag

For the new tag the following should be specified:

Figure 42: New DT data tag

Important: this type is intended for integration of sensor measurements.

Figure 43: DT Sensor details

Important: please get in contact with us if your Event Type is not listed.

Figure 44: DT Tag Type

On the figure above the Create/Select Tag Type dialog is presented. Under Available Tag Types, you can filter to select an existing type that logically describes the data that the sensor will output. The Type ID should match with the Data Type that you have selected from above. If such a Type ID is not available, then create it.

Description of properties:

El-Watch (EW)

After all El-Watch sensors have been configured to send data to the EW cloud, the next steps should be undertaken in our IIoT Platform configuration portal.

  1. Login, go to your organization and open your tree structure of organizational elements
  2. Create all appropriate hierarchy levels and leaf devices to adequately represent your real facilities. This should be done in a way that logically splits different objects in your environment. Usually each EW sensor sends multiple types of data. For each sensor and each of its measurements, a separate data tag should be created ant attached to a leaf device. Thus it would make sense that the leaf device represents the object for which EW sensors measure data.
  3. Select the desired leaf device and proceed to create a new data tag:

Figure 45: Select leaf device and create new tag

For the new tag the following should be specified:

Figure 46: New EW data tag

Important: this type is intended for integration of sensor measurements.

Important: please get in contact with us if your Data Type is not listed.

Figure 47: EW Tag Type

On the figure above the Create/Select Tag Type dialog is presented. Under Available Tag Types, you can filter to select an existing type that logically describes the data that the sensor will output. The Type ID should match with the Data Type that you have selected from above. If such a Type ID is not available, then create it.

Description of properties:

NeuronSensors (NS)

After all El-Watch sensors have been configured against the new version of their platform to send data to the EW cloud, the next steps should be undertaken in our IIoT Platform configuration portal.

  1. Login, go to your organization and open your tree structure of organizational elements
  2. Create all appropriate hierarchy levels and leaf devices to adequately represent your real facilities. This should be done in a way that logically splits different objects in your environment. Usually each NS sensor sends multiple types of data. For each sensor and each of its measurements, a separate data tag should be created ant attached to a leaf device. Thus it would make sense that the leaf device represents the object for which NS sensors measure data.
  3. Select the desired leaf device and proceed to create a new data tag:

Figure 48: Select leaf device and create new tag

For the new tag the following should be specified:

Figure 49: New NS data tag

Important: this type is intended for integration of sensor measurements.

Important: please get in contact with us if your Data Type is not listed.

Figure 50: NS Tag Type

On the figure above the Create/Select Tag Type dialog is presented. Under “Available Tag Types”, you can filter to select an existing type that logically describes the data that the sensor will output. The Type ID should match with the Data Type that you have selected from above. If such a Type ID is not available, then create it.

Description of properties:

NCD

After all NCD sensors have been configured to send data to our internal Azure IoT Hub, the next steps should be undertaken in our IIoT Platform configuration portal.

  1. Login, go to your organization and open your tree structure of organizational elements
  2. Create all appropriate hierarchy levels and leaf devices to adequately represent your real facilities. This should be done in a way that logically splits different objects in your environment. Usually each NCD sensor, according to its type, sends multiple types of data. For each sensor and each of its measurements, a separate data tag should be created ant attached to a leaf device. Thus it would make sense that the leaf device represents the object for which NCD sensors measure data.
  3. Select the desired leaf device and proceed to create a new data tag:

Figure 51: Select leaf device and create new tag

For the new tag the following should be specified:

Figure 52: New NCD data tag

Important: this type is intended for integration of sensor measurements.

Important: please get in contact with us if your Data Type is not listed.

Figure 53: NCD Tag Type

On the figure above the Create/Select Tag Type dialog is presented. Under “Available Tag Types”, you can filter to select an existing type that logically describes the data that the sensor will output. The Type ID should match with the Data Type that you have selected from above. If such a Type ID is not available, then create it. Description of properties:

OpenWeatherMap (OWM)

After a successful registration has been made on the OWM site, the next steps should be undertaken in our IIoT Platform configuration portal.

  1. Login, go to your organization and open your tree structure of organizational elements
  2. Create all appropriate hierarchy levels and leaf devices to adequately represent your real facilities. This should be done in a way that logically splits different objects in your environment. Usually the weather data is defined as a fictive device under a node called Environment/CityName.
  3. Select the desired leaf device and proceed to create a new data tag:

Figure 54: Select leaf device and create new tag

For the new tag the following should be specified:

Figure 55: New OWM data tag

Important: this type is intended for integration of sensor measurements.

Important: please get in contact with us if your Type is not listed.

Figure 56: OWM Tag Type

On the figure above the Create/Select Tag Type dialog is presented. Under “Available Tag Types”, you can filter to select an existing type that logically describes the data that the sensor will output. The Type ID should match with the Data Type that you have selected from above. If such a Type ID is not available, then create it.

Description of properties:

Delete Tag

Precondition: Machine is selected in organization tree. TAGS tab is selected at the right.

Select some tag and click Delete.

Figure 57: Tags - Delete tag confirmation

Import tags from file

Tags for machine could be imported from CSV. Select tab +Provision for machine. TAB is visible only for users with role system administrator.

Upload CSV file with description for each tag: name, valueType, (PayloadType),(DisplayName)

Figure 58: Upkip Administration -Edit machine - Import tags

Preview and manage tags

Precondition: Machine is selected in organization tree. TAGS tab is selected at the right. Click on Preview Data button.

Figure 59: Tags list - Open Preview Data

Figure 60: Preview Tags form

Purpose: Preview and manage tags form allows for a user system administrator to:

Clicking on the Search button the form is loaded with all machine tags with their data for the selected time period.

Figure 61: Tags - Preview Data

Tags are shown in the table with:

Source of the tag** indicates tag origin with specific icon before description:

Filtering the tags is possible by the following options: All, Empty tags, Tags with data, Disabled tags. Filtering the tags is possible also by typing in the filter field.

Figure 62: Preview Data - filtering tags

Filtering by Empty tags – there are shown only tags without any data for the selected time period.

When selecting Tags with data – in the form are listed only tags with data for the selected time period.

Some tags is possible to select by checkboxes and disable by clicking Disable tags button.

Figure 63: Preview Tags - Disable tags confirmation

If filter tags with Disabled tags from the filter is shown list of disabled tags. At the bottom are visible buttons Delete tags and Close. If select tags that do not have events or calculated tags is shown confirmation popup. It clicking Delete button the tag is deleted. There are possible to select many tags and delete.

Figure 64: Preview Tags - Delete tag confirmation

If tag or tags have events of calculated tags in the confirmation warning are listed events or calculated tags with selected tag and is offered to replace tag in events or calculated tag with another tag. After selecting another tag is possible to delete selected tag.

Figure 65: Preview Data - select tag to replace and delete tag

Tags Browser

Purpose: Tags browser functionality is developed for specific adapters. From the machine tags list by clicking Load Device Tags is opened form with loaded tree with tags from the adapter server. User can select some tags, view or change tag name, type, payload or display name and Save.

Note: To use the functionality machine configuration has to be added in the gateway adapter Module Twin Desired Properties JSON configuration. То adapters configuration.

Select machine in organization tree and click TAGS. At the bottom is visible button Load Device Tags. Clicking on the button is opened form for browsing and importing tags from the adapter server.

Figure 66: Machine tags list

OPC UA Tags Browser

Precondition: Мachine is connected to the OPC UA adapter. Adapter is implemented as Windows module in IoT Hub>IoT Device or module in Linux device in IoT Hub > IoT edge devices.

To add machine configuration in adapter module desired properties configuration:

"ws350": {
	"DiscoveryUrl": "opc.tcp://ws206.icb.bg:51212",
	"SessionChannelTimeout": 30000,
	"PublishingInterval": 60000,
	"KeepAliveCount": 30,
	"LifetimeCount": 30,
	"PublishingEnabled": true,
	"UserName": "",
	"Password": "",
	"SamplingInterval": -1,
	"QueueSize": 0,
	"DiscardOldest": true,
	"QualityControl": {
		 "Characteristics": "2:Robot1\_Axis1",
		 "SerialNumber": "2:Robot1\_Axis2",
		 "Order": "2:Robot1\_Mode",
		 "Operation": "2:Robot1\_Speed",
		 "OrdPosCombined": false,
		 "OrdPosSeparator": "-",
		 "Event": "Always",
		 "HandshakeTag": "",
		 "Position": "2:Robot1\_Speed"
	}
}

Select machine in organization tree and click TAGS. Click button Load Device Tags.

Figure 67: OPC UA Tags browser

At the top are visible device adapter, device module and machine ID.

  1. There is loaded tags tree from device adapter.
  2. User can select some tags and click Import tags button
  3. In the selected tags list user can change Name, Type, Payload, Display name

Figure 68: Tags browser - edit tags properties

  1. Click Save.
  2. Before saving is possible to delete some rows with selected tags by Delete Row button and importing tags again.

After successful saving appears Create Tags message.

Figure 69: Tags browser - create tags successfully

If trying to duplicate some tag by name or payload appears Duplicates found message.

Figure 70: Tags browser - duplicates found

After successful import:

Figure 71: Machine tags with imported tags

"dataItemsToMonitor": {
	"ws350": "2:Robot1\_Axis1,2:Robot1\_Axis4,2:Robot1\_Axis3"
}

OPC Classic Tags Browser

Precondition: Machine is connected to the OPC Classic adapter.

To add machine configuration in adapter module desired properties configuration:

"opc_cl": {
	"UrlNoProtocol": "DEV-204/Matrikon.OPC.Simulation.1/{f8582cf2-88fb-11d0-b850-00c0f0104305}",
	"SamplingRate": 500,
	"AlarmsAndEventsFilters": {
		"LowSeverity": 1,
		"HighSeverity": 929,
		"Qualities": "\*",
		"Types": "\*",
		"Sources": "\*"
	}
}

Select machine in organization tree and click TAGS. Click button Load Device Tags

Figure 72: OPC Classic Tags browser

User can select tags from adapter server tags tree and import them to machine tags list.

"SensorDataItemsToMonitor": {
	"opc_cl": "Random.Int1,Random.Int4,Random.UInt2,Random.Int2",
	"ws360_opccl": "Random.Int1,Random.Int2"
}

MTConnect Tags Browser

Precondition: Machine is connected to the MTConnect adapter. MTConnect Adapter supports connection with machine and collect data. MTConnect Agent supports connection with set of adapters and buffers data. MTConnectController collects data received from the agent and transfers data to cloud.

To add machine configuration in adapter module desired properties configuration:

{
  "mtcAgentSockets": {
    "main": {
      "URL": "http://127.0.0.1:5000/",
      "PollIntervalMS": 1000,
      "DataItemsToRequest": 10000
    }
  },
  "dataItemsToMonitor": {
    "M186": "path_position,block,line,f_command,SspeedOvr,avail,Fovr,execution,mode,system,program,program_comment,estop,message,tool_id,part_count,comms,logic,motion,servo,system,tool_group,(.\\d*)load,(.\\d*)speed,(.\\d*)servo,(.\\d*)travel,(.\\d*)overheat,run_time",
    "M45": "STATN,STATUS,DOWN,avail,PRGMN,PRGCU,BLKCU,PLCM1,PLCB1,PLCW1,PLCD1,P3515,STATT,MODEN,MODET,PRGSN,PRGST,OVRFD,OVRSP,OVRRP,ERRCL,ERRGR,ERRNO,ERRTX,TOOLN,TOOLI,TOOLA,TOOLL,TOOLR",
  },
}

Select machine in organization tree and click TAGS. Click button Load Device Tags

Figure 73: MTConnect Tags browser

User can select tags from adapter server tags tree and import them to machine tags list.

Machine Alarms

Edit selected machine from organization tree. Select tab Alarms

Figure 74: Upkip Administration - Edit machine - Machine alarms messages

There is possible to create automatically notifications from alarms by selecting alarms and pressing button Create Notification. Follow the steps in Notifications from machine alarms.

Created notifications from alarms are indicated with notification icon in the first column.

Figure 75: Machine Alarms - indication for alarms with notifications

Gateways

Purpose: Gateways are configured in Microsoft Azure as IoT Devices or IoT Edge devices and are installed on the computers in the manufacturer premises.

They acts as a Cloud Gateway which:

Precondition: Log in Upkip Administration with Microsoft user. Select Organization.

Select menu Gateways.

Figure 88: Upkip Administration - Gateways

For example, in the Upkip Administration are used the following gateways (IoT devices or IoT Edge devices)

In the Gateway/Properties are defined properties of gateway: Name, Device ID, Desired and Reported configurations. By clicking on button Edit Json is possible to edit gateway configuration written as json data. Reported configuration is returned by azure and is usually equal to desired configuration.

When selecting in Upkip Administration Gateways>Windows>Modules are listed the modules:

Figure 89: Upkip Administration - Gateway modules

In the Microsoft Azure>IoT Hub>IoT devices the following devices are created automatically:

The modules are run on the configured IoT devices.

For example: On the IoT device DUBUG-WS378-Win run the modules for different adapters: ABBRobotAdapter, BalluffAdapter, ExcelAdapter, FanucFocasAdapter, FanucRobotInterfaceAdapter, FanucRobot-Mazak218, M45-Heidenhain, MTCAgentAdapter, MTCCollectorAdapter, SiemensS7Adapter, SQLAdapter, ExcelAdapter.

Clicking on the configured device in azure are listed the modules running on it.

Figure 76: IoT Hub - IoT Devices

Figure 77: IoT Hub - IoT Device Modules

When selecting in Upkip Administration Gateways>Linux (Edge) >Modules are listed the modules:

Figure 78: Upkip Administration - Gateways - Linux modules

Gateway Linux (Edge) is configured on Azure>IoT Hub>IoT Edge device. Clicking on some IoT Edge device are listed modules that run on the device. For example: When clicking on the IoT Edge device ‘DEBUG-WS378’ are listed the modules:


Figure 79: IoT Hub - Linux IoT Edge devices

Figure 80: IoT Hub - IoT Edge Device modules

External sources

Purpose: Menu External sources allows to define new type of external sources (sensors) and properties to connect and fetch the data from the source. Data from the source can be received by two ways:

  1. Executing one or two API requests to extract the source data
  2. Receiving data from the external source

Received input data are transformed by liquid json transformation template to Upkip internal data format.

Machine tags are connected to selected external source and external data type with filled properties to fetch data from the source.

Configure external sensor

Precondition: Log in Upkip Administration as user with role system administrator or organization administrator.

Select menu External Sources.

  • There is opened form to define a new external source (sensor)
  • The new source is defined by name and label
  • The necessary properties to connect to source are possible to add
  • For each source is possible to define data types
  • To fetch data of specified data type is possible to add different properties
  • The API Endpoint definitions is possible to specify
  • Liquid template for json transformation is possible to specify to convert source data to Upkip internal data format https://shopify.github.io/liquid/

Figure 81: Upkip Administration - External sources

Add external source and tag type

Sources and their data types are configured in a tree view structure.

Figure 82: External sources - Add new Source or Tag Type

By clicking Add button and selecting menu Source (1) is opened form – Add External source. New external source is added by Name and Label. Label appears in the tree.

Figure 83: External sources - Add new external source

Selecting some source in the tree and clicking Add button and selecting menu Tag Type is added new tag type of the source. New tag type is added by Name and Label. The Option “Data will be fetched from external API” can be checked or not.

Figure 84: External sources - Add new tag type for source

Add source properties

Source properties are used to connect to the source.

Precondition: The source is added in the tree. Select source in the tree.

Click on the button Add new Property (1)

New property of the source is added by Name and Label (2). The label appears in Add/Edit Tag form when external source is selected from dropdown. Configure external sensor

Figure 85: External source - Add new source property

After adding a new source property it appears in the source Settings form (3).

Add tag type properties

Precondition: Tag type of the source is added by Add/Tag Type.

Select tag type of the source in the tree (1). Tag type Settings form is opened.

Figure 86: Tag Type Settings - Add tag type property

Click button Add New Tag Type Property (2)

Tag type is added by Name , Label and Data Type selected from Primitive or Dropdown.

When dropdown is selected the values of the dropdown are added.

Figure 87: External source - tag type dropdown property

Entered dropdown values for tag type property can be edited.

Verity API Endpoint template

In a tag type settings are specified Api Endpoints including template or only Template.

Template is used for liquid json transformation of input message json to Upkip internal data format https://shopify.github.io/liquid/.

Click the button Verify API Endpoint.

In the Verify API Endpoint template form at the left paste json with input message from the source.

At the right is template for liquid json transformation. Click on the Verify button is possible to verify template for json transformations of input data.

Figure 88: External source - Verify API Endpoint template

Delete source and tag types

Select some source in the tree. Click button Delete and select menu Source

Figure 89: External source - Delete source confirmation

Select some Tag Type in the tree. Click button Delete and select menu Tag Type

Figure 90: External source - Delete tag type confirmation