DRALineUpdate Business Logic Tier (BLT)
- Last UpdatedApr 24, 2025
- 2 minute read
The DRALineUpdate is a Business Logic Tier (BLT) that can be used to update a DRALine. Using this BLT, you can enable or disable the Automatic Mode flag of a DRALine. We can also use this BLT to set a required flow rate range or reset the flow rate range to 0 for a DRALine.
The following table details the input parameter for the DRALineUpdate BLT.
|
Argument |
Type |
Description |
|
draLineId |
Integer |
This integer type is the ptnum for the DRALine which can be obtained from DRALine table in the RealTime database (RTDB). |
|
changeAutomaticMode |
Boolean |
Boolean type can be set to True or False. If this field is set to True, it will enable or disable the DRALine Automatic Mode Field based on the value provided in automaticModeEnabled input. Note: When this field is set to True, changeFlowRate must not be provided in the input. If both are provided, you will receive an error message that reads: Only one update can be accomplished per request. |
|
automaticModeEnabled |
Boolean |
This will reset the Automatic Mode checkbox to enabled or disabled. This will work only if ChangeAutomaticMode field is set to True and changeFlowRate must not be mentioned. |
|
changeFlowRate |
Boolean |
The boolean type can be set to True or False when changeAutomaticMode is not provided in the input. If both are provided, you will receive an error message that reads: Only one update can be accomplished per request. |
|
flowRateId |
Integer |
Refer to the DRAFlowRateRange RealTime table to obtain the ptnum for the range required. Changing the flow rate at the level of the DRALineUpdate will override the value in the DRAGroupUpdate. Accordingly, the optional parameter will be passed to set the new flow rate range for the selected DRALine. |
The following table details the Output parameter for the DRALineUpdate BLT.
|
Argument |
Type |
Description |
|
Success |
Boolean |
Indicates whether the request has been successfully processed. |
|
Message |
String |
If the request could not be successfully processed, this field will contain a message indicating the reason for the processing failure. |
The following example demonstrates resetting the flow rate using an existing BLT.
The DRALineUpdate BLT can be used to pass the required parameter using the information displayed in the screenshot below. This screenshot demonstrates updating the flow rate to 201-300 (the ptnum value from DRAFlowRateRange for 201-300 is three [3]). Depending on the parameter values you have selected, it can reset the flowRateId and automaticModeEnabled flag.
