Skip to main content

Widgets

See the history and results of the API transactions in Proactis

To obtain a high level of self-service Proactis has created various widgets in the Proactis application. These widgets allow users to view API traffic and results.

How to add widgets

Like other widgets, the integration widgets can be added by clicking the Add widgets button on your Proactis dashboard. This will display a new windows listing the available integration widgets. Add the widget which serves your purpose.

info
  • Integration widgets are only available to administrators. Contact your application manager for access.
  • Widget data is automatically removed after 30 days.

Notifications

To keep track of errors without having to monitor the widget contents, each widget has the option to subscribe to errors. A notification will be sent by email for each error. Add up till 5 email addresses to each widget.

Incoming Requests widget

The incoming request widgets lists all requests accepted by the API. Amongst other things you can see the HTTP status code and the complete HTTP headers and payload. Clicking on the </> button will show the complete request and response including HTTP-headers and payload.

Outgoing Request widget

This widget will show all requests originating from Proactis to the customer application or suppliers. It will for example show the endpoint and status. Clicking on the </> button will show the complete request and response including HTTP-headers and payload.

Other widgets

Specific message types have their own widget. Each widget shows information about processed messages, how it links to Proactis objects and the status of the import or export.

Click the available links to check out the error message or response, or click the buttons for additional actions.

Widget actions

Widgets show information about each request. Depending on the widget and status of the request additional buttons can appear.

IconDescription
View the source of the incoming or outgoing message.
Open the PDF version of the order. This button is only available on the order export widget.
Remove the message from the widget list.
Resent the message. This button is only available when the Status is Error.

View source

Clicking the View source button will open a new window showing the source of the request. You can use this to check the imported or exported message.

Open PDF

The order export widget has the option to open the PDF-version of the order. This is the same PDF which is also sent to the supplier (when the order is sent by mail) or is available on order level in the Proactis application.

Delete

Clicking the Delete button will remove the current line from the widget. It will not have any effect on already received or sent messages, it will just cleanup the widget.

Retry

Whenever a message was not exported or imported due to a failure the message can be reprocessed by clicking the Retry button. An imported message will be reprocessed, depending on the result the Status will change. Exported message will be resent to the receiving party and the Status will be updated according to the final result.