Configure the “Connect Data Source” UI for ITBA Integration

After the integration test, you must define the end point settings for the data source required for the activation of the integration. The Connect Data Source User Interface enables you to activate, deactivate and configure data source parameters based on the Content Pack data source .XML file. For new content you can customize the datasourceDef.xml file and configure according to the requirements of your Content Pack. Once you have created a new Content Pack directory, it should contains the .XML configuration file in the following directory:
$HPBA_HOME/ContentPacks/<CP_Name>/conf/dataSourceDef.xml

Any configuration changes made in the .XML file can then be viewed in the Connect Data Source UI. For details, see Data Management - Connect the Data Sources

Deploy the Configuration

The Connect Data Source UI supports new data source types that can be extended at runtime. You deploy the configuration using the .XML file listed below. It provides a dynamic list of attributes that are required to connect to a new source type.

The Data Source Activation process uses all of these attributes to connect to the data source. When you want to integrate a new data source data into ITBA, you create a directory for the data source.

Each Content Pack includes a custom Connect Data Source User Interface definition file in .XML format (dataSourceDef.xml). It is located by default at:
$HPBA_HOME/ContentPacks/<CP_name>/conf

1. Configure the dataSourceDef.xml file that is used to create the Connect Data Source UI page for the corresponding data source. The page is used by the administrator to enter the details of the data source.

   The following is a sample dataSourceDef.xml file:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <dataSourceType typeId="AM">
      <fields>
         <field fieldType="LIST" required="false" fieldId="version">
    	   <localizedLabel>
    		<key>AMVersion</key>
    		<defaultString>AM Version</defaultString>
    	   </localizedLabel>
    	   <options>
    		<option key="5.1" label="5.1"/>
    		<option key="5.2" label="5.2/9.3"/>
    	   </options>
    		<preselectedValue>5.2</preselectedValue>
      </field>
         <field fieldType="LIST" required="false" fieldId="timezone">
     <generatorClass>com.hp.btoe.dw.dsm.server.TimeZonesGenerator</generatorClass>
    		<localizedLabel>
    			<key>wizardTimeZone</key>
    			<defaultString>Time Zone</defaultString>
    		</localizedLabel>
    	</field>
    	<field fieldType="SPACER" >
    	</field>
    	<field fieldType="LIST" required="false" fieldId="productType">
    		<localizedLabel>
    			<key>wizardDBProductName</key>
    			<defaultString>Data Source Type</defaultString>
    		</localizedLabel>	
    		    <options>
    			<option key="mssql" label="MSSQL"/>
    			<option key="oracle" label="Oracle"/>
    		     </options>	
    		<preselectedValue>mssql</preselectedValue>
    	</field>
    	<field fieldType="SPACER" >
    	</field>
    	<field fieldType="TEXT" required="true" fieldId="user">
    		<localizedHint>
    			<key>wizardUsernameHint</key>
    			<defaultString>&lt;&lt;Enter username&gt;&gt;</defaultString>	
    		</localizedHint>	
    		<localizedLabel>
    			<key>wizardUsername</key>
    			<defaultString>Username</defaultString>
    		</localizedLabel>
    </field>
   

   • The .XML file contains, per Content Pack, the definition of the different properties. Each Property field can have the following types:

     • LIST. The user must select from a list of parameters.
     • TEXT. The user must enter the relevant text in the field.
     • SPACER. Configures a space between fields in the UI.
     • PASSWORD. The user enters an encrypted password in the field.
     • BOOLEAN. The user selects a checkbox.

   • The following options can be configured for field values:

     • preselectedValue. The displayed default value.

       Example: For the AM Version field the default value is 5.2.

       <key>AMVersion</key>
        <defaultString>AM Version</defaultString>
        </localizedLabel>
        <options>
        <option key="5.1" label="5.1"/>
        <option key="5.2" label="5.2/9.3"/>
        </options>
        <preselectedValue>5.2</preselectedValue>
        </field>
       

     • required. A mandatory field. Mandatory fields are indicated by a red asterisk in the UI.

       Example: The Username field is mandatory:

       </field>
        <field fieldType="TEXT" required="true" fieldId="user">
        <localizedHint>
        <key>wizardUsernameHint</key>
        <defaultString>&lt;&lt;Enter username&gt;&gt;</defaultString>
        </localizedHint>
        <localizedLabel>
        <key>wizardUsername</key>
        <defaultString>Username</defaultString>
        </localizedLabel>
        </field>
       

     • dependentField/Value. A field that is displayed only when a specific value is selected.

       Example: The string SID is only enabled when the selected value in the dependent productType field is Oracle.

       <localizedLabel>
        <key>wizardSid</key>
        <defaultString>SID</defaultString>
        </localizedLabel>
        <dependentField>productType</dependentField>
        <dependentValues>oracle</dependentValues>
        </field>
       

     • localizedHint. Text that is displayed to assist the user in entering or selecting a value.

       Example: The Username field displays a hint for the user: "Enter username".

       <field fieldType="TEXT" required="true" fieldId="user">
        <localizedHint>
        <key>wizardUsernameHint</key>
        <defaultString>&lt;&lt;Enter username&gt;&gt;</defaultString>
        </localizedHint>
        <localizedLabel>
        <key>wizardUsername</key>
       

2. Deploy the Configuration File: When you have completed the .XMLfile, save it as $HPBA_HOME/ContentPacks/<CP_Name>/conf/dataSourceDef.xml, in which <CP_Name> is the name of the Content Pack you are creating for the data source you want to integrate with ITBA.