The Java-Coded Business Services section of the API Designer
- Joël DRIGO
This section of the API Designer allows you to have the list of extension components (API Business Services) and their status and can be accessed from the main menu, via the following option:
This page shows the components detected in plugins marked as activated, but not necessarily fully started.
This page displays each detected component by line with four main information:
the plug-in name (the one who provides the extension)
the name of the implementation class of the component
the type of extension service, in the form of the corresponding interface
the name of the library that contains the class (the name of the jar)
For each of these information icons indicate the status.
Status of plugin
near the name of the plugin
 | This icon (on the right) gives you the version number and date of the plug-in (displayed in its tooltip) |
This icon indicates that the plugin is detected, started and functional | |
This icon indicates that the restapibs.jar file of the plugin does not have the same date as the WXM_RESTAPI file. This does not necessarily mean that it is not the right version, but it can be a clue in case of malfunction. | |
This icon indicates that the version of the restapibs.jar plugin is not the same as that of WXM_RESTAPI. Some components may be compatible between versions, but in case of malfunction, updating the plugin jar may be the solution. | |
This icon indicates that the component is well detected but that there is no installer configured (see here): it is therefore ignored and will not be executed. This icon can also indicate that there are several installers in the same plugin: it is necessary to have one and only one. If several installers are used, this can cause malfunctions: usually the components are disabled. Configure only one installer per plugin. | |
This icon indicates that there is a problem with the restapibs.jar file. It is too old and it is necessary to update it with the latest version. | |
This icon indicates that there is no problem detected with the restapibs.jar, and that there is only one installer, but the plugin is being started and it is not possible to completely determine the status of all components. Wait a while, and refresh the page. |
Status of the component
near the name of implementation class
This icon indicates that the component is started and operational | |
This icon indicates that the component has not been started. The error may be due to
Check the logs for exceptions. | |
This icon indicates that this component is disabled (see the plugin status to know why) | |
This icon indicates that the state of this component cannot be determined (the plugin is probably | |
This icon indicates that this component is of a type that is no longer supported. |
The number that appears in brackets after the name of the component class corresponds to the number of references to this component. The references are the configuration points that explicitly refer to the component (by the plugin name and the class name).
Component type status
near the name of the interface
This icon indicates that this component is of a type that is no longer supported. |
restapibs.jar JAR status
near the name of JAR
This icon (on the right) gives you the version number and date of the plug-in (displayed in its tooltip). If an alert is given on the version or date, the tooltip also indicates the corresponding reference values. | |
This icon indicates that no problems have been detected with the jar. | |
 | This icon indicates that the jar is not up to date (in a version prior to 2022.3, and therefore no longer compatible with this version of the engine). |
This icon indicates that the jar version is different from the WXM_RESTAPI plugin version | |
This icon indicates that the jar date is different from the WXM_RESTAPI plugin date |
Summary
An overview of the status of the components can be obtained in the status section, through the entry "Contributions".
Examples:
Â