title: “Using Advanced Mode” sidebar_position: 7 description: > Using the advanced mode of Config-UI

Why advanced mode?

Advanced mode allows users to create any pipeline by writing JSON. This is useful for users who want to:

  1. Collect multiple GitHub/GitLab repos or Jira projects within a single pipeline
  2. Have fine-grained control over what entities to collect or what subtasks to run for each plugin
  3. Orchestrate a complex pipeline that consists of multiple stages of plugins.

Advanced mode gives utmost flexibility to users by exposing the JSON API.

How to use advanced mode to create pipelines?

  1. Click on “+ New Blueprint” on the Blueprint page.

image

  1. In step 1, click on the “Advanced Mode” link.

image

  1. The pipeline editor expects a 2D array of plugins. The first dimension represents different stages of the pipeline and the second dimension describes the plugins in each stage. Stages run in sequential order and plugins within the same stage runs in parallel. We provide some templates for users to get started. Please also see the next section for some examples.

image

  1. You can choose how often you would like to sync your data in this step by selecting a sync frequency option or enter a cron code to specify your preferred schedule. After setting up the Blueprint, you will be prompted to the Blueprint's activity detail page, where you can track the progress of the current run and wait for it to finish before the dashboards become available. You can also view all historical runs of previously created Blueprints from the list on the Blueprint page.

Examples

1. Gitlab

Collect multiple GitLab repos sequentially.

When there're multiple collection tasks against a single data source, we recommend running these tasks sequentially since the collection speed is mostly limited by the API rate limit of the data source. Running multiple tasks against the same data source is unlikely to speed up the process and may overwhelm the data source.

Below is an example for collecting 2 GitLab repos sequentially. It has 2 stages, each contains a GitLab task.

[
  [
    {
      "Plugin": "gitlab",
      "Options": {
        "projectId": 15238074
      }
    }
  ],
  [
    {
      "Plugin": "gitlab",
      "Options": {
        "projectId": 11624398
      }
    }
  ]
]

2. Github

Collect a GitHub repo and a Jira board in parallel

Below is an example for collecting a GitHub repo and a Jira board in parallel. It has a single stage with a GitHub task and a Jira task. Since users can configure multiple Jira connection, it's required to pass in a connectionId for Jira task to specify which connection to use.

[
  [
    {
      "Plugin": "github",
      "Options": {
        "repo": "lake",
        "owner": "merico-dev"
      }
    },
    {
      "Plugin": "jira",
      "Options": {
        "connectionId": 1,
        "boardId": 76
      }
    }
  ]
]

3. Zentao

Below is an example for collecting a Zentao workspace. Since users can configure multiple Zentao connection, it's required to pass in a connectionId for Tapd task to specify which connection to use.

[
  [
    {
      plugin: 'zentao',
      options: {
        connectionId: 1,
        productId: 1,
        projectId: 1,
        executionId: 1
      }
    }
  ]
]
  • connectionId: The ID field from ZENTAO Integration page.
  • productId: optional, ZENTAO product id, see “Find Product Id” for details.
  • projectId: optional, ZENTAO product id, see “Find Project Id” for details.
  • executionId: optional, ZENTAO product id, see “Find Execution Id” for details.

You must choose at least one of productId, projectId and executionId.

Find Product Id

  1. Navigate to the Zentao Product in the browser
  2. Click the red square annotated in the pic above
  3. Then the number in the red circle above is ProductId

Find Project Id

  1. Navigate to the Zentao Project in the browser
  2. Then the number in the red square above is ProjectId

Find Execution Id

  1. Navigate to the Zentao Execution in the browser
  2. Then the number in the red square above is ExecutionId

4. Tapd

Below is an example for collecting a Tapd workspace. Since users can configure multiple Tapd connection, it's required to pass in a connectionId for Tapd task to specify which connection to use.

[
    [
        {
            "plugin": "tapd",
            "options": {
                "workspaceId": 34***66,
                "connectionId": 1
            }
        }
    ],
    [
        {
            "plugin": "tapd",
            "options": {
                "workspaceId": 6***14,
                "connectionId": 1
            }
        }
    ]
]
  • connectionId: The ID field from TAPD Integration page.
  • workspaceId: TAPD workspace id, you can get it from two ways:
    • url: tapd-workspace-id
    • db: you can check workspace info from db._tool_tapd_workspaces and get all workspaceId you want to collect after execution of the following json in advanced mode
      [
        [
                {
                        "plugin": "tapd",
                        "options": {
                                "companyId": 55850509,
                                "workspaceId": 1,
                                "connectionId": 1
                        },
                        "subtasks": [
                                "collectCompanies",
                                "extractCompanies"
                        ]
                }
        ]
]

5. Jira

Below is an example for collecting 2 Jira boards sequentially.

[
    [
        {
            "plugin": "jira",
            "options": {
                "boardId": 8,
                "connectionId": 1
            }
        }
    ],
    [
        {
            "plugin": "jira",
            "options": {
                "boardId": 26,
                "connectionId": 1
            }
        }
    ]
]
  • connectionId: The ID field of the table _tool_jira_connections.
  • boardId: Jira board id, it is the ID field of the table _tool_jira_boards.

Editing a Blueprint (Advanced Mode)

This section is for editing a Blueprint in the Advanced Mode. To edit in the Normal mode, please refer to this guide.

To edit a Blueprint created in the Advanced mode, you can simply go the Configuration page of that Blueprint and edit its configuration.

img

Troubleshooting

If you run into any problem, please check the Troubleshooting or create an issue