EM Web Services and EM Notification Services

These features provide means for retrieving submission metadata from an EM publication site without logging in directly to EM. The two features can be used in combination to enable communication between a publication’s EM site and a trusted third-party system.

EM Web Services

EM Web Services can be used to request submission-related metadata via an API call to an EM site. Authentication credentials are used to verify access to the EM site through Web Services.

EM Notification Services

EM Notification Services can be used to send notifications via API from an EM site to one or more predefined endpoints at specific workflow events. Notifications contain select submission metadata. When EM Notification Services is enabled, EM workflow events can be used to trigger specific actions in an integrated third-party system.

Notification Services Monitoring Report

Editors with permission will see a Notification Services Monitoring Report link on the Editor Main Menu. The report enables the user to access information about messages sent out to endpoints configured for the publication. The search tool allows the user to search by endpoint, subscribed event, message status, message GUID, document ID, manuscript number, or notification creation date.

To configure:

For more information and to enable EM Web Services and EM Notification Services, contact your Aries Account Coordinator.

For EM Notification Services, API endpoints must be configured and assigned to workflow events in AdminManager.

Go to AdminManager > Configure Endpoints for Notification Services. Use the Configure Endpoint Details page to define all endpoints that should receive notifications at workflow events:

Click Create New Endpoint button to open a pop-up window.
Enter endpoint name.
Enter endpoint URL.
Click Submit on the popup.
Repeat steps 1 - 3 for all endpoints.
When all endpoints are entered, click Submit on the page.

Existing endpoints may be edited or hidden (i.e., made unavailable for future use). Endpoints may also be placed On Hold, meaning notifications are created and held in a queue; the queued-up notifications are sent when the On Hold status is removed.

Go to AdminManager > Configure Notification Services. Assign one or more endpoints to workflow trigger events:

For the applicable event, click Add New Endpoint link to open a pop-up window.
Use the drop-down list to select an endpoint. (The list shows all active endpoints as configured above.)
Use POST body: Check this box to use a POST call with body parameters (instead of POST call with query string parameters).
Click Submit on the popup.
Repeat steps 1 - 3 to add additional endpoints to the same event.
When all event-endpoint pairing configurations are complete, click Submit on the page.

Existing event-endpoint pairs may be edited. Click the Remove link next to an endpoint to immediately remove it from the list of endpoints notified for an event.

To grant access to the monitoring report, go to RoleManager > Editor Role. Grant permission to the applicable Editor roles:

Access Notification Services Monitoring Tool