GetAreaModels
The
GETAREAMODELS
execute allows a client to get area models in the current running area model directory.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this
format:[GETAREAMODELS (
Item,UserID
)] | |
where: | Item | The item name, as specified by the client. |
UserID | User identification associated with this event. | |
Action | A successful GETAREAMODELS request obtains a list of area model file names and
timestamps located in the current working directory. | |
Return Format | The item populates with this data: SUCCESS:
<AreaModelList>
| FAIL:
<message>
| |
where: | ||
Field | Format | Description |
<AreaModelList> | ASCII - String | <NullList> | <FileData> | <FileData><AreaModelList> |
<FileData> | ASCII - String | <FileName>\t<FileTimeStamp>\crlf |
<FileName> | ASCII - String | Area model .cfg file. |
<FileTimeStamp> | ASCII - String | File timestamp in the format of Year.Month.Day.Hour:Minute:Second |
<Message> | ASCII - String | Explanation of why the execute failed to process. |
The following table shows an example of the return on this execute.
Example: | An execute string consisting of: GETAREAMODELS (Item, STATION7) Could return: SUCCESS:T1_AREAMODEL_REV01.CFG \t 2017.08.14 12:18:30 \crlf T1_AREAMODEL_REV02.CFG \t 2017.08.14 12:28:12 \crlf ICE_CREAM1.CFG \t 2017.08.14 12:43:00 \crlf ICE_CREAM1EP.CFG \t 2017.01.05 15:33:14 \crlf |
Provide Feedback