Uploaded image for project: 'UX Product'
  1. UX Product
  2. UXPROD-2330

Scheduling export of inventory records through an API

    XMLWordPrintable

Details

    • Hide
      *Start the export:*
      1. Post file definition to /data-export/fileDefinition (this is an equivalent of uploading UUIDs or CQL)
      2. Start the export by /data-export/export
      *Retrieve the files generated by the export:*
      1. Get completed jobExecutionId and fileId : /data-export/jobExecution - by querying by completed time stamp
      2. Download the file by /data-export/jobExecutions/{jobExecutionId}/download/{fileId}
      Show
      *Start the export:* 1. Post file definition to /data-export/fileDefinition (this is an equivalent of uploading UUIDs or CQL) 2. Start the export by /data-export/export *Retrieve the files generated by the export:* 1. Get completed jobExecutionId and fileId : /data-export/jobExecution - by querying by completed time stamp 2. Download the file by /data-export/jobExecutions/{jobExecutionId}/download/{fileId}
    • Not Scheduled
    • XXL < 30 days
    • Low
    • XXXL: 30-45 days
    • 20%
    • Firebird
    • 90
    • Needed for automated exports
    • R1
    • R4
    • R1
    • R1
    • R1
    • R2
    • R1
    • R1
    • R1
    • R1
    • R3

    Description

      In the existing implementation the data export can only be triggered manually. For the exports that reoccur on regular basis (like incremental export of all records that were added or modified since the last export), the application will need to provide the API so that the export could be triggered by the external custom export script .

      This feature covers backend work that would support a scenario when the library has an export job that needs to run on the regular basis on the data identified in a consistent way. Such jobs are mostly run when the exported data is need for integration with the external services and the file generated by the export might need to be FTP-ed to a specific location.

      The user should be able to:

      1. schedule when the job will need to run (quarterly, monthly, weekly, daily, at a specificied time)
      2. determine if this re-occurring export job
      3. the files generated by export are stored in the standard location
      4. the job will be associated with a mapping profile that will determine required data manipulation.
      5. identify the data that will be exported by CQL query that can take system parameters (like date of the last execution) for example or by providing list of UUIDs if static data needs to be exported.

      Additional information:
      Updated workaround: https://issues.folio.org/secure/attachment/61166/AutomatingDataExport.txt

      TestRail: Results

        Attachments

          Issue Links

            Activity

              People

                magdaz Magda Zacharska
                magdaz Magda Zacharska
                Magda Zacharska Magda Zacharska
                Magda Zacharska Magda Zacharska
                Votes:
                0 Vote for this issue
                Watchers:
                8 Start watching this issue

                Dates

                  Created:
                  Updated:

                  TestRail: Runs

                    TestRail: Cases