Automated deployment utility configuration file format

The automated deployment utility configuration file has the following XML element structure:
  • deployment - this element contains the following elements:
    • was - this element provides the deployment information for WebSphere® Application Server.
    • ftm - this element provides the deployment information for Payment Feature Services.
The following sections describe the deployment elements and provide an example of a automated deployment utility configuration file.

was element

The was element of the configuration file is used to provide information about the WebSphere Application Server instance to use for the deployment.
Table 1. Elements contained by the was element
Element Description
was_home The full path to the local installation of WebSphere Application Server.
maxRebootWaitInSeconds The maximum amount of time, in seconds, to wait for WebSphere Application Server to restart when working with a profile. If the restart does not complete within this time period, the utility returns an error.
wsadminTraceString The string used to configure the trace settings for the secure connection between the utility and the profile. The default is to enable tracing at the warning level.
profileHome The attributes for this element provide information for the WebSphere Application Server profile being created. Refer to Table 2 for a description of the attributes for this element.
Table 2. Attributes for the profileHome element
Attribute Description Values / Example
location The full path to the local directory in which to create the profile when it does not exist. This attribute is not used when the profile already exists. /opt/IBM/myProfiles
localServer Indicates if the profile is local or remote. Only local is supported, so set this attribute to true. true, false
isWinService For profiles created on the Windows operating system, this attribute indicates if the profile is to be run as a Windows operating system service. The default is false for this attribute. true, false
winserviceAccountType The account type of the Windows operating system service for this profile. This attribute is optional and is only used if the profile is to run as a Windows operating system service. localsystem, specifieduser
winserviceCheck Indicates if a Windows operating system service is created for the server process that is created within the profile. This attribute is only used if the profile is to run as a Windows operating system service. true, false
winserviceUserName The user ID to use to create the Windows operating system service for this profile. This attribute is only used if the profile is to run as a Windows operating system service. myUserId
winserviceStartupType Indicates how the Windows operating system service is started. This attribute is only used if the profile is to run as a Windows operating system service. automatic, manual, disabled
startPort The starting port value for the profile. It is used only for creating the profile, not for connecting to it. The connection port is in the token file. The Payment Feature Services default offsets are used. 58000
personalCertDN The distinguished name for the personal certificate for the profile. cn=localhost, ou=izhCell, ou=izhNode, o=IBM, c=US
signingCertDN The distinguished name for the signing certificate for the profile. cn=localhost, ou=Root_Certificate, ou=izhCell, ou=izhNode, o=IBM, c=US
personalCertValidityPeriod The validity period, in days, for the personal certificate. 1
signingCertValidityPeriod The validity period, in days, for the signing certificate. 15
keyStorePassword The password to use for the keystore. WebAS

ftm element

The ftm element of the configuration file is used to provide information about the deployment. This includes information about the installation location, configuration, and which components of Payment Feature Services are to be deployed.
Table 3. Elements contained by the ftm element
Element Description
ftm_install_path The installation directory that was provided to the installation program when the following features were installed:
  • FTM for Digital Payments
  • FTM for Corporate Payment Services
ftm_token_file The full path and file name of the token file to use for the deploy.
ftm_version The version number of the features to be deployed. The version is required because more than one version of the features can be installed into the installation directory that was provided to the installation program (install_directory). Specify the version as a three digit number. For example, use 300 for version 3.0.0.
install The list of the components that are to be deployed. This element contains a component element for each component that is to be deployed.
uninstall The list of the components that are to be removed before the components in the install element are deployed. This element contains a component element for each component that is to be removed.

This element is optional.
component The identifier of the component that is to be deployed or removed.

Example configuration

This example automated deployment utility configuration file shows path names in an AIX® directory format.

<deployment>
   <was>
      <!-- change this to point to your full installation path for WAS 8.0 -->
      <was_home>/opt/IBM/WebSphere/AppServer</was_home>
      <maxRebootWaitInSeconds>1200</maxRebootWaitInSeconds>
      <wsadminTraceString>com.ibm.*=warn=enabled</wsadminTraceString>
      <!-- change this to point to where to create the profile if it does not exist -->
      <profileHome location="/opt/IBM/myProfiles"
               localServer="true"
               isWinService="false"
               winserviceAccountType="localsystem"
               winserviceCheck="true"
               winserviceUserName="myUserId"
               winserviceStartupType="automatic"

               startPort="58000"
               personalCertDN="cn=localhost,ou=izhCell,ou=izhNode,o=IBM,c=US"
               signingCertDN="cn=localhost,ou=Root_Certificate,ou=izhCell,ou=izhNode,o=IBM,c=US"
               personalCertValidityPeriod="1"
               signingCertValidityPeriod="15"
               keyStorePassword="WebAS">
      </profileHome>
   </was>

   <ftm>
      <!-- change this to point to the Installation Manager installation path for the FTM features -->
      <ftm_install_path>/opt/IBM/ftm</ftm_install_path>
      <!-- change this to point to your token file -->
      <ftm_token_file>/opt/IBM/ftm/shared/v3213/pfs/DeploymentUtility/pfs_tokens.xml</ftm_token_file>
      <!-- change this to the version of FTM you want to deploy -->
      <ftm_version>300</ftm_version>
      <install>
         <!-- remove or comment out any component you do not want deployed -->
         <!-- Payment Feature Services components -->
         <component>CVP_Console</component>                  <!-- Vetting UI -->
         <component>CVP_Engine</component>                   <!-- Vetting Engine -->
         <component>IYB_Console_CoreUI</component>           <!-- Payment Feature Services base UI -->
         <component>IYB_Console_PartnerProfileUI</component> <!-- Payment Feature Services base UI -->
         <component>IYBSF_Console</component>                <!-- Services Framework UI -->
         <component>IYBSF_Engine</component>                 <!-- Services Framework Engine -->
         <component>IZG_Console</component>                  <!-- Transaction Server UI -->
         <component>IZL_Console</component>                  <!-- Distribution UI -->
         <component>IZL_Engine</component>                   <!-- Distribution Engine -->
         <component>IZR_Console</component>                  <!-- Settlement UI -->
         <component>IZR_Engine</component>                   <!-- Settlement Engine -->
         <component>IZW_Console</component>                  <!-- Business Rules UI -->
         <component>IZX_Console</component>                  <!-- Gateway engine -->
         <component>IZX_Engine</component>                   <!-- Gateway UI -->
         <component>TCM_Console</component>                  <!-- TCR UI -->
         <component>TCM_Engine</component>                   <!-- TCR Engine -->



         <!-- Digital Payments specific components -->
         <component>NOC_Console</component>                  <!-- Notification of Change UI -->
         <component>NOC_Engine</component>                   <!-- Notification of Change Engine -->



         <!-- Digital Payments and Corporate Payment Services specific components -->
         <component>RSK_Console</component>                  <!-- Risk Review UI -->
         <component>RSK_Engine</component>                   <!-- Risk Review Engine -->
         <component>WS_Engine</component>                    <!-- Web Services Engine -->
      </install>

      <uninstall>

      </uninstall>
   </ftm>
</deployment>