Set up a Task Manager for Human MGMs - AudiovisualMetadataPlatform/amp_documentation GitHub Wiki

  1. AMP: Audiovisual Metadata Platform
  2. Documentation
  3. For System Administrators

Set up a Task Manager for Human MGMs

AMP has the capability to create issues in either Jira or Trello when a Human MGM (ex: HMGM Transcript Correction or HMGM NER Correction) is included in a workflow. When the workflow hits this MGM, it will create an issue. Once that issue is resolved in the task manager, the workflow step will automatically be resolved in AMP and the workflow will move on to the next step.

Basic steps to set up a task manager:

  • Select the appropriate task manager on the Unit page in AMP
  • Set an admin account in the task manager for use by the API and add credentials to the amp.yaml configuration file
  • Set up the appropriate boards / components in the task manager to match the Unit

Jira

  • Create a project in Jira to use with AMP and ensure there is an account that has permissions to create issues in that project via the API. 

  • Generate an API token for this account. See Jira documentation: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/

  • Update the configuration in ${AMP_HOME}/amp_bootstrap/amp.yaml

    :::: :::

    jira:
        server: <base jira URL>
        username: <jira user with API permissions>
        password: <API token>
        project: <project key; ex: TMGM>

    ::: ::::

  • AMP is set up to create an issue in a specific Jira project with a Component that matches the name of the Unit that the item in the HMGM workflow belongs to. Create a Component in Jira for each Unit in AMP that is going to use the Jira task manager. You can also create  Kanban boards in Jira to provide a view of issues specific to each AMP Unit (filter issues to a specific Component and use that filter to create a Kanban board).

  • AMP also creates a Label on each issue to match the type of HMGM generating the issue. You will want to create these Labels in your Jira project:

    • Transcript
    • NER

Trello

  • Create a Trello user that will be the administrator for your Workspace and Boards. Note that this can be a free account; it does not require a paid account.

  • Create a Workspace for use with AMP. 

  • Generate an API key for that Workspace and user using an integration app. See Trello documentation: https://www.merge.dev/blog/trello-api-key

  • Update the configuration in ${AMP_HOME}/amp_bootstrap/amp.yaml

    :::: :::

    trello:
        api_key: <key value>
        api_token: <token value>

    ::: ::::

  • AMP is set up to create an issue in Trello on the Board that matches the name of the Unit that the item in the HMGM workflow belongs to. Create a Board in Trello for each Unit in AMP that is going to use the Trello task manager. 

  • Note: If you update Unit names or later add a new Unit using Trello, you will need to update / create Boards in Trello.

  • AMP also creates a Label on each issue to match the type of HMGM generating the issue. You will want to create these labels on your Trello boards:

    • Transcript
    • NER

Document generated by Confluence on Feb 25, 2025 10:39

⚠️ **GitHub.com Fallback** ⚠️