Skip to content
Developer home
X3

Export file use case

  Less than to read

Before we start, the pairing process between the 3rd party application and X3 configuration should be done with a pair of access and refresh tokens ready to use by the 3rd party application.

The set-up is similar to the current File Export except one particular point on the folder where exported files are stored. That is why we recommend that you read through out the File Export guide, the Batch Processing for Export Templates and also some real template examples:

  • X3 administrator sets up an Storage Areas for 3rd party application by following previous guide with this particular point:

    • In the site-map, follow the path Usage > Usage > X3 Storage Areas, click the “Create” link to create a volume:

      Storage

      Please note that the Root is always cloudImport for Data Ingestion API and cloudExport for Data Delivery API. This set-up is needed for the First Time Use only.

    • An automatic task will create a folder whose name is the id of the 3rd party application which can be retrieved from the site-map by following the path Administration > Third Parties >List of paired third parties, e.g:

      Storage

      This folder will be use as the storage of you exported files waiting for being copied to the cloud storage where 3rd party application can download these files through Data Delivery API. In this example, it will be [EXPORT_FILES]/c0febabe-0f39-44bc-afe1-4619719804c9.

      Data file

      Other steps stay the same as the current process.

  • X3 administrator sets up the export batch with the output file location created previously. In this case, it will be [EXPORT_FILES]/c0febabe-0f39-44bc-afe1-4619719804c9/exported_file#.txt for example. Please note, # representing 5 digits number.
  • X3 exports data for 3rd party application. To view the jobs created by the recurring task, go to Usage > Batch server > Query management to view them in the queue.
  • 3rd party application queries the endpoint for available files. For API call example, click here.
  • 3rd party application downloads the exported file. For API call examples, click here.
  • 3rd party application deletes the downloaded file. For API call example, click here.

    Once a file is successfully downloaded, 3rd party application must delete the file by sending an API delete call to the endpoint

For full detail with screenshot of this use case, click here.