.. include:: /_generated_banners/wms-ref-banner.rst Object Glossary =============== WorkflowObject -------------- Workflow object. See https://observation-management-service.github.io/ewms-docs/services/wms.html#workflow. .. list-table:: :header-rows: 1 :widths: 35 15 50 * - Field - Type - Description * - ``workflow_id`` - string - A unique identifier automatically generated for this workflow. * - ``timestamp`` - number - The epoch time when this workflow was created. * - ``priority`` - integer - The workflow's priority level relative to other workflows. * - ``deactivated`` - string | null - * - ``deactivated_ts`` - number | null - TaskDirectiveObject ------------------- Task directive object. See https://observation-management-service.github.io/ewms-docs/services/wms.html#task-directive. .. list-table:: :header-rows: 1 :widths: 35 15 50 * - Field - Type - Description * - ``task_id`` - string - A unique identifier automatically generated for this task. * - ``workflow_id`` - string - The identifier of the overarching workflow object (M task directives : 1 workflow). * - ``cluster_locations`` - array of string(s) - The HTCondor pool(s) where the taskforce(s) will run. * - ``task_image`` - string - The Docker/Singularity/Apptainer image to run for each event. Apptainer images in directory (sandbox) format will start fastest; other formats will first be converted to this format on each worker CPU. * - ``task_args`` - string - The argument string to pass to the task image. * - ``task_env`` - object - Environment variables (and values) to set in the task instance. * - > *(any key)* - string - * - ``init_image`` - string - The Docker/Singularity/Apptainer image for the init container. See 'task_image' for caveats/optimizations regarding the image format. * - ``init_args`` - string - The argument string to pass to the init container. * - ``init_env`` - object - Environment variables (and values) to set in the init container. * - > *(any key)* - string - * - ``timestamp`` - number - The epoch time when this task was created. * - ``input_queues`` - array of string(s) - The message queue(s) that this task will use for event input. * - ``output_queues`` - array of string(s) - The message queue(s) that this task will use for event output. TaskforceObject --------------- Taskforce object. See https://observation-management-service.github.io/ewms-docs/services/wms.html#taskforce. .. list-table:: :header-rows: 1 :widths: 35 15 50 * - Field - Type - Description * - ``taskforce_uuid`` - string - A unique identifier automatically generated for this taskforce. * - ``task_id`` - string - The identifier of the associated task directive object (N taskforces : 1 task directive). * - ``workflow_id`` - string - The identifier of the overarching workflow object (N*M taskforces : M task directives : 1 workflow). * - ``timestamp`` - number - The epoch time when this taskforce was created. * - ``priority`` - integer - The priority level relative to other taskforces (usually, this value is inherited from the parent workflow object). * - ``collector`` - string | null - * - ``schedd`` - string - The address of the HTCondor schedd. * - ``n_workers`` - integer | null - * - ``pilot_config`` - object - Configuration settings for the EWMS pilot. * - > ``tag`` - string - The image tag to use (e.g., '#.#.#', 'latest', or a feature branch tag). Note: tags like # or #.# are disallowed since these are mutable. This field is useful for repeatability. * - > ``image_source`` - | ``"cvmfs"`` | ``"auto"`` - The canonical source name for the image. * - > ``environment`` - object - Environment variables and their corresponding values. * - > > *(any key)* - string | integer | array - * - > ``input_files`` - array of string(s) - Paths to files to make available to the task container. These files must already be accessible on the AP. * - ``worker_config`` - object - Configuration settings for the HTCondor cluster submission. * - > ``do_transfer_worker_stdouterr`` - boolean - Indicates whether to transfer back the workers' stdout and stderr (accessible on the AP). * - > ``max_worker_runtime`` - integer - The maximum runtime for a worker. Adjust this to optimize performance (e.g., to terminate slow CPUs). * - > ``n_cores`` - integer - The number of cores to request per HTCondor worker. * - > ``priority`` - integer - The priority level for the HTCondor submission. * - > ``worker_disk`` - string | integer - * - > ``worker_memory`` - string | integer - * - > ``condor_requirements`` - string - The 'requirements' string given to the HTCondor submission. * - ``cluster_id`` - integer | null - * - ``submit_dict`` - object - The actual HTCondor submit class ad. * - > *(any key)* - string | integer - * - ``job_event_log_fpath`` - string - The file path on the HTCondor AP containing job event logs. * - ``phase`` - | ``"pre-mq-activation"`` | ``"pre-launch"`` | ``"pending-starter"`` | ``"condor-submit"`` | ``"pending-stopper"`` | ``"condor-rm"`` | ``"condor-complete"`` - The current phase of the taskforce within the workflow's lifetime. Not all taskforces will enter every phase. * - ``phase_change_log`` - array of object(s) - A record of all attempted phase changes, including both successful and unsuccessful ones. * - > ``[*].target_phase`` - string - The phase that the system was attempting to transition to. * - > ``[*].timestamp`` - number - The epoch timestamp when this phase change attempt was recorded in the system. * - > ``[*].was_successful`` - boolean - Indicates whether the phase change was completed successfully, i.e. did it actually change? * - > ``[*].source_event_time`` - number | null - * - > ``[*].source_entity`` - string - The entity (person, system, or process) responsible for the external event that triggered this phase change attempt. * - > ``[*].context`` - string - The circumstances or background information about the phase change attempt. * - ``compound_statuses`` - object - Aggregated status of the workers, represented as a nested dictionary mapping HTCondor states to EWMS pilot states and their counts. * - > *(any key)* - object - * - ``top_task_errors`` - object - The most common errors encountered by workers, paired with their occurrence counts. * - > *(any key)* - integer - FindObject ---------- The fields and values used to search. .. list-table:: :header-rows: 1 :widths: 35 15 50 * - Field - Type - Description * - ``query`` - object - The search criteria (MongoDB-filter syntax) * - ``projection`` - array of string(s) - The fields to include in the response * - ``after`` - string - The database '_id' to resume pagination from, taken from a previous response's 'next_after' field. QueryNextAfter -------------- DeactivatedWorkflowResponseObject --------------------------------- .. list-table:: :header-rows: 1 :widths: 35 15 50 * - Field - Type - Description * - ``workflow_id`` - string - The workflow ID. * - ``n_taskforces`` - integer - Number of taskforces to be stopped. ErrorResponse ------------- .. list-table:: :header-rows: 1 :widths: 35 15 50 * - Field - Type - Description * - ``code`` - integer - HTTP error code. * - ``error`` - string - HTTP error reason.