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.
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.)
You can include one or more mqsisetdbparms commands in the setdbparms.txt 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 a 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.
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.
- Add a line in this format to the empty file:
Where:flow_name apikey IBMCloud_APIkey
- 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.
- 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:
- From the Configuration page (accessed by clicking the Configuration icon ), or the Configuration panel of an integration server that you are creating, click Create configuration. For more information about this page or panel, see Managing configuration objects from the Configuration page.
- From the
Create configuration
panel, select setdbparms.txt from the Type list. - In the Name field, specify a name for this configuration.
- 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.
- 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.
- Import your setdbparms.txt file, which contains the commands to run, from
your file system:
- Click the Import setdbparms file icon .
- Click within the boxed area to select the file from a file browser, or drag-and-drop the file.
The name of the imported file is displayed.
- If you want to view the file contents, click View file contents to return
to the text editor.
Tip: For security reasons, thesetdbparms.txt
content that you add is available only asREDACTED
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. - Copy the contents of your setdbparms.txt file, which contains the commands
to run, and then paste it into the setdbparms.txt text editor.
- 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.