Tips for Creating a Workflow - AudiovisualMetadataPlatform/amp_documentation GitHub Wiki
Tips for Creating a Workflow
Use MGMs (metadata Generation Mechanisms) Guide{rel="nofollow"} for more information about MGM tools.
There are a few things to bear in mind when creating a Workflow to be used with AMP:
1.
Start by naming your workflow (WF). The right-hand panel has the data about the workflow itself when you first come to the WF Editor. You can go back to that by clicking on the pen icon.
2.
Every WF needs an input. [Most] (not all) of the workflows the users will create in AMP will need an AV file as input. The node for input is located under the Input category in the Tools menu and is called Input dataset:
Once you click on the node name, a node of that type is added to the workflow.
3.
The WF editor only allows connections between nodes that have matching data types. Thus, when an audio file is expected, a video file is not accepted as input. You can resolve this by extracting the audio from a video file to use the audio file as input to audio tools.
The Extract Audio tool is located under the Audio Extraction category in the Tools menu:
4.
Outputs and inputs are easily identified in the tool's visual representation. The inputs are in the top part, above a horizontal line that separates them from the outputs in the bottom part. Also, inputs have an arrow pointing in on the left border and outputs have an arrow pointing out in the right border:
5.
As in the example above, a WF Tool may have multiple inputs and multiple outputs. The outputs that the user wants to view in the AMP dashboard should have their respective checkboxes checked. For example, if the user is not interested in reviewing the non-formatted transcript text but is interested on the transcript in the WebVTT format, the box for AMP Transcript should not be checked and the box for WebVTT should be checked. In the following screenshot, note that the only output that has a checkbox checked is the WebVTT output:
6.
When connecting nodes, the WF Editor will give you an orange or green highlight to indicate where a connection is not valid or valid respectively:
7.
When your workflow is ready and you want to make it available for WF Submissions, you need to "publish" it. You do that by adding the "published" tag to the WF in the WF attributes on the right panel. If what you are currently seeing on the right panel is the information on a tool rather than the WF Attributes, click on the pencil on top to view the WF Attributes.
8.
[Remember] to save your changes (see save icon in the first screenshot above).
Attachments:
image2022-7-12_14-46-37.png
(image/png)
image2022-7-12_14-51-51.png
(image/png)
image2022-7-12_14-55-39.png
(image/png)
image2022-7-12_15-8-10.png
(image/png)
image2022-7-12_15-14-45.png
(image/png)
image2022-7-12_15-16-49.png
(image/png)
image2022-7-12_15-18-26.png
(image/png)
image2022-7-12_15-24-49.png
(image/png)
image2022-7-12_15-28-43.png
(image/png)
image2022-7-12_15-56-5.png
(image/png)
image2022-7-13_14-55-58.png
(image/png)\
Document generated by Confluence on Feb 25, 2025 10:39