Configuring apps

The Configuration tab provides a list configuration files for the app. All apps have the app.config file, which is a required file and contains the settings that allow communication with the IBM Security Orchestration & Automation application. Apps might have additional configuration files, such as a certificate file.

About this task

You can edit the app.config file but you cannot remove it. If required by the app, you can create additional files, such as a certificate file for communication with the Orchestration & Automation application from the container, jinja templates, and ansible playbooks.

After you install an app, configure it as follows.

Procedure

  1. From the main menu, select Application settings > Case Management > Permissions and access and then click the Apps tab.
  2. Select the app that you installed and want to configure. This brings you to the individual app page where the Details tab is opened by default. The Details tab provides the App Status. The completed steps have a green check mark. For the app you installed, the next step is to Configure and Test.
  3. Click the Configuration tab to open the App Settings page.
    The surrounding text describes this graphic, which is a snap shot of the user interface.
  4. Click app.config to open the configuration page. The File Annotations field displays the comments and any variables to be defined in the app.config file. This information was installed with the app.
  5. Make the changes in the File Content field.
    For example, if the File Annotations field displays #app_name_https_proxy=http://0.0.0.0:03128/, you add the line (without the #) to the File Content field and replace the IP address with the IP address of your proxy server.
    Note: Refer to the app's documentation for information about any changes required in the app.config file.
  6. Click Test Configuration at the bottom of the page to verify that the settings are valid. If there are any errors, you see a red block at the bottom of the page. Click the Details link to review and correct any errors before proceeding.
  7. If your app has login credentials stored in the app.config file, you have the option to place these login credentials in a secret for additional security, as follows:
    1. Click the Add Secret button.
    2. Enter the name of the secret you want to use for the password.
    3. Enter the password for the account in the Value field.
    4. Click Create.
    5. In the Secrets table, click the copy icon next to the secret name, as shown by the arrow in the following graphic.
      The surrounding text describes this graphic, which is a snap shot of the user interface.
    6. Click in the app.config file where the password was located and paste the label into the app.config file.
  8. If your app contains additional files listed in the App Settings page, you can click the file name and edit its settings as necessary.
  9. Your app might need additional settings, such as a certificate file for communication with the Orchestration & Automation application from the container, jinja templates, and ansible playbooks. This additional requirement should be documented in the app's document.
    If another configuration file is required, click New File in the app's Configuration tab and complete the following:
    1. Enter an descriptive and unique name for the file.
    2. Enter a path for the file location.
    3. Enter the purpose of the file in the File Description field.
    4. Enter or paste in the file's contents in the File Content field.
    You can add as many files as necessary.
  10. Click Save and Push Changes.
  11. Go to the Details tab and click the Deploy button to deploy the app.