ores.ore.run_configuration_messages

1. Physical space
2. Includes
3. Messages
4. See also

A report definition's configuration is an ORE input directory: the run document and the configuration documents it names. These messages carry that directory's files inline, since configuration documents are small.

The import is a workflow saga. The client request starts it; the execute step maps the files and stores each document through the component that owns it, under the caller's delegated session, so the party is the caller's; on failure it deletes what it stored. The export reads the documents back through the same owners and returns the files. The ORE service never touches another component's tables.

1. Physical space

The shell commands are switched off for the same reason as the ORE import's: the component has no part under projects/ores.shell. The hand-written ore menu reaches them through its import-run and export-run verbs.

2. Includes

#include <string>
#include <string_view>
#include <vector>

3. Messages

3.1. run_input_file

/**
 * @brief One file of an ORE input directory.
 *
 * The name is the one the run document gives the file; the run document
 * itself is ore.xml.
 */

3.1.1. name

3.1.2. content

3.2. saved_document

/**
 * @brief A configuration document an owner stored, by the configuration it
 * fills, so an undo can delete it.
 */

3.2.1. configuration_type_code

3.2.2. configuration_id

3.3. import_run_configuration_request

/**
 * @brief Starts importing an ORE input directory into a report definition.
 *
 * The definition must hold no run document yet, and the session must act for
 * the party that owns it.
 */

3.3.1. report_definition_id

3.3.2. name

/** Prefixes each configuration the import creates, as name/file. */

3.3.3. files

3.4. import_run_configuration_response

/**
 * @brief The workflow running the import, whose status the caller follows.
 */

3.4.1. success

3.4.2. message

3.4.3. correlation_id

3.4.4. workflow_instance_id

3.5. run_configuration_import_execute_request

/**
 * @brief The import's execute step, which the workflow engine sends.
 *
 * Carries the caller's token so the step stores each document as the caller.
 */

3.5.1. report_definition_id

3.5.2. name

3.5.3. files

3.5.4. correlation_id

3.5.5. bearer_token

/** The caller's JWT, which the step delegates to the owners. */

3.6. run_configuration_import_execute_result

/**
 * @brief What the execute step stored, travelling as the step's result.
 *
 * It names what was stored, so a compensation can delete it.
 */

3.6.1. success

3.6.2. message

3.6.3. stored

/** The files stored, run document first. */

3.6.4. not_stored

/** Input files that hold no configuration the owners keep. */

3.6.5. world_conventions_kept

/** World conventions the tenant already held, left unchanged. */

3.6.6. fx_conventions_skipped

/** FX conventions, which have no store yet. */

3.6.7. warnings

/** Setup parameters the model does not hold and the import dropped, one warning each. */

3.6.8. report_definition_id

3.6.9. run_document_saved

/** Whether reporting stored the run document, which the undo deletes. */

3.6.10. saved_documents

/** The documents the owners stored, which the undo deletes. */

3.7. run_configuration_import_rollback_request

/**
 * @brief Deletes what an import stored.
 *
 * The workflow engine sends it as the import's compensation. Deleting what is
 * already gone succeeds, so it can run twice.
 */

3.7.1. correlation_id

3.7.2. bearer_token

/** The caller's JWT, which the rollback delegates to the owners. */

3.7.3. report_definition_id

3.7.4. run_document_saved

/** Whether reporting stored the run document, which the undo deletes. */

3.7.5. saved_documents

/** The documents the owners stored, which the undo deletes. */

3.8. export_run_configuration_request

/**
 * @brief Rebuilds a report definition's ORE input directory from the owners.
 */

3.8.1. report_definition_id

3.9. export_run_configuration_response

/**
 * @brief The run document and every configuration document the definition binds.
 */