Overview¶
Items
About External Software Connection Module¶
it is a module to coordinate or connect intra-mart and external software easily like call and directly using various API of im-BizAPI from generic application packages.To coordinate or connect, there are 2 methods as below.
- Use this "connection API connector" to connect a process with im-BizAPI.
- Use Web service to call API of im-BizAPI from external software.
"Connection API Connecter" is provided as Java based API to connect with im-BizAPI, thus if the external software has Java execution environment, it can im-BizAPI with a process.For example, displaying intra-mart screen in a portal screen by combining with a generic portal server product, or operating user account information from original Java process that connects with other applications and batch operates are possible.Column
This section does not explain how to call API of im-BizAPI by Web service.
Specifications¶
Interface of the external software connection module is a Java class. Therefore, applications to be connected needs to be able to use Java interfaces.Also because Java interfaces are used, the environment that the module operates in needs to have java-VM.The connecter class for connection works with intra-mart Accel Platform through network. Thus the environment needs to have network available as the precondition.However, as API controls the network connection by URL, the developers does not need to consider the network directly.The connecter execute HTTP connection against intra-mart Accel Platform. For URL to be designated for the connection, designate the exclusive servlet path (/imart/HTTPActionEventListener(standard))
Network shall be resolved by URL designated to API, but the URL needs to have the following precautions depending on the operation configuration.
- If intra-mart Accel Platform is operated stand-alone, connection URL to the stand-alone server needs to be specified.
- If intra-mart Accel Platform is operated in distributed environment, connection URL to the Web Server should be specified.
Structure of external software connection module¶
The external software connection module is structured by 2 modules, the server side module and the client side module.
Module name Class archive Descriptions External connection client imaca_client-XXX-main.jar It is a client side logic to be placed in the external software on the calling side. External connection/ authentication/ authorization imaca_provider-XXX-main.jar It is a server side logic to be placed in intra-mart Accel Platform.