Skip to content

Commit

Permalink
missed a file
Browse files Browse the repository at this point in the history
  • Loading branch information
ianlongden committed Aug 20, 2024
1 parent bf8eec3 commit 026261a
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/source/workflow_automation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Requirements overview.

Actions overview.
^^^^^^^^^^^^^^^^^
This is an array of strings that define methods and arguments that are processed when we transition.
This is an array of strings that define methods and arguments that are processed after the transition.
An example would be to add a workflow_tag 'text conversion needed' for WormBase files of reference type
'experimental' when transitioning from "file upload in progress" to "files uploaded".
The following shows the section from the data load file for this.
Expand All @@ -81,6 +81,7 @@ Actions overview.
In this example when we do the above transition then afterwards the method proceed_on_value is called with
the arguments reference_type, experimental and the value of name_to_atp['text conversion needed'].
Format is method name and then '::' separates each argument for it.

These methods are in api/crud/workflow_transition_actions/*.py
To add new ones, create a new file with function of the specified name in.
Expand Down Expand Up @@ -112,6 +113,9 @@ Adding data to the workflow_transition Table.
If you add new data files then the python script will need to be altered to find this data.
Alterations include adding an import of the new file and adding another elif statement to run it.

Something that might need changing if needed at some point is to allow a list of mods in the dict element 'mod',
Currently only one mod can be used or not_mod (to add all but that mod) and 'ALL' which adds to all mods.

Automated jobs.
^^^^^^^^^^^^^^^
In the condition part of the table we list jobs that can be found, started, completed or failed.
Expand Down Expand Up @@ -168,6 +172,9 @@ Automated jobs.
"on_failed" depending on how the job went. This will replace the workflow_tag from "interaction classification in progress"
to "interaction classification complete" or "interaction classification failed" based on this.

There are router api end points for all the job methods so that external processes can process jobs
and update the database without having to have all the same code, versions etc locally.


When to use requirements, condition or action.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 026261a

Please sign in to comment.