IBM App Connect Enterprise, Version 11.0.0.2 Operating Systems: Windows, Linux


Configuring an integration server by using the server.conf.yaml file

You can configure your IBM® App Connect Enterprise integration server by modifying properties in a server.conf.yaml configuration file. This YAML configuration file is created for you automatically when you use the mqsicreateworkdir command to create an integration server work directory.

Before you begin

Ensure that you have set up your command environment, as described in Setting up a command environment.

About this task

You set properties in the server.conf.yaml file to configure the operation of your integration servers and associated resources. For example, you can set a REST administration port and an HTTPS port, and you can also configure the trace level, activity logging, JVM, and the reporting of statistics data for your integration server.

Procedure

  1. If the integration server does not exist already, you can create it by running the mqsicreateworkdir command, specifying the full path to the directory that you want to create. This command creates the integration server work directory. For example:
    mqsicreateworkdir c:\myaceworkdir
    This command creates the specified work directory, which contains a default configuration file called server.conf.yaml. This YAML file contains the default settings for your new integration server. The command also creates subdirectories, which will be used by the integration server when it is running. These include a log directory and a run directory. The log directory contains files of log messages, which can be used to review the status of your integration server. The run directory is where you can place your BAR files prior to starting your integration server, or while it is running. The resources from the BAR file are extracted and started by the integration server.

    If you have a BAR file with resources that contain graphical data maps, XML schemas, or DFDL schemas, these resources can be compiled using the mqsibar command, prior to starting the integration server. This precompilation reduces the time that it takes for the deployed application to start processing messages.

  2. Use a YAML editor to open the server.conf.yaml file.

    If you do not have access to a YAML editor, you can edit the file by using a plain text editor; however, you must ensure that you do not include any tab characters, which are not accepted in YAML and would cause your integration server configuration to fail. If you choose to use a plain text editor, ensure that you use a YAML validation tool to validate the content of your file.

    For more information about working with YAML, see http://www.yaml.org/start.html.

  3. Modify the properties that you want to change, and then save the file. For example:
    • The REST administration port, which is set by the adminRestApiPort property, is the primary method of communicating with the integration server. You can leave this property set to the default value of 7600.
    • Set a value for the httpConnectorPort, so that you can send messages to a flow that is using an HTTPInput node. For example, set this property to a value of 7800.
    • Set a value for the jvmDebugPort, so that you can use the flow/Java debugger. For example, set this property to 6511.
  4. Specify the security credentials to be used by the integration server when connecting to a secured resource (such as a database) by using the mqsisetdbparms command. Use the -w parameter to specify the integration server's work directory that you created in step 1: For example:
    mqsisetdbparms -w c:\myaceworkdir -n jdbc::secID -u iibuser -p password
    When you run this command, the user ID and password are stored securely in the IBM App Connect Enterprise credentials store. For more information about using the mqsisetdbparms command, see mqsisetdbparms command.
  5. Optional: You can configure applications to run when the integration server starts, by pre-loading the BAR file into the run folder of the integration server's work directory. For information on how to do this, see mqsibar command.
  6. Start of changeRestart the integration server. The properties that you set in the server.conf.yaml file take effect when the integration server is started. If you modify these properties again, you must also start the integration server again for the latest changes to take effect. For more information, see Starting an integration server.End of change

xc28541_.htm | Last updated 2018-11-02 14:46:52