iCore Events from iCore API

The iCore API lets you create standard iCore Events as well as express Events using COM interface technology. Retrieving data from iCore via the API requires that the Scripts you run have been specifically created for the API. With the right Scripts, the iCore API enables you to retrieve large amounts of data asynchronously.

The iCore API consist of two interfaces, IEICoreAPI and IEICoreAPI2. IEICoreAPI2 is queried from IEICoreAPI and has additional methods supporting the express call to Adapterflows.

Considerations when creating Scripts communicating with iCore API

Internally, the iCore API uses Microsoft Message Queue (MSMQ) to retrieve result data from the iCore system.

note

MSMQ only supports messages that are smaller than 4 MB. Any attempt to send a message larger than this will cause an "insufficient resources" error.

Note that Unicode data takes up twice as much space as non-Unicode data, as two bytes are needed for each character. We therefore recommend splitting up Unicode messages in smaller parts before sending them to the iCore API. To receive a message with multiple data and assemble the message after all message data has been received, the iCore API client uses calls. Examples of such calls are: Call_WaitForMultipleData and Call_WaitForMultipleDataEx.

The same consideration must be made when using iCore API via its web service interface or iCore Invoke (iCore Invoke uses iCore API methods internally).

Interfaces

Name	Description
IEICoreAPI	Version 1.
IEICoreAPI2	Version 2, supports calls to standard Events, express calls to Components and express calls to Adapterflows