Mass Customer Download
Mass Customer Download allows you to download a batch file of new and changed customers to an external system.
Important:
The Mass Customer Download is not currently supported. The Generic Customer Download API can be used instead. See the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for more information.The download file contains a Mass Customer Download XML Message (CWCustomerDownload) for each sold-to customer whose customer class matches the customer class defined in the MASS_CUSTDWNLD_CUSTOMER_CLASS property.
Mass customer download process flow:
Generic customer download API: You can use the Generic Customer Download API to generate a Customer Download XML Message (CWCustomerDownload) interactively as you create, change or delete customer information. See Generic Customer Download API for an overview.
For more information see the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1).
In this topic:
Mass Customer Download Process
Use the following steps to generate the Mass Customer Download file.
| # | Step |
|---|---|
|
1. |
Run the CSTDWNL Mass Customer Download periodic function (program name PFRCSTDNLD) to submit the CUSTDWLD job. |
|
2. |
Order Administration writes any messages related to the Mass Customer Download to the Application Log. If the Mass Customer Download processes successfully, Order Administration writes a message similar to the following to the log: Mass CustomerDwnld created in folder: \\APP1\OMSFiles\Integrations\Xlink\TEMP_MassCustomerDownload If the Mass Customer Download fails, Order Administration writes a message similar to the following to the log and does not generate a Mass Customer Download XML Message (CWCustomerDownload) or create a Mass Customer Download File. If a file name is not defined for the MASS_CUSTDWNLD_FILE_NAME property: MASS_CUSTDWNLD_FILE_NAME property not set. MassCustomerDwnld configuration error - Customer Download not processed |
|
3. |
Order Administration looks at the setting of the MASS_CUSTDWNLD_CUSTOMER_CLASSES property to determine which customers to include in the Mass Customer Download.
|
|
4. |
Order Administration places the generated Mass Customer Download messages in a batch file. The setting of the MASS_CUSTDWNLD_FILE_NAME property determines the name of the batch file.
See Mass Customer Download File for a sample file. |
|
5. |
If a value is defined for the MASS_CUSTDWNLD_MESSAGE_WRAPPER property, Order Administration adds this value to the beginning and end of the batch file contents to make the contents of the file a valid XML document. |
|
6. |
Order Administration places the Mass Customer Download File in the directory defined in the MASS_CUSTDWNLD_DOWNLOAD_DIRECTORY property so that it can be processed by an external system. |
Mass Customer Download Setup
Before you can use the Mass Customer Download process, you must complete the required setup.
Integration Properties
Use the following settings in Working with Customer Properties (PROP) to configure the Mass Customer Download.
| Property | Description |
|---|---|
|
MASS_CUSTDWNLD_DOWNLOAD_DIRECTORY |
The directory where Order Administration places the Mass Customer Download file to be sent to an external system. This setting is defined by Oracle and cannot be changed. |
|
MASS_CUSTDWNLD_FILE_NAME |
Required. The name of the Mass Customer Download file. The delivered setting is MassCustomerDownload.
|
|
MASS_CUSTDWNLD_ CUSTOMER_CLASSES |
The customer class used to determine which sold to customers to include in the Mass Customer Download. To define more than one customer class, separate the values with a comma. Example: CL,NR Note: You cannot add a blank value to this setting to include sold to customers that do not have a customer class defined. For example, you cannot enter CL, ,NR or CL,’’,NR. Leave this setting blank if you wish to include all sold to customers, regardless of the assigned customer class, in the Mass Customer Download. |
|
MASS_CUSTDWNLD_ MESSAGE_WRAPPER |
The XML root element name Order Administration adds to the beginning and end of the Mass Customer Download file to make the contents of the file a valid XML document. If you leave this setting blank, the file will not be a valid XML document; however, each message in the file will be a valid XML message. |
Customer Class
If you define a customer class for the MASS_CUSTDWNLD_CUSTOMER_CLASSES property, you must define this customer class for each sold to customer that you wish to include in the Mass Customer Download. If this setting is blank, the system includes all sold to customers in the Mass Customer Download.
Mass Customer Download Periodic Function
Use the CSTDWNL Mass Customer Download (program name PFRCSTDNLD) periodic function to submit the Mass Customer Download process. See Scheduling Jobs for more information on how to assign a periodic function to a periodic process and how to schedule a periodic process to run on a scheduled basis.
Mass Customer Download File
This file contains each Mass Customer Download XML Message (CWCustomerDownload) that is generated during the Mass Customer Download Process. The setting of the MASS_CUSTDWNLD_FILE_NAME property determines the name of the batch file.
-
During processing, Order Administration adds the prefix TEMP to the name of the batch file; for example: TEMP_MassCustomerDownload
-
Once processing is complete, Order Administration adds a date and time stamp to the batch file name; for example: MassCustomerDownload.20110128.170150340
-
Order Administration also archives the batch file in zip format; for example: MassCustomerDownload.20110128.170150340.zip
If a value is defined for the MASS_CUSTDWNLD_MESSAGE_WRAPPER property, Order Administration adds this value to the beginning and end of the generated file to make the contents of the file a valid XML document.
Order Administration places the Mass Customer Download file in the directory defined in the MASS_CUSTDWNLD_DOWNLOAD_DIRECTORY property so that it can be processed by an external system.