Enabling sourcing audit

Sourcing audit can be enabled or disabled at application level by setting the yfs.sourcing.audit.enabled property.

About this task

To enable the sourcing audit at the application level.

Procedure

  1. Enable the scheduled executor service which publishes the sourcing audit data captured by the application. This scheduled executor service runs a publisher task repeatedly at predefined intervals of 5 minutes. To enable this service, set the value of the property, yfs.yfs.sourcing.audit.start.publisher, to Y in the customer_overrides.properties file.

    The scheduled executor service is initiated with the JVM initialization. Therefore, to enable or disable this property, you must restart the agent or application server. The property can be enabled for an agent or an application server using server override in the Property Management user interface.

  2. Set the value of the property, yfs.sourcing.audit.enabled, to Y in the properties database using Property Management user interface. Learn more...
    Note:
    • The property is modifiable at runtime, you can enable or disable this property at runtime before running the scheduleOrder transaction.
    • With Database Property Management enabled, the yfs.sourcing.audit.enabled property can be overridden for a user, application, or agent server. Therefore, it is recommended that the property overrides are enabled such that any performance impact of this feature is limited to a user, application, or agent server.
  3. The publisher task can invoke either a locally configured SDF service or an external REST service depending on the values of the properties. Set one of the following properties in the customer_overrides.properties file based on your requirement:
    • For local SDF service: yfs.yfs.sourcing.audit.datahandler.local.service - The value of this property is the service flow name that needs to be invoked.
    • For external REST service: yfs.yfs.sourcing.audit.datahandler.rest.service - The value of this property is the URL of the external REST service that handles publishing of the sourcing audit data. Additionally, for REST service you need to set the following properties for basic authentication:
      • yfs.yfs.sourcing.audit.datahandler.rest.service.username - The value of this property is the username for the authentication for the REST service that handles publishing of the sourcing audit data to external system.
      • yfs.yfs.sourcing.audit.datahandler.rest.service.password - The value of this property is the password for the authentication for the REST service that handles publishing of the sourcing audit data to external system.
    Note: If both local SDF service and external REST service properties are set, the local SDF service is invoked.

What to do next

To analyze the effectiveness of your sourcing and scheduling rule configuration, review the published audit XMLs that contain the sourcing audit data captured by the application. For more information, see Data capture and exclusion levels for sourcing audit.