configuring.rst 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .. _extensions_importer_configuring:
  2. Configuring the Importer extension
  3. ==================================
  4. The importer extension can be used without any explicit configuration, and by default it will:
  5. * Stage the REST uploads in a dedicated sub-folder of the data directory (``uploads``).
  6. * Pose no limit to the amount of concurrent imports executed.
  7. It is however possible to configure the above using the "Importer" entry under the "Settings" menu:
  8. .. figure:: images/menu.png
  9. The importer configuration menu entry
  10. The configuration page looks as follows:
  11. .. figure:: images/configuration.png
  12. The importer configuration page
  13. .. list-table::
  14. :widths: 20 80
  15. :header-rows: 1
  16. * - Entry
  17. - Description
  18. * - Upload root
  19. - The folder that will hold REST call uploads
  20. * - Maximum synchronous jobs
  21. - How many synchronous jobs can be run in parallel. Synchronous jobs can only be run via the REST API.
  22. * - Maximum asynchronous jobs
  23. - How many asynchronous jobs can be run in parallel. Asynchronous jobs can run via the REST API,
  24. and all jobs started from the GUI are asynchronous.
  25. * - Maximum asynchronous jobs
  26. - How many asynchronous jobs can be run in parallel. Asynchronous jobs can run via the REST API,
  27. and all jobs started from the GUI are asynchronous.
  28. * - Completed and stale imports expiration
  29. - How many minutes to wait, before removing an import from the database. Imports that are still
  30. running are ignored, while completed, errored, or imports that were created, but never started,
  31. are going to be considered for cleanup. Value is in minutes, set to zero or negative to never
  32. remove values. Defaults to 1440 minutes, one day.
  33. Importer Logging
  34. ----------------
  35. The importer extension includes a new :file:`IMPORTER_LOGGING` profile which may be selected in global settings.
  36. * This profile is quiet during normal operation (similar to :file:`PRODUCTION_LOOGGING`)
  37. * Provides configuration and information logs on importer activity