Space banner This documentation supports the 20.02 version of BMC Digital Workplace Advanced.To view the latest version, select the version from the Product Version menu.

Implementing the Activity Log Service Provider Interface


Tip

Click here to download the JSON (JavaScript Object Notation) snippets included in these topics, and customize them to use according to your requirements.

The Activity Log SPI is a subset of the remote connector SPIs that a connector can implement to support business features of BMC Digital Workplace Catalog beside the initial handshakes (descriptors, health checks) and actions (because each action is, in a way, specific to its connector).

Activity Logs

Activity logs are comments associated with service requests and their external activities. Each can have attachments like images or documents.


Capability:

 com.bmc.dsm.catalog:activityLogProvider


The activity log SPI enables a connector to allow its external activities to send and receive activity logs (comments) to and from service requests. This means that an activity log provider also needs to be an activity provider.


Here is a typical high-level scenario:

  • A remote connector indicates that it is an activity provider and an activity log provider (with appropriate action descriptors).
  • As part of the fulfillment workflow of a service request, an external activity is created through an action of the remote connector. From thereon, BMC Digital Workplace Catalog tracks its status.
  • The requester posts a comment on the service request.
  • The corresponding activity log is then sent to the external activity via the connector. The connector returns a reference to the activity log created externally in the integration target.
  • BMC Digital Workplace Catalog regularly polls activity logs of external activities via the connector. The connector returns all the activity logs that it finds along with their external references. BMC Digital Workplace Catalog copies these activity logs and associate them with the corresponding service request, while avoiding duplicates by comparing external references (the ones it received and the one it already received in the past).
  • The federated activity logs from the different sources are now available to the users of BMC Digital Workplace Catalog.

Activity Log SPI





 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*