Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Close ends an open import session.  This has no effect on databases because all actual import action is in a transaction within begin and end (or cancel), but it can change the state of the targeted engines. 

...

A close request can include the following arguments.

Argument      

Type                    

Description

step

string

(Required) The Close argument.

respond

string

(Optional) A topic where the response object is expected. The response topic is allocated by the initiator. The topic must be within the feedback channel for this segment to allow communication across bridged message brokers.

Example:
glp/0/{SID}/fb/=export-tool/import/response

meta

any

(Optional) If provided, the meta data is returned with the response.

protocols

list of strings

(Required) A list of affected edge protocols using standard IAP/MP protocol identifiers.

Example:
"lon" for LonWorks.  

reason

string

(Optional) If provided, this gives a reason for closing and is used in log files or for similar diagnostics.

Example:
“Not all protocol engines were available for importing.”

option

object

(Optional) The option argument is either undefined, or an object whose keys equal an IAP/MQ protocol identifier. 

See option argument under Import Open for more details and an example.

...