RunCodelistInterfaceService macro at system level
The RunCodelistInterfaceService macro is used to run an interface service that imports or exports the code list elements.
For executing the macro, the value in the Command field must be specified in this format:
RunCodeListInterfaceService(Interface Service Name, Direction, [Reject all on error], [Time out],[Data Source])
Note: The optional parameters are specified in [ ].
This table lists the parameters that are used to determine the interface service to be executed:
Parameter Name | Description |
---|---|
Interface Service Name | The name of the interface service to run.
Note: The Data Entity must be set to Code List. The data entity type is verified when the selected interface service is executed.
|
Direction | Indicates the direction of the data flow. Possible values:
|
Reject all on error | Indicates, if the macro execution stops in case of an error. This parameter is applicable only when Direction is set to Import. Possible values:
Note: This value is considered as False, if not specified.
|
Time out | The time, in seconds, to wait for the setup check or other blocking processes (if currently processing) to complete.
Note: If this value is not specified, the waiting period is indefinite.
|
Data Source | An alternate data source for which the interface service is executed.
Note: The Data Source must be of the same type as defined in the Interface Service.
|
This table lists the examples of the RunCodelistInterfaceService macro:
Requirement | Syntax |
---|---|
Execute code list interface service Import My Items with Direction = Import, and process until completion of the import source data. | RunCodeListInterfaceService("Import My Items","Import","","","") |
Execute code list interface service Import My Items with Direction = Import, and exit if any data error occurs. | RunCodeListInterfaceService("Import My Items","Import","True","","") |
Execute code list interface service Export My Items with Direction = Import, and with an indefinite time out. | RunCodeListInterfaceService("Export My Items","Export","","","") |
Execute code list interface service Export My Items with Direction = Import, and with a time out of 600 seconds if unable to execute the interface service. | RunCodeListInterfaceService("Export My Items","Export","","600","") |
Execute code list interface service Import My Items with Direction = Import, and process until completion of the import source data from the Master SCV Data Source. | RunCodeListInterfaceService("Import My Items","Import","","","Master SCV") |