Modify Device

The Modify Device Action carries out 4 distinct tasks which can be selected from the Operation pull down

• Connect
• Modify
• Status
• Remove

Connect

The Connect Action registers a new device with the system from inside a business rule, as opposed to with the Devices page. This action is often used to allow users to register new devices using a form, so that they do not need to be granted access to the Devices page.

The same prerequisites for registering a Device manually with the Devices page still apply when creating a Connect Device action: a data gateway must be registered with the current account to listen for devices of a certain type; a device profile must exist registered to an existing gateway and associated with a resource type or group type if necessary; lastly, if the desired profile is associated with a group/resource type, an object of that type must be accessible at the current point in the logic chain of the routine.

• A Data Gateway must be registered with the current account to listed for devices of the desired type.
• A Device Profile must exist for the desired device type.
• If the Device Profile is associated with a resource/group type, an object of that type must be accessible at the current point in the routine.

If all these prerequisites are met, then it is very simple to create a Connect Device action to register a new device using the panel below:

The Connect Device option requires the following fields:

• Operation, should be set to "Connect"
• Device Code, the unique identifier of the device to be registered, often a serial number or other identifier included in the messages sent by the physical device.
• Device Type, Device Profile and Data Gateway, the type of device being to be registered, the profile dictating its communication, and the gateway to which the system will assign it.
• Installed On, a group or resource with which the system will associate the device.
• Process Duplicates, a setting defining system behavior when the user tries to add a device that already exists.
• Status, defines whether the new device is added as offline (disabled) or online (enabled), enabled is the default.

Modify

The Modify action allows users to programatically change an existing device settings including the device profile, what that device is installed on, what gateway it uses and status.

The device type and device ID is required to find the device and we have added the Result Variable Boolean which allows user to specify a local variable name for the result of the action

• True- Device was found
• False- Device was not found

This variable can then be referenced in the routine as ${_local._VariableName} in IfThenElse Actions for example

The Modify Device option requires the following fields:

• Operation, should be set to "Modify"
• Device Code, the unique identifier of the device you are searching for
• Device Type, the type of device you are searching for
• Results Variable, suggest to supply name for result of action
• Device Profile, the profile dictating its communication
• Data Gateway, the gateway to which you wish to assign the device to.
• Installed On, the group or resource with which you want to associate the device with.
• Status, defines whether the new device is added as offline (disabled) or online (enabled), enabled is the default.

Status

The Status action allows users to simply enable or disable status.

The device type and device ID is required to find the device and again we have the Result Variable Boolean which allows user to specify a local variable name for the result of the action

The Modify Device option requires the following fields:

• Operation, should be set to "Modify"
• Device Code, the unique identifier of the device you are searching for
• Device Type, the type of device you are searching for
• Results Variable, suggest to supply name for result of action
• Status, defines whether the new device is added as offline (disabled) or online (enabled), enabled is the default.

Remove

The Remove action deletes an existing device, removing it from the resource or group it was installed on.

The device type and device ID is required to find the device and again we have the Result Variable Boolean which allows user to specify a local variable name for the result of the action and ensure the remove action found the device.

The Remove Device option requires the following fields:

• Operation, should be set to "Remove"
• Device Code, the unique identifier of the device you are searching for
• Device Type, the type of device you are searching for
• Results Variable, suggest to supply name for result of action