Import Action
- Sacha Parisot (Unlicensed)
The segment do actions include an import action to import system configuration data, such as the definition of devices, datapoint connections, or schedules into an existing system, typically sourced from another system that is not defined with IAP/MQ.
The principal import steps include an open/close pair, begin/end pair, and begin/cancel pair, and a begin/end/cancel triplet to define a transaction. The session is opened with "open". This allows the segment to suspend certain services for the duration of the import, or to condition an affected protocol engine. Once finished, the session is closed with "close." A successfully closed import session resumes normal segment operation. Services that may have been suspended during the session resume at this time.
A transaction is wrapped within a begin/end or begin/cancel pair. Within the transaction, data is imported through a series of IAP/MQ actions and property assignments, such as device “create” actions and so on.
The import action supports the following steps:
| Step | Description |
|---|---|
| open | Use open to open a session. This allows the edge server to suspend certain services for the duration of the import, or to condition an affected protocol engine. See Import Open for a descriptions of its arguments and responses. |
| close | Use close to close a session after the session finishes. A successfully closed import session resumes normal edge server operation. Any services that were suspended during the session resume at this time. See Import Close for a descriptions of its arguments and responses |
| begin | Use begin to start a transaction. Transactions are wrapped within a begin/end or begin/cancel pair. Within the transaction, data is imported through a series of IAP/MQ actions and property assignments, such as device “create” actions. See Import Begin for a descriptions of its arguments and responses |
| end | Use end to denote the end of a transaction. See Import End for a descriptions of its arguments and responses |
| cancel | Use cancel to stop a transaction. See Import Cancel for a descriptions of its arguments and responses |
| ping | Use ping as a test. See Import Ping for a descriptions of its arguments and responses |
Arguments and Responses
For a description of the supported arguments and responses for each step, follow the links indicated in table above.