Skip to content
Developerhome
Product homepage
X3

Batch Processing for Import/Export Templates

  Less than to read

The X3 batch server is a background process that launches programs or system commands. A queue of tasks is processed by the server, executing and logging the results of each task. You can view the queue in X3 at Usage > Batcher server > Query management.

Create a Batch Task

Below are steps to guide you through adding your import or export job to the batch server queue. We’ve given you the minimum needed to create and add a task to the queue, but batch tasks have many options for customizing their behavior; for more information see the Online help center in X3.

  1. Navigate to Usage > Batch server > Query management.
  2. Click Query.
  3. For the Task code enter either IMPORT or EXPORT.
  4. Click Validation.
  5. Enter your template in the Template field. This might be BPC, for example.
  6. Select Server as the Location. Batch processes do not use client files.
  7. Enter a Data file name or select one using the lookup button. The name needs to be a storage volume followed by a file name, e.g. [TMP]/MyDataFile.csv. To find out more about storage volumes, see our Online help center.
  8. For exports, Range and Criteria fields are available for you to filter the data to be exported.
  9. Click OK. A confirmation message will be displayed.
  10. You should now see the new task in the queue.

The Status of a task will be Standby until the batch server processes it. You can click Update to refresh the queue and monitor the status of your import. Once the task has completed, you can select Log from the action button’s menu on the row of your task to see the import log. If the job completed successfully, the status will be updated to Finished. If there was a problem, then the Status will be Error; check the log to see what needs to be corrected.

Create a Recurring Batch Task

If you have an import or export that needs to be performed on a perpetual basis, a recurring batch task can be defined. The recursion is accomplished by creating a new instance of the task in the queue each time it is scheduled to execute.

  1. Navigate to Usage > Batch server > Recurring task management.
  2. Click New.
  3. Enter a Recurring task code and Description.
  4. For the Task code enter either IMPORT or EXPORT.
  5. Select a Periodicity. Choose either Weekly or Monthly and select or enter the days the job should run.
  6. Enter a Time Range or one to three Fixed times to run the job each scheduled day.
  7. Click Create.
  8. Click Parameters.
  9. Enter your template in the Template field. This might be BPC, for example.
  10. Select Server as the Location. Batch processes do not use client files.
  11. Enter a Data file name or select one using the lookup button. The name needs to be a storage volume followed by a file name, e.g. [TMP]/MyDataFile.csv. To find out more about storage volumes, see our Online help center.
  12. For exports, Range and Criteria fields are available for you to filter the data to be exported.
  13. Click OK. A confirmation message will be displayed.
  14. Check the

To view the jobs created by the recurring task, go to Usage > Batch server > Query management to view them in the queue.

The Status of a task will be Standby until the batch server processes it. You can click Update to refresh the queue and monitor the status of your import. Once the task has completed, you can select Log from the action button’s menu on the row of your task to see the import log. If the job completed successfully, the status will be updated to Finished. If there was a problem, then the Status will be Error; check the log to see what needs to be corrected.

Batch Tasks for Web Service Imports/Exports

Batch processing can also be used with our Import/Export web services. See Developing with Web Services guide for details.