setdbparms.txt type

Use the setdbparms.txt type to create configurations that contain mqsisetdbparms commands to run when the integration server is deployed.


Summary of key details for the configuration type

File name or type Contains secrets Path extracted/imported to Maximum allowed per integration server
TXT Yes N/A (mqsisetdbparms commands in the file will be executed) Multiple

About the setdbparms.txt file

The setdbparms.txt type requires a TXT file that lists one or more mqsisetdbparms commands to run. For information about this command, see mqsisetdbparms command.

To create a TXT file that lists one or more mqsisetdbparms commands, complete the following steps:

  1. Create a text file named setdbparms.txt or use another name with a .txt extension. (In this topic, setdbparms.txt is used as the file name.)
  2. Include one or more mqsisetdbparms commands in the file by using either of the following formats:
    • Add one or more lines to the file, where each line contains three space-separated values that identify a resource, a user name, and a password, specified in this form:

      resource username password

      For each line, these three values will be used to run an mqsisetdbparms command with the -n, -u, and -p settings. For example, if you add an mq::user1 app1 topSecret line to your setdbparms.txt file, the following command will be executed:

      mqsisetdbparms -n mq::user1 -u app1 -p topSecret

    • Specify the entire mqsisetdbparms command in the file. The entry must start with mqsisetdbparms, and the command will be executed as specified.
    Note: For both formats, when the command is executed, all arguments are enclosed within single quotation marks, and any single quotation marks within the values are escaped. As a result, you must not include quotation marks on the parameters within the file.
  3. Save and close the file.

If you want to use cloud-managed connectors to run the actions or operations for a Designer integration that is deployed to the integration server, you must provide your IBM® Cloud API key details in a setdbparms.txt file.
Note: Cloud-managed connectors are available only if the Channel or version value (that is, spec.version) of the integration server resolves to 12.0.3.0-r1 or earlier.
  1. Add a line in this format to the empty file: 
    flow_name apikey IBMCloud_APIkey

    Where:

    • flow_name is the file name stem of the BAR file.
    • IBMCloud_APIkey is the "apiKey" value in the apiKey.json file that contains details of the IBM Cloud API key.
      Contents of a setdbparms.txt file for cloud-managed connectors
  2. Save and close the file.

For examples of how to use the setdbparms.txt configuration type, see Tutorials and examples.

Creating a configuration for the setdbparms.txt type by using the configuration panel

You can create an setdbparms.txt-type configuration while creating an integration server, or independently, as follows:

  1. From the Configuration page (accessed by clicking the Configuration icon Configuration icon), or the Configuration view of an integration server that you are creating, click Create configuration. For more information about this page or view, see Managing configuration objects from the Configuration page.
  2. From the Create configuration panel, select setdbparms.txt from the Type list.
  3. In the Name field, specify a name for this configuration.
  4. In the Description field, specify text that will help you identify the integration server that will use this setdbparms.txt file, or the purpose of the commands that will be executed.
    Create configuration panel
  5. Complete the setdbparms.txt section by completing either of the following steps:
    • Copy the contents of your setdbparms.txt file, which contains the commands to run, and then paste it into the setdbparms.txt text editor.
      setdbparms.txt text editor with pasted contents
    • Import your setdbparms.txt file, which contains the commands to run, from your file system:
      1. Click the Import setdbparms file icon Import icon.
      2. Click within the boxed area to select the file from a file browser, or drag-and-drop the file.
        Import setdbparms view

        The name of the imported file is displayed.

      3. If you want to view the file contents, click View file contents to return to the text editor.
        setdbparms.txt text editor with imported contents
    Tip: For security reasons, the setdbparms.txt content that you add is available only as REDACTED content after you create the configuration. If you need to update this content later, ensure that you retain a copy of the original file that you used to create this configuration, so you can update it as required. The update will replace the original content with the edited content.
  6. Click Create. The configuration is added to the configurations table and can be selected for use with an integration server.

Updating or deleting a configuration

If you need to update the content or settings in a configuration, or delete a configuration that's no longer required, see Managing configuration objects from the Configuration page.