Configuring integration properties
The configuration required to set up the integration between Sterling™ Order Management System Software and Order Hub is explained in this topic.
| Property | Values | Description |
yfs.datapublish.target |
odx | Type of data exchange service. |
yfs.odx.baseurl |
Base URL for the data exchange service. | |
yfs.odx.tenantid |
Tenant ID used for the data exchange service. | |
yfs.odx.clientid |
Client ID used for the data exchange service. | |
yfs.odx.clientsecret |
Secret used for the data exchange service. | |
yfs.odx.event.publish.path |
/v1/events |
API URL of ODX event format. For example, shipNodeSync event. |
yfs.odx.ubxevent.publish.path |
/v1/events |
API URL of ODX event format. For example, order event and productSync
event. |
yfs.odx.oauth.path |
oauth2/token |
API URL for authentication. |
yfs.odx.oauth.default.token.refresh.mins |
525600 | Token refreshment time |
| The following properties are by default set appropriately. However, an SI can appropriately change the values by using SMA. | ||
yfs.ubx.integration.enabled |
Y or N |
Set the value to Y to enable the ODX integration at the hub
level.Note: If this property is set to
Y, it supersedes the "Enable ODX
Integration" rule, if set in the Sterling Business Center. However, if the property is set to
N, but the "Enable ODX Integration" rule is enabled in the Sterling Business Center, then the rule is considered. |
yfs.ubx.integration.providerurl |
file:///opt/SSFS_<OM veriosn>/runtime/OM_JNDI | These JMS properties are used by the application-provided SDF services that are used to publish events to ODX. |
yfs.ubx.integration.qcf |
AGENT_QCF |
|
yfs.ubx.integration.event.queue |
UBXIntgQueue |
|
yfs.yfs.buc.agents.providerurl |
file:///opt/SSFS_<OM veriosn>/runtime/OM_JNDI | These JMS properties can be used by the application-provided
asynchronous transactions such as REASSIGN_ORDER_RELEASE.0001. |
yfs.yfs.buc.agents.qcf |
AGENT_QCF |
|
yfs.yfs.buc.agents.queue |
BUCAgentsQueue |
|
| The following properties are configured for features such as Reassign to order, Reassign to node, and so on. | ||
yfs.ubx.integration.order.created.event.queue |
||
yfs.ubx.integration.order.changed.event.queue |
||
yfs.ubx.integration.order.shipped.event.queue |
||
yfs.ubx.integration.shipment.modified.event.queue |
||
yfs.ubx.integration.record.shortage.event.queue |
||
yfs.ubx.integration.shipnode.status.change.event.queue |
||
yfs.ubx.integration.config.fullsync.event.queue |
||
yfs.ubx.integration.capacity.availability.event.queue |
||
yfs.ubx.integration.master.fullsync.event.queue |
||
yfs.ubx.integration.master.deltasync.event.queue |
||
| Property | Values | Description |
yfs.ubx.connections.time.out |
5 seconds | Time out set for the http connection that is made to ODX. |
yfs.ubx.enable.implicit.connection.trust |
false | When the value is set to true, it disables the host name and certificate
validation checks for secure connections that are routed through remote APIs. |
yfs.ubx.max.connections |
200 | Maximum number of http connections per JVM. |
yfs.ubx.max.connections.per.route |
20 | Maximum number of concurrent http connections per route. |
yfs.ubx.max.file.size |
Maximum message size in KB that ODX allows in one http call. |