Overview

Rustici Generator Features

This guide covers the common core features of Rustici Generator.

Features

We recommend taking a moment to configure your application and perform the following setup steps:

Jobs

Generator handles much of its non-trivial operations with asynchronous jobs. With this approach, Generator constructs a collection of individual tasks that, when executed in sequence, result in the completion of the overall job. The application can simultaneously process tasks from unrelated jobs, which helps prevent unnecessary delays. When starting a job, the API returns a job_id. Using that ID, users can query the API to get status updates for the job by checking the job’s status property. Generator’s content import andmetadata generation processes are organized as jobs.

Users can start, cancel, and delete jobs through the API. These are organized under the /api/v1/jobs endpoints.

Currently, the following job types are supported:

  • CONTENT_IMPORT: imports new learning content into Generator
  • CONTENT_FIELD_GENERATION: generates metadata values for existing learning content
  • TAXONOMY_IMPORT: imports a new skills taxonomy
  • ENGINE_IMPORT: imports new learning content into Generator. Triggered either manually through an Engine scrape job or automatically when content is imported into an integrated Engine application. See Engine Integrations for more information.

The status property supports the following values:

  • QUEUED: the job has been created, but has not yet been started by the application
  • RUNNING: the job is currently executing
  • FAILED: the job encountered an error and could not be completed
  • COMPLETED: the job successfully concluded
  • CANCELLED: the job was terminated. Further processing was halted.