UpdateAreaModel

The
UPDATEAREAMODEL
 execute compares the running area model with the given area model and loads the given area model if changes are permitted.
The following table shows the format and return for this execute.
Format and return for UPDATEAREAMODEL
Item
Description
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[UPDATEAREAMODELS (
Item,UserID,AreaModel
)]
where
  • Item: The item name, as specified by the client.
  • UserID: User identification associated with this event.
  • AreaModel: Name of the updated area model .cfg file.
Action
A successful UPDATEAREAMODELS request processes s the command, comparing thearea models, and updates the area model if changes are permitted.
Return Format
The item populates with this data:
SUCCESS:
<CompareResult>_\t<LogFile>
| FAIL:
<message>
where:
Field and format descriptions
Field
Format
Description
<CompareResult>
ASCII – Integer
1=Same
2=Area Model Updated Successfully
3=Differences Not Allowed
<LogFile>
ASCII - String
Log file that contains the differences between the two area models compared.
The following table shows an example of the return on this execute.
An execute string consisting of:
UPDATEAREAMODEL (Item, STATION7, ice_cream1_updated.cfg)
Could return:
SUCCESS:2 \t \\BTCHSYSWEST001\FTBATCH_PROJECTS\SAMPLEDEMO1\LOGS\UPDATED_ICE_CREAM1_UPDATED.CFG.2017-08-29_T1717370254.LOG
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal