Using a connector-specific property template

To create a configuration file for your connector, you can start with a previously created connector configuration file (*.cfg), a connector definition file (*.txt) or a repository file (*.in or *.out), if any of these already exists for your connector. For instructions on using such existing files, see Using an existing file.

If none of those files exist, or if they are too dissimilar to the configuration requirements of your connector, you can start instead by creating a template for the connector-specific properties of your connector. You'll create properties in the template, define general characteristics and values for those properties, and specify any dependencies between the properties. Then you'll save the template and use it as the base for creating a new connector configuration file.

Creating a template of connector-specific properties

To create a template:

  1. Choose File>New>Connector-Specific Property Template.
  2. The Connector-Specific Property Template dialog appears, with the following fields

Specifying general characteristics

The Properties - Connector-Specific Property Template dialog appears. The dialog has tabs for General characteristics of the defined properties and for Value restrictions. The General display has the following fields:

After you have made selections for the general characteristics of the property, choose the Value tab.

Specifying values

The Value tab enables you to set the maximum length, the maximum multiple values, a default value, or a value range for the property. To do so:

  1. Choose the Value tab. The display panel for Value replaces the display panel for General.
  2. Select the name of the property in the Edit properties display.
  3. In the fields for Max Length and Max Multiple Values, make any necessary changes. Note that the changes will not be accepted until and unless you also open the Property Value dialog for the property, described in the next step.
  4. Right-click the box in the left-hand corner of the Value display panel. A Property Value dialog displays. Depending on the type of the property, the dialog allows you to enter either a value, or both a value and range. Enter the appropriate value or range, and click OK.
  5. The Value panel refreshes to display any changes you made in Max Length and Max Multiple Values, and it displays a table with three columns:

    The Value column shows the value that you entered in the Property Value dialog, and any previous values that you created.

    The Default Value column allows you to designate any of the values as the default.

    The Value Range shows the range that you entered in the Property Value dialog.

    After a value has been created and appears in the grid, it can be edited from within the table display. To make a change in an existing value in the table, select an entire row by clicking on the row number. Then right-click in the Value field and choose EditValue.

Setting dependencies

After you have finished making changes in both the General and the Value tabs, choose Next. The Dependencies dialog appears.

A dependent property is a property that is included in the template and used in the configuration file only if the value of another property meets a specific condition. To designate a property as being dependent and set the condition upon which it depends, do this:

  1. In the Available Properties display, select the property that will be made dependent.
  2. In the Select Property field, use the drop-down menu to select the property that will hold the conditional value.
  3. In the Condition Operator field, choose one of the following:

    == (equal to)

    /= (not equal to)

    > (greater than)

    < (less than)

    >= (greater than or equal to)

    <=(less than or equal to)

  4. In the Conditional Value field, enter the value that is required in order for the dependent property to be included in the template.
  5. With the dependent property highlighted in the Available Properties display, click an arrow to move it to the Dependent Property display.
  6. Click Finish. Connector Configurator stores the information you have entered as an XML document, under \data\app in the\bin directory where you have installed Connector Configurator.

Creating a configuration file from a connector-specific template

After a connector-specific template has been created, you can use it to create a configuration file:

  1. Choose File > New>Connector Configuration.
  2. The New Connector dialog appears, with the following fields:
  3. A configuration screen will display for the connector that you are configuring. The title bar of the configuration screen shows the broker that you are using and the name that you have given to the connector. You can fill in all the field values to complete the definition now, or you can save the file and complete the fields later.

    When you are using the configuration screen, you can, if you wish, add additional connector-specific properties, as described under Setting application-configuration properties (ICS). Any such additions become part of the configuration file that you are creating, but do not affect the template that you used in creating the file.

  4. To save the file, choose File > Save > to File or File > Save > Save to the project. To save to a project, you must be using ICS as the broker, and System Manager must be running. If you save as a file, the Save File Connector dialog displays. Choose *.cfg as the file type, verify in the File Name field that the name is spelled correctly and has the correct case, navigate to the directory where you want to locate the file, and choose Save. The status display in the message panel of Connector Configurator indicates that the configuration file was successfully created.
    Important:
    The directory path and name that you establish here must match the connector configuration file path and name that you supply in the startup file for the connector.
  5. To complete the connector definition, enter values in the fields for each of the tabs of the Connector Configurator window, as described for your broker later in this chapter.

Copyright IBM Corp. 1997, 2003