Skip to content

Configuring Inputs and Outputs via the Web Application

matamorphosis edited this page Jan 30, 2022 · 3 revisions

Usage

This is a fairly recent feature that was added to version 3.5 of Scrummage, which may raise the question why it hasn't always been available. The reason being mainly that Scrummage was made available through docker in version 3.5, which also means the cloud implementation is more likely. With cloud implementations it is necessary to be able to configure through the web application due to inaccessibility to the server running the web service.

Even if you have an on-premise implementation of Scrummage, this feature makes it very simple to configure inputs needed to run tasks, outputs to send results to on top of the main Scrummage database, and core web application settings.

Configuring Task Inputs

  1. Navigate to the "Edit Inputs" option, in the pane on the left hand side of the account settings page, as shown below, or by navigating to https://<YOURSCRUMMAGEIPORHOST>:5000/settings/configure/inputs.
    Account Settings

  2. Select which task input you wish to configure from the dropdown list, in the following example twitter has been selected, and click Continue:
    Config Input Step 1

  3. The next window displays the required fields, add the missing details and click Update: Config Input Step 2

  4. If you enter all fields correctly, you will be redirected to the settings page, and a pop up will appear confirming the update was successful: Config Input Step 3

  5. Finally, you can verify your changes by either selecting the "Check Inputs" option, in the pane on the left hand side of the account settings page, or by navigating to https://<YOURSCRUMMAGEIPORHOST>:5000/tasks/inputs/check.
    Config Input Step 4

Configuring Output Locations for Results

  1. Navigate to the "Edit Outputs" option, in the pane on the left hand side of the account settings page, as shown below, or by navigating to https://<YOURSCRUMMAGEIPORHOST>:5000/settings/configure/outputs.
    Account Settings

  2. Select which output type you wish to configure from the dropdown list, in the following example the DOCX Output report has been selected. Click Continue:
    Config Output Step 1

  3. The next window displays the required fields, add the missing details, or in the below case change False to True, to enable DOCX reporting and click Update: Config Output Step 2

  4. If you enter all fields correctly, you will be redirected to the settings page, and a pop up will appear confirming the update was successful: Config Output Step 3

  5. Finally, you can verify your changes by either selecting the "Check Outputs" option, in the pane on the left hand side of the account settings page, or by navigating to https://<YOURSCRUMMAGEIPORHOST>:5000/tasks/outputs/check. From now on, all results created will be stored in a plugin-specific report that will be accessible from each result created, in the results details.
    Config Output Step 4

Clone this wiki locally