Define integration properties in Sterling Order Management
We can use this information to define variables for communication services.
Task info
To set up communication between the WebSphere Commerce and Sterling Order Management, define the properties in the Sterling Order Management customer_overrides.properties file and run the setupfiles script before deployment. To use the setupfiles utility, run <INSTALL_DIR>\bin\setupfiles.cmd on Windows or <INSTALL_DIR>/bin/setupfiles.sh on Linux/UNIX. This sample customer_overrides.properties file shows all properties and their values, followed by a table that describes the services associated with these properties.
This procedure assumes to define queue variables for services related to all integration functions (order, inventory, pricing, promotion). For information about how to set up a Connection Factory for MQ, see the MQ V7.5 Knowledge Center. We can create Connection Factories using the JMS administration tool. This is a sample customer_overrides.properties file:
yfs.scwc.sdf.integration.providerurl=corbaloc::<SC_host_where_MQ_QFC_and_JNDI_names_are_defined>:<WAS_bootstrap_port> yfs.scwc.sdf.integration.apis.export.qcf=AGENT_QCF yfs.scwc.sdf.integration.apis.import.qcf=AGENT_QCF yfs.scwc.sdf.integration.apis.import.queue=inbounds yfs.scwc.sdf.integration.apis.createorderonsuccess.event.queue=outbound yfs.scwc.sdf.integration.apis.changeorderonsuccess.event.queue=outbound yfs.scwc.sdf.integration.apis.changeorderoncancel.event.queue=outbound yfs.scwc.sdf.integration.apis.confirmdraftorderonsuccess.event.queue=outbound yfs.scwc.sdf.integration.apis.sendinventorychanges.event.queue=outbound yfs.scwc.sdf.sendinventorychanges.service.url=http://WC_HOSTNAME:5080/webapp/wcs/component/inventory/services/InventoryServices yfs.scwc.sdf.sendorderchanges.service.url=http://WC_HOSTNAME:5080/webapp/wcs/component/order/services/OrderServices yfs.scwc.sdf.getOrderPrice.service.url=http://WC_HOSTNAME:5080/webapp/wcs/component/order/services/OrderServices yfs.scwc.sdf.getItemPrice.service.url=http://WC_HOSTNAME:5080/webapp/wcs/component/price/services/PriceServices yfs.scwc.sdf.validateCoupon.service.url=http://WC_HOSTNAME:5080/webapp/wcs/component/promotion/services/PromotionServices yfs.scwc.sdf.getPricingRuleDetails.service.url=http://WC_HOSTNAME:5080/webapp/wcs/wcs/component/promotion/services/PromotionServices yfs.scwc.sdf.csv.dir=<csv directory> yfs.scwc.sdf.wc.user=wc_username yfs.scwc.sdf.wc.password=wc_password yfs.scwc.value.mapping.file=/file_path/ValueMaps.xml
Notes:
- Some properties relay sensitive data such as user IDs and passwords, which you may want to encrypt. That is, we can encrypt yfs.scwc.sdf.wc.user=wc_username and yfs.scwc.sdf.wc.password=wc_password property files.
- To be able to use the Pull Cart feature in Commerce Call Center, configure the following properties
appropriately:
yfs.scwc.sdf.getOrder.service.url = http:<IP>:<Port>/webapp/wcs/component/order/services/OrderServices yfs.scwc.sdf.processOrder.service.url = http:<IP>:<Port>/webapp/wcs/component/order/services/OrderServices
Following are the default values for these Sterling Order Management properties, along with their associated services.
| Property | Description | Services associated with property |
|---|---|---|
| yfs.scwc.sdf.integration.providerurl | Provider URL for integration. Use the corbaloc::<SC_host_where_MQ_QCF_and_JNDI_names_are_defined>:<WA_bootstrap_port>
format for the URL. To connect to WebSphere MQ, add queue connection factories and queue
destinations in WebSphere Commerce where Sterling Order
Management is installed. The following topics explain how to set up WebSphere MQ queue connection
factories and queue destinations on WebSphere Commerce; we can refer to these topics when setting up WebSphere MQ queue connection factories and queue
destinations for Sterling Order Management:
| All integration services |
| yfs.scwc.sdf.integration.apis.export.qcf | Queue Connection Factory for the export queue. | SCWC_SDF_createOrderOnSuccess SCWC_SDF_confirmDraftOrderOn Success** SCWC_SDF_changeOrderOnSuccess** SCWC_SDF_changeOrderOnCancel** SCWC_SDF_syncInventoryChanges SCWC_SDF_pushInventoryMessages SCWC_SDF_pushOrderMessages |
| yfs.scwc.sdf.integration.apis.import.qcf | Queue Connection Factory for the import queue | SCWC_SDF_createOrder SCWC_SDF_changeOrder** |
| yfs.scwc.sdf.integration.apis.import.queue | Queue to which messages from WebSphere Commerce to Sterling Order Management are written. The queue is used for communication between WebSphere Commerce and Sterling Order Management. WebSphere Commerce sends processOrder message into the queue and Sterling Order Management picks up the message from the queue. The queue name is an alias of a queue created on the WebSphere MQ server. We can change the queue name, for example to smcfs.inbound. On WebSphere Commerce, the queue is used as JMSOutboundQueue. | SCWC_SDF_createOrder SCWC_SDF_changeOrder** |
| yfs.scwc.sdf.integration.apis.createorderonsuccess.event.queue | Queue to which successful order creation messages from Sterling Order Management to WebSphere Commerce are written. The queue is created in WebSphere MQ server for Sterling Order Management internal communications between integration servers and agents. WebSphere Commerce has no information regarding this queue. | SCWC_SDF_createOrderOnSuccess |
| yfs.scwc.sdf.integration.apis.changeorderonsuccess.event.queue | Queue to which successful order change messages from Sterling Order Management to WebSphere Commerce are written. The queue is created in WebSphere MQ server for Sterling Order Management internal communications between integration servers and agents. WebSphere Commerce has no information regarding this queue. | SCWC_SDF_changeOrderOnSuccess** |
| yfs.scwc.sdf.integration.apis.changeorderoncancel.event.queue | Queue to which order cancellation messages from Sterling Order Management to WebSphere Commerce are written. The queue is created in WebSphere MQ server for Sterling Order Management internal communications between integration servers and agents. WebSphere Commerce has no information regarding this queue. | SCWC_SDF_changeOrderOnCancel ** |
| yfs.scwc.sdf.integration.apis.confirmdraftorderonsuccess.event.queue | Queue to which successful draft order confirmation messages from Sterling Order Management to WebSphere Commerce are written. The queue is created in WebSphere MQ server for Sterling Order Management internal communications between integration servers and agents. WebSphere Commerce has no information regarding this queue. | SCWC_SDF_confirmDraftOrderOnSuccess ** |
| yfs.scwc.sdf.integration.apis.sendinventorychanges.event.queue | Queue to which inventory change messages from Sterling Order Management to WebSphere Commerce are written. The queue is created in WebSphere MQ server for Sterling Order Management internal communications between integration servers and agents. WebSphere Commerce has no information regarding this queue. | SCWC_SDF_syncInventoryChanges |
| SCWC_SDF_pushInventoryMessages | ||
| yfs.scwc.sdf.sendinventorychanges.service.url | URL of service invoked by Sterling Order Management to update WebSphere Commerce about inventory changes. | SCWC_SDF_pushInventoryMessages |
| yfs.scwc.sdf.sendorderchanges.service.url | URL of service invoked by Sterling Order Management to update WebSphere Commerce about order status changes. | SCWC_SDF_pushOrderMessages |
| yfs.scwc.sdf.getOrderPrice.service.url | URL of service invoked by Sterling Order Management to get order price information fromWebSphere Commerce. | SCWC_SDF_getOrderPriceUE |
| yfs.scwc.sdf.getItemPrice.service.url | URL of service invoked by Sterling Order Management to get item price information fromWebSphere Commerce. | SCWC_SDF_getItemPriceUE |
| yfs.scwc.sdf.validateCoupon.service.url | URL of service invoked by Sterling Order Management to validate coupon information in WebSphere Commerce. | SCWC_SDF_validateCouponUE |
| yfs.scwc.sdf.getPricingRuleDetails.service.url | URL of service invoked by Sterling Order Management to get promotion details from WebSphere Commerce. | SCWC_SDF_getPricingRuleDetailsUE** |
| yfs.scwc.sdf.csv.dir | The directory where the InventoryAvailability.csv file needs to be created. If we create this directory, ensure that Sterling Order Management has read and write permission. | SCWC_SDF_syncInventoryChanges CSV** |
| yfs.scwc.sdf.wc.user | The user name of the WebSphere Commerce integration user.
Preferably, the integration user should be a WebSphere Commerce user with the role of site administrator. If any other integration user is specified, the user must have their Organization set as Root Organization and their Role set as Site Administrator. | Used for outbound synchronous calls from Sterling Order Management to WebSphere Commerce. |
| yfs.scwc.sdf.wc.password | The password of the WebSphere Commerce integration user. | Used for outbound synchronous calls from Sterling Order Management to WebSphere Commerce. |
| yfs.authonlyservlet.validate.authentication | Set this property to secure access to authorizationOnlyApiServlet. The default value is true. If two-way SSL is not enabled, set this property to false. | |
| yfs.soapservlet.validate.authentication | Set this property to secure access to SOAP servlet. Default is true. If two-way SSL is not enabled, set this property to false. | |
| yfs.scwc.value.mapping.file | The absolute path to ValueMaps.xml must be specified. If not specified, Sterling Order Management looks in the <INSTALL_DIR>/properties folder. Important: This path to ValueMaps.xml must be accessible from the application server. For more information about the ValueMaps.xml file, see Defining and deploying ValueMaps.xml file | |
| yfs.scwc.action.properties.file | The relative path (/action.properties) is expected in the following format: scwc.action.properties.file=/<action_property_file_name>.properties. If not specified, Sterling Order Management looks in the <INSTALL_DIR>/properties folder. | |
| yfs.scwc.server.connection.timeout | Controls connection timeouts for SOAP calls from Sterling Order Management to WebSphere Commerce. Default is 10000 milliseconds. | All integration services |
| yfs.scwc.server.read.timeout | Controls read timeouts for SOAP calls from Sterling Order Management to WebSphere Commerce. Default is 15000 milliseconds. | All integration services |
| yfs.scwc.sdf.getOrder.service.url | URL of the service invoked by Sterling Order Management to get the details of an order from WebSphere Commerce. | SCWC_SDF_GetCartDetails Service |
| yfs.scwc.sdf.processOrder.service.url | URL of the service invoked by Sterling Order Management to update WebSphere Commerce about order status changes. |
SCWC_SDF_LockWCShoppingCart Service SCWC_SDF_UnLockWCShoppingCart Service
|
Procedure
- Define properties in the sample <INSTALL_DIR>/properties/customer_overrides.properties file as shown above.
- To specify different properties for each process we are running, add
-DVendorFile to the start script and set it to <path to our custom servers.properties file>. We must have different
servers.properties and customer_overrides.properties files
for each process that we are running. In the servers.properties, change the entry for customer_overrides.properties to point to your newcustomer_overrides.properties file. Do the following based on the -DVendorFile filepath:
- If the value is a full path, the customer_overrides.properties file is outside of the EAR.
- Restart the application server.
- If the value is a relative path, the customer_overrides.properties file is inside of the EAR.
- Create the resources.jar file by running:
- <INSTALL_DIR>/bin/deployer.sh -t resourcejar
-
<INSTALL_DIR>/bin/deployer.cmd
-t resourcejar
- Recreate the EAR file. This file is the Sterling Order Management EAR package. For more information about creating and deploying the EAR file, refer to Building and deploying the EAR on the server.
- Create the resources.jar file by running:
- If the value is a full path, the customer_overrides.properties file is outside of the EAR.