UCM REST Publish Service

UCM can publish message in XML or JSON format, based on Message Type specified for each registered system. For systems with SOAP Message Type, UCM publishes the message in XML format; for systems with JSON Message Type, UCM publishes the message in JSON format.

In addition, you can configure a Middleware system with PROXY protocol, to publish message by invoking a business service method, and use Outbound REST Service UCMRESTPublish to publish message in JSON format.

To Configure Outbound REST Services

1. Navigate to Administration – Web Services > Outbound REST Services.
2. In the top applet Outbound REST Services, select UCMRESTPublish (if not exists, click on the Import button and import it from XML file.
3. In the bottom applet Service Methods modify the URL Address to point to your server and port number where the publish message will be sent.

To Configure Middleware System to Use Outbound REST Publish Service

1. Navigate to Administration – Universal Customer Master > System Registrations.
2. Create a new system, check the Middleware System flag, select PROXY as Protocol Type, and JSON as Message Type.
3. Drill-down on the System Id and select Publish / Subscribe tab in the bottom applet.
4. Create new record for each supported object (for example Account, Contact, FINCORD Account, or Household).
5. Pick a Publish Frequency value (example Real Time) and enter a valid End Date.
6. In the field Business Service select Outbound REST Service UCMRESTPublish.
7. In the field Business Service Method select the appropriate method for each object, see table below.

UCMRESTPublish has methods to publish JSON message for each supported object:

Object Name	Business Service Method
Account	publishOrganization
Contact	publishPerson
FINCORP Account	publishFinancialAsset
Household	publishGroup

The input argument for these publish methods is a REST Integration Object, one for each supported object:

Publish Method Name	REST Publish IO Name
publishOrganization	RestOrganizationPublishIO (based on SwiOrganizationPublishIO)
publishPerson	RestPersonPublishIO (based on SwiPersonPublishIO)
publishFinancialAsset	RestFinancialAssetPublishIO (based on SwiFinancialAssetPublishIO)
publishGroup	RestGroupPublishIO (based on SwiGroupPublishIO)

Note: If you want to publish additional child components or fields, add them to both REST and SWI Publish Integration Objects.