System-Integration¶
The system integration manages all business systems that are connected to the Business Bot Platform. A system integration module must be added and configured to establish a connection to the platform. The system integration module describes the business system to be connected and the connection parameters to exchange messages with a chatbot. The business system can connect using an unique system identifier and the API credentials.
A system integration module can only belong to one chatbot. However, multiple System Integration Modules can be set up on the same business system and multiple System Integration Modules can be assigned to a chatbot. In this case, a primary System Integration Module must be specified, which will act as message receiver.
The following figure illustrates the workflow:
API Credentials¶
The API credentials are provided for a tenant and are necessary to
connect the business system to the Business Bot Platform. You can find
the API credentials by navigating to System-Integration → API Credentials
The following information is required for the connection:
| Parameter | Example value | Description |
|---|---|---|
| Assigned to user account | UA-00001 (mail@citunius.de) | Identification of user account and e-mail |
| API Id | testuser | Unique API identifier |
| API Key | 987fds78fd | API Key |
| Valid until | 12/31/2019 11:11 AM | License expiration date |
| Name of the License | Community | License type |
| License Created | 12/10/2016 11:11 AM | Creation date of the license |
| Status | OK | Status of the license |
Integrated Systems¶
Add System Integration Module¶
You can add a system integration module using the following web form:
Navigation bar: System-Integration → Integrated Systems → Add System Integration Module
| Field | Example value | Description |
|---|---|---|
| Unique system identifier | NAGIOS-SYSTEM-001 | Unambiguous name for the system identifier |
| Description | Nagios Integration | Short description of the purpose |
| Which system should be connected? | BBPI-NAGIOS | System type e.g. BBPI-NAGIOS or BBPI-ENOVIA |
| Job processing queue | NagiosQueue | Queue for the system messages |
| Configuration status | Activated | Either Activated or Deactivated |
| Automatic start | Activated | Either Activated or Deactivated |
Modify System Integration Module¶
You can modify a system integration module using the following web form:
Navigation bar: System-Integration → Integrated Systems → choose item, then Actions [Settings]
Remove System Integration Module¶
You can delete a system integration module using the following web form:
Navigation bar: System-Integration → Integrated Systems → choose item, then Actions [Delete]
The user will be prompted to confirm the delete action.
Job Processing¶
The overview of the job processing lists all events from business
systems and instant messengers. You find the job processing view by
calling: System-Integration → Job Processing. In the upper left corner
of the table you have the option to select the desired queue for which
you want the events to be listed.
Notes
The list contains only events that were processed by system integrations,
but no events processed by widgets. If you want to view the event list for
all widgets, navigate to the menu item Job Processing in the navigation bar.