12 Setting Up Oracle Tuxedo as a Cloud Service

This chapter contains the following sections:

12.1 Overview

Enterprise Manager for Oracle Tuxedo supports modeling Oracle Tuxedo system and applications as a cloud service (TXaaS) and supplies a set of implementation (UI, Profiles, Jobs etc.) to be managed by Enterprise Manager. TXaaS enables customers to have a unified private middleware PaaS solution across different versions of Oracle Tuxedo. Self service application administrator (SSA admin) can manage Oracle Tuxedo cloud and corresponding Oracle Tuxedo services based on requirements. Self service application users (SSA user) select proper service for provisioning and then deploy their business applications on the service instance. From cloud administration point of view, this feature supplies the cloud management functions like resource provider management, quota management, and service template definition. From end user point of view, this feature provides operations like, service instance creation, application management, and deployment, automatic scaling based on scheduled plan or metrics.

Parent topic: Setting Up Oracle Tuxedo as a Cloud Service

12.2 Setting Up the Tuxedo Self Service Portal

Note:

Before you set up a Tuxedo service family, the common setup tasks must have been performed. See Common Setup Tasks in Enterprise Manager Cloud Administration Guide for details.

To set up the Oracle Tuxedo as a Service, go to the Tuxedo Service Setup page by following these steps:

  1. Log in to Enterprise Manager as a user with the EM_SSA_ADMINISTRATOR role.
  2. From the Enterprise menu, select Cloud-> Cloud Home. The Cloud Home page appears.
  3. From the Oracle Cloud menu, select Setup -> Getting Started. Click the Setup link next to Tuxedo in the left panel.

    From the Getting Started: Tuxedo page, you need to complete the following required setup steps. Click on a tab in the left to show the related setup page in the right side detail pane.

Parent topic: Setting Up Oracle Tuxedo as a Cloud Service

12.2.1 Creating a Tuxedo PaaS Infrastructure Zone

A PaaS Infrastructure Zone can contain a group of hosts. Each zone can contain homogeneous resources of only one type. Each resource in a zone represents a location at which a service instance is to be deployed.

The Tuxedo PaaS zone is an out-of-box component and can share with other cloud services. The Tuxedo PaaS zone can be deleted only when none of service instance is running on any of its hosts.

To create a Tuxedo PaaS zone, follow these steps:

  1. In the Getting Started: Tuxedo page left panel, click PaaS Infrastructure Zone. Then click Create.
  2. In the Create PaaS Infrastructure Zone: General page, enter the target name, name, and description for the zone. Click Next .
  3. Click Add to add one or more host members to the zone. The hosts that you select cannot be present in more than one PaaS Infrastructure Zone. Click Next.
  4. In the Create PaaS Infrastructure Zone: Credentials page, specify the host credentials that are to be used for provisioning all targets in this zone. The credentials provided should be of global credential type (valid across the members in the zone) and owned by the current user. Click Next.

    Note:

    To create new named credentials, from the Setup menu, select Security, then select Named Credentials. You can create user or password named credentials here. Other types of credentials such as SSH must be created from the Security menu and can be used here. The named credential must be the one configured as "Global preferred credential" for the host target type.
  5. Specify appropriate values for the placement policy constraints based on the resources available to the host members.

    The placement policy constraints are used to set maximum ceilings for any host in the zone. Placement policy values are used during deployment to filter out hosts that are overburdened. You can define the following placement policy constraints for each host:

    • Maximum CPU Utilization: The average CPU utilization percentage for the past 7 days.
    • Maximum Memory Allocation: The average memory allocation for the past 7 days.

    Hosts exceeding these thresholds will not be considered for provisioning operations.

  6. Click Next. In the Create PaaS Infrastructure Zone: Characteristics page, specify the target properties such as cost center, lifecycle status, location, and so on.
  7. Click Next. The Create PaaS Infrastructure Zone: Roles page appears. A PaaS Infrastructure Zone can be made available to a restricted set of self service users with the EM_SSA_USER role. Click Add to add and select the roles that can access this PaaS Infrastructure Zone.
  8. Click Next. The Create PaaS Infrastructure Zone: Review page appears. Review the details of the zone being created and click Submit to create the zone.

Parent topic: Setting Up the Tuxedo Self Service Portal

12.2.2 Creating a Tuxedo Pool

A Tuxedo Pool contains a set of resources that can be used to provision a Tuxedo service instance within a PaaS Infrastructure Zone. You must create separate Tuxedo pools in the PaaS Infrastructure Zone for different type of hosts.

To create a Tuxedo Pool, follow these steps:

  1. In the Getting Started: Tuxedo page left panel, click Tuxedo Pool.
  2. Click Create. The Create Tuxedo Pool: General page appears. Enter a name and description for the Tuxedo Pool. Select the PaaS Infrastructure Zone in which the Tuxedo pool is to be created. Click Next.
  3. In the Members page, select the platform of the hosts you are going to add. The Host table filters all the hosts running on the selected platform.
  4. Click Add to add one or more host members to the pool. Click Next.
  5. In the Create Tuxedo Pool: Placement Constraints page, enter the maximum number of tuxedo domain instances that can be deployed to a host target. Click Next.
  6. In the Characteristics region, specify direcory under which the Tuxedo products and related applications are to be installed and a NFS location used to deploy the JES domain that requires NFS directory for JESROOT configuration.

    Note:

    For the existing domain, if IsHostExclusive of the domain package was configured to true, you can choose to keep all primary directory structure and deploy to the same directories on the target host.
  7. In the Target Properties region, specify the characteristics that will be used to tag and identify the target properties. Click Next.
  8. Review the information and click Submit to create the Tuxedo pool. The newly created pool can now be used to create Tuxedo Service Templates.

Parent topic: Setting Up the Tuxedo Self Service Portal

12.2.3 Configuring Tuxedo Profiles

Provision profiles are designed to provide the Tuxedo domain deployment package for provisioning service instance and creating one kind of Tuxedo installation. By use of the provision profile, user can collect necessary software installation into an image and distribute it to other hosts avoiding install and configure all these software from the beginning.

TSAM Plus supports packaging Tuxedo products, customer domain deployment packages, and Oracle DB client libraries in a profile. All the softwares required by running the domain must be included in the domain package.

For products, the Tuxedo installation media must be uploaded from local machine.

For customer applications, the whole Tuxedo domain should be introspected from target hosts. The same directory structure is kept during Tuxedo domain redeployment.

Parent topic: Setting Up the Tuxedo Self Service Portal

12.2.3.1 Creating a Tuxedo Profile

The Tuxedo profile uses the Tuxedo domain package to provision service instances. Before creating a Tuxedo profile, you must have created the desired domain package. You can create it from scratch or from an existing domain using the introspection feature in the Enterprise Manager Console. For more information, refer to Introspecting an Existing Domain.

To create a Tuxedo profile, follow these steps:

  1. In the Getting Started: Tuxedo page left panel, click Tuxedo Profile.
  2. In the Tuxedo: Tuxedo Profile page, click Create.
  3. Enter a name and description for the profile, and select the platform the product installation media supports. Click Next.
  4. Click Add and select the product you want to add.

    You can add more than one products to a profile for provisioning. Only one tuxedo installation media is needed.

    Oracle Tuxedo, Oracle Tuxedo Application Runtimes, Oracle Tuxedo Patch, and Other Products can be configured in the profile. Default installation scripts (Perl script) is provided for installing these products. You can specify the default scripts for special installation purpose. When configuring other products, installation location and environment variables are required to tell provisioning procedure where the product to be installed and what runtime environment variables should be exported to applications. PROD_DIR,ORA_HOME, and BASE_DIR can be used as the marco in runtime variables. The macro format is ${macro name}.

    For example, for ART CICS application, COBOL-IT is mandatory and the third party software must be installed before Oracle Tuxedo Application Runtime installation. Following parameters must be specified when configuring COBOL-IT installation.

    Name: COBOL-IT_Package

    Display Name: COBOL-IT Package

    Description:

    Install Location:cobol

    Environment Variables:

    export COBOLITDIR=${PROD_DIR}

    export LD_LIBRARY_PATH=$COBOLITDIR/lib:$LD_LIBRARY_PATH

    export PATH=$COBOLITDIR/bin:$PATH

    export COB_ENABLE_XA=1

    Note:

    ${ORA_HOME} is used as the default home name in Oracle inventory. it must not be used before.
    You need to configure the installation scripts if the default scripts cannot meet your installation requirements.
    For example:
    
COBOL-IT.zip
.
|-sbin
|-samples
|---test
|---sort
|---screens
|---customer
|-docs
|-doc
|-share
|---icucit
|-----51.1
|-------config
|---locale
    If two products depend on each other, you need to customize the scripts to install them properly.

    Click Save when you complete editing of the scripts. Click Next.

  5. (Optional) If you want to deploy the Tuxedo domain, add a domain package to the profile and click Next. Currently, only one domain package can be configured.
  6. Review the information and click Submit to create the Tuxedo profile.

You will find the profile status shows Ready if the Tuxedo profile has been created successfully.

12.2.4 Setting Up Quotas

Quota refers to the total machines of a Tuxedo domain that can be allocated to each self service user belonging to a certain role. This quota applies only to the service instances provisioned through the Tuxedo Self Service Portal. Quota is enforced at the time of self service request.

If the current quota is reduced, this change in quota does not affect existing service instances. The new quota applies only to new self service requests.

To define a quota, follow these steps:

  1. In the Getting Started: Tuxedo page left panel, click Quotas.
  2. In the Create Quota page, select the Role Name for which the quota is to be granted.
  3. Specify the maximum number of the Tuxedo machines that can be configured for the user with this role. Click OK

Parent topic: Setting Up the Tuxedo Self Service Portal

12.2.5 Creating a Service Template

A service template can be used to provision Tuxedo service instances into one or more Tuxedo Pool. When creating a service template, you need to define a provision profile to provide product installation media, default configurations and corresponding Tuxedo domain deployment packages. So a Tuxedo provision profile must have been created beforehand.

To create a service template, follow these steps:

  1. In the Getting Started: Tuxedo page left panel, click Service Templates
  2. Click Create. Enter a name and description for the service template.

    Note:

    If you want to create a new template with similar configuration settings of an existing service template, you can get a quick start by selecting that service template in the list and click Create Link to launch the creating wizard with all configured parameters loaded.
  3. In the Provisioning Profile field, click the search icon and select a Tuxedo provisioning profile.

    The Tuxedo provisioning profile you select can contain either of the following:

    • Only the Tuxedo products. This type of profile just packages the Tuxedo installation media.
    • Tuxedo application binaries besides Tuxedo installation. In this case, entire Tuxedo configurations, scripts, and binaries are included in the profile in the format of Tuxedo domain package.
  4. Click Next. In the Characteristics page, specify the characteristics that will be used to tag and identify the target properties. Service instances created from the template will have the characteristics.
  5. Click Next. In the Resource Providers page, Click Add to select the Tuxedo Pool into which the service instances are to be provisioned.
  6. Click Next. In the Configuration page, specify the parameters that will be used to provision service instances according to onscreen descriptions.

    The Tuxedo domain configuration options displayed here vary depending on the placeholders configured in the domain package definition.

    Before creating the service instance, these parameters can be overridden by the SSA user if the parameter is not locked or hidden by the SSA administrator.

    To hide or lock the parameter to the SSA user, select the Hide checkbox or click the Lock icon.

    Note:

    If no domain package is defined in the provisioning profile or just a number of hosts with necessary products installed are provided, you can set the "Only Products" option to true and specify the host number. In such case, only the specified number of hosts are reserved and installed when requesting a service instance.
  7. Click Next. In the Roles page, click Add to select the self service user roles to which this service template will be available. All users belonging to the selected role can use this service template.

    Note:

    If no role is added here, the SSA user will fail to request a service due to lack of quota.
  8. Click Next. Review the information entered so far and click Submit.

    You will find the newly created service template is displayed in the Service Templates page. You can click on the Service Template Name link to view additional details.

Parent topic: Setting Up the Tuxedo Self Service Portal

12.2.6 Configuring Request Settings

You can configure the request settings by specifying when a request can be made, its duration, and so on. To configure the request settings, follow these steps:

  1. In the Getting Started: Tuxedo page left panel, click Request Settings.
  2. Specify the following parameters to set the global settings or settings for a specific role:
    • Future Reservation: How far in advance can a request be made.
    • Request Duration: Maximum duration for which a service can exist.
    • Archive Policy: Maximum duration after which archived requests are automatically deleted.
    • Service Instance Approval: Select this checkbox if all requests need to be approved by the self service administrator.
    • Service Instance Share Settings: A service instance can be shared with another user or a role. You can select either or both the checkboxes:
      • Allow SSA User to share service instances with other Users.
      • Allow SSA User to share service instances with Roles.
  3. Click Apply.

Parent topic: Setting Up the Tuxedo Self Service Portal

12.2.7 Configuring Chargeback

Note:

Before using Chargeback, it is assumed that you have read Enterprise Manager Cloud Administration Guide. Make sure that you have deployed Oracle Consolidation Planning and Chargeback plugin. If Oracle Consolidation Planning and Chargeback is absent, deploy it following Managing Plug-Ins in Enterprise Manager Cloud Administration Guide Enterprise Manager Cloud Administration Guide.

There is only one Chargeback Entity Type for Tuxedo, Oracle Tuxedo Machine. Therefore, Tuxedo Chargeback is based on Tuxedo Machine target instance number.

To create a Chargeback for the Tuxedo Machine, follow these steps:

  1. Click Configure Charge Plan link to go to Charge Plans page to create a Chargeback for Tuxedo Machine.
  2. Click Create drop down list, select Plan to create a new Tuxedo chargeback plan.
  3. Click Add under Entity Types. In the Add Entity Types window, make sure Oracle Tuxedo Machine is selected.
  4. In the Oracle Tuxedo Machine page, click Add to add Chargeback items.
  5. Click Configure Cost Center to configure cost center. For more information, see Chargeback Administration in Enterprise Manager Cloud Administration Guide.
  6. Click Configure Targets to assign the Chargeback plan to an existing Tuxedo Machine.

    You can choose the target instances of Tuxedo Cloud Service, Tuxedo Domain, or Tuxedo Machine. If you choose target instances of either Tuxedo Cloud Service or Tuxedo Domain, only the Tuxedo Machines inside the Tuxedo Cloud Service or Tuxedo Domain are used to calculate total costs.

Parent topic: Setting Up the Tuxedo Self Service Portal

12.3 Using the Tuxedo Self Service Portal

Self Service Application users can use the Tuxedo Self Service Portal to create and control Tuxedo service instances, and monitor Tuxedo services.

Note:

Before using the Tuxedo self service portal, the EM_SSA_USER role must have been configured in the Paas Infrastructure Zone, Quotas, and Service Templates definition.

To view the Tuxedo Self Service Portal, log in to Enterprise Manager as a user with EM_SSA_USER role.

Select Enterprise -> Cloud -> Self Service Portal, and click Tuxedo Cloud Services.

In the Tuxedo Cloud Services page, the top region shows the following icons:

  • Instances: This icon shows the number of service instances that have been created by the current SSA user and their status.
  • Expiry: The number of instances due to expire today, this week, and in the future.
  • Usage: Shows the service instance number in normal status.

From the tabs in the left of the page, you can also enter the following pages:

  • Requests: Click on this tab to view a list of all requests. For each request, the status, type, start date, and submission date of the request is displayed. Click on the status icon to view the execution details of the request. These details are helpful in troubleshooting a failed request.

    Select columns from the View menu to view more details about the request. You can select a scheduled request and click Reschedule to reschedule the request. To delete a request, select the request and click Delete.

  • Chargeback: Click the Chargeback tab to view the charge summary information. For more information, see Chargeback
  • Policies: Click the Policies tab to view the list of policies that you have defined. You can create a new Performance or Schedule Based Policy or a Policy Group for one or more Tuxedo services and define Scale Up or Scale Down on these policies. For more information, see Defining Policies for Tuxedo Services.

Parent topic: Setting Up Oracle Tuxedo as a Cloud Service

12.3.1 Requesting a Tuxedo Service

To request a Tuxedo service, follow these steps:

  1. Click Create Instance in the Home page of the Tuxedo Cloud Self Service Portal.
  2. The Service Catalog - Create Instance window appears. A list of service templates available to the self service user is displayed. Choose a service template and click Select to launch the Create Instance wizard.
  3. Enter a name for the instance and select the Self Service Zone in which the new service is to be deployed.
  4. In the Instance Duration region, specify the schedule for the instance.
    • Creation Date: You can choose Immediately (request is executed immediately) or Later. If you select the Later option, specify the date from which the service is to be available.
    • End Date: Select Indefinitely to make the service available for a indefinite period of time. If you select Until, specify the date on which it will be deleted and no longer available.
  5. Click Next. The Characteristics page appears.
  6. In the Target Properties region, specify the characteristics that will be used to tag and identify the target properties. Service instances created from the template will have the characteristics.
  7. Click Next. The Configuration page appears.
  8. Specify the Tuxedo domain externalizable variables, service provisioning mode, and port range according to the description of each option in the page. Click Next.

    Note:

    This step settings overwrites the parameters configured in the Sevice Template.

    You can configure a tlisten password which is used for security connections between tlisten processes in a MP mode domain.

  9. Review the information entered so far and click Submit to create the service request.

    This request will now appear in the Request page in the Tuxedo Self Service Portal. You can monitor the status of this request in this table. When the request has been completed, you can refresh the page to view the new service in the Instances table.

    Note:

    • The user with the EM_SSA_ADMIN role cannot create service instances.
    • The SSA users having no quota cannot make a service request.

Parent topic: Using the Tuxedo Self Service Portal

12.3.2 Controlling the Tuxedo Service

In the Instances page, the Instances table shows the list of Tuxedo services owned by the self service user and any other services for which the user has view privileges. You can perform the following actions when selecting a service from the table:

  • Delete: Delete the service instance. The entire domains associated to this service instance will be stopped and all applications will be deleted from each host that has been deployed before. This action does not uninstall the Tuxedo installation media.
  • Extend: Extend the life of the service instance. You are prompted for the End Date. Enter a date later than the current one and click OK to extend the service instance.
  • Start: Start the service and boot the corresponding Tuxedo domain.
  • Stop: Stop the service and shut down the corresponding Tuxedo domain.
  • Grant: You can grant view, manage, or full privileges over the service instance to other users and roles.
  • Revoke: You can revoke privileges that you have granted to other users and roles.

Parent topic: Using the Tuxedo Self Service Portal

12.3.3 Viewing the Tuxedo Service Home Page

The Tuxedo Service Home page provides detailed information about the services you have requested. To view the Tuxedo Service Home page, click the Name link of the Tuxedo service instance in the service instance table. This page contains the following regions:

  • Top action menu: it provides the following actions:
    • Set End Date: Specify an end date for the Tuxedo service.
    • Start and Stop: Start or stop the service.
    • Scale Up and Scale Down: Increase or reduce the number of Tuxedo machines.
  • Summary: Shows the availability status of the service, status summary of the Tuxedo Servers.
  • Tuxedo Domain List: Lists Tuxedo domains.
  • Requests: Lists the requests against this Tuxedo service instance in 24 hours.

Parent topic: Using the Tuxedo Self Service Portal

12.3.4 Chargeback

The Chargeback page displays charge information for Tuxedo machines in login SSA user. Only the Tuxedo Machine target instances associated with predefined Tuxedo Charge Plan are monitored here. For more information, seeConfiguring Chargeback .

Top region shows total charge amount. From the bottom region you can view the Charge Trend in graph and details in table.

Parent topic: Using the Tuxedo Self Service Portal

12.3.5 Defining Policies for Tuxedo Services

To define a policy, click the Policies tab. From the Create menu, you can select either of the following:

Parent topic: Using the Tuxedo Self Service Portal

12.3.5.1 Creating a TXaaS Schedule Policy

For instance, if you want to create a schedule based policy that states that a tuxedo service must be scaled up every Monday, follow these steps:

  1. Click the Policies tab in the Tuxedo Self Service Portal.
  2. Click Create and select Schedule Policy.
  3. Enter a name and description for the policy.
  4. Select the Policy Action. There are four actions:
    • Scale Down Tuxedo Service Instance
    • Scale Up Tuxedo Service Instance
    • Start Tuxedo Service Instance
    • Start Tuxedo Service Instance
  5. In the Start field, specify the date from which this policy must be effective.
  6. In the Repeat field, specify Every N minutes/hours/days/weeks and then specify N.
  7. Click OK to create the policy. You will return to the Policies page where the policy you have defined will appear in the Policies table. To apply these policy for a target, click Add in the Associations region and select a target with which this policy must be associated.

    Note:

    TSAM Plus 12.2.2 does not support scaling up the Jolt domain. (Kindly review this note).
12.3.5.2 Defining a TXaaS Performance Policy

Performance policies are formed based on the performance metrics of a specific target type and its associated targets. You can create conditions and rules for the policy based on the metrics. To define a performance policy, follow these steps:

  1. Click the Policies tab in the Tuxedo Self Service Portal.
  2. Click Create and select the Performance Policy type.
  3. In the General Information page, enter the name and description of the policy. Click Next.
  4. In the Create Performance Policy: Rule page, select a metric from the right panel and click Add to Definition. Specify the condition, value, and number of occurrences. When these conditions are met, the policy is executed. Click Next.
  5. Select one of the following actions from the Action drop down list. Click Next.
    • Scale Down Tuxedo Service Instance
    • Scale Up Tuxedo Service Instance
    • Start Tuxedo Service Instance
    • Stop Tuxedo Service Instance
  6. Review the policy details and click Save and return to the Policies page.
  7. In the Associations region, click Add and select one or more targets to be associated with this policy. The associated targets are listed in the Associations region.

    Click on the target link to view a list of policies associated with the target. Once the targets have been associated, the policy is activated. Click View History to view the policy action history.

12.4 Introspecting an Existing Domain

The Tuxedo profile uses the Tuxedo domain package to provision service instances. Before creating a Tuxedo profile, you must have created the desired domain package. You can create it from scratch or from an existing domain using the introspection feature in the Enterprise Manager Console or introspecting command.

This section contains the following topics:

Parent topic: Setting Up Oracle Tuxedo as a Cloud Service

12.4.1 Introspecting an Existing Domain From Console

To introspect an existing domain into a domain package from Enterprise Manager Console, follow these steps:

  1. Create a new introspection project: .
    1. From the Enterprise Manager Console menu, click Targets > Middleware at the top
    2. In the Middleware page, click Middleware Features > Tuxedo Summary.
    3. In the Oracle Tuxedo Summary page, click Introspect.
    4. Click New to create a new introspection project and select one of the domains monitored by Enterprise Manager from the list.

      The master machine information is listed at the bottom. If the host on which the master machine deployed are configured with the preferred credential, the host credential will be filled automatically.

      Alternatively, if you want to introspect a tuxedo domain not monitored by Enterprise Manager, fill the necessary machine configuration parameters in the bottom panel.

      Note:

      Any host can be the candidate to retrieve the UBB
    5. Click OKto retrieve the tuxedo domain UBB configurations.

      When the tuxedo domain UBB configuration is successfully retrieved from target host/machine, each tab page shows the machine configuration of this domain. You can configure “Third Party Software” which is required by the domain but outside of APPDIR. Such binary/configuration file must be added in the right table list one by one. When packaging the machine binary package, these file/folder will be collected together with all contents under APPDIR.

  2. Click Package > Introspect to invoke the introspecting process. When the process completes successfully, the Confirmation window with the result and domain package file name is displayed.
  3. Click Package >Download to download the desired domain package to the local machine.
  4. (Optional) Click Save to export the newly created introspection project parameters to the local computer. The file is exported as XML format without a user password. The file can be used to introspect the domain under the command line mode as well.
  5. (Optional) Click Open to upload a local project file saved before.

    After the project file is successfully uploaded and parsed, all the introspection parameters are shown.

After the project file is successfully uploaded and parsed, all the introspection parameters are shown.

Parent topic: Introspecting an Existing Domain

12.4.2 Introspecting an Existing Domain Using Command Line

Introspection Command

Name

java -jar TxdoDomainPackager.jar

Synopsis

java -jar TxdoDomainPackager.jar -prop property file [-template]

Options

prop

Required. Full path to the property file which contains introspection parameters and corresponding values.

template

Optional. Creates a property file template to let you focus on specifying necessary values.

Examples

java -jar TxdoDomainPackager.jar -template

A property file template InputParamsTemplate.xml is created under the location where java command invoked.

Edit the template InputParamsTemplate.xml to suit your environment and save it as params.xml.

java -jar TxdoDomainPackager.jar -prop params.xml

A binary package zip file is created under the location where java command invoked.

Parent topic: Introspecting an Existing Domain

12.4.2.1 Property File Template Format
Property File Template

<?xml version="1.0" encoding="UTF-8"?>
<CmdOptions>
<General>
<!-if these options not configured in general section, then configure these items should be configured to each host section
, especially for those mandatory items, i.e. AppDir,TuxDir, TuxConf,User,Pwd.
Default value of "IncludeLocal" is false.
-->
<AppDir>[application directory]</AppDir>
<TuxDir>[Description of this package]</ TuxDir >
<JavaHome>[full path of java home]</ JavaHome>
<TuxConf>[tuxedo configuration full path]</ TuxConf >
<EnvFile>[Set runtime environment file]</EnvFile>
<DmConf>[tuxedo configuration full path]</ DmConf >
<SaltConf>[tuxedo configuration full path]</SaltConf >
<TnsNamesLocation>[tuxedo configuration full path]</ TnsNamesLocation>
<OraDbClientDir> [Oracle DB client Directory] </OraDbClientDir>
<IncludeLocal>[true or false]</ IncludeLocal>
<User>[user which can be shared with all hosts]</User>
<Pwd>[password which can be shared with all hosts]</Pwd>
</General>
<Hosts>
<Host>
<NetAddress></NetAddress
<Softwares>
<Software> <!-can be multiple -->
<Name>[Name of this software]</Name>
<Location>[full path where is this software]</Location>
</Software>
</Softwar>
[Following options can be specified to override the same one configured in general section]
<User></User>
<Pwd></Pwd>
<AppDir/>
<TuxDir/>
<JavaHome/>
<WorkingDir />
<TuxConf/>
<DmConf/>
<SaltConf/>
<TnsNamesLocation/>
<IncludeLocal/>
<JavaHome/>
</Host>

Following is a property file example:

Property File Example 


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CmdOptions>
<General>
<TuxDir>/home/yfli/oracle/tux_oh/tuxedo12.1.3.0.0</TuxDir>
<JavaHome>/home/yfli/tools/jdk1.7.0_55</JavaHome>
<User>yfli</User>
<Pwd></Pwd>
</General>
<Hosts>
<Host>
<NetAddress>localhost</NetAddress>
<TnsNameLocation>/home/yfli/tools/ora_client/12.1.0/client_1/tnsnames.ora</TnsNameLocation>
<OraDbClientDir>/home/yfli/tools/ora_client/12.1.0/client_1</OraDbClientDir>
<AppDir>/home/yfli/apps/tux1213/domapp/domain1</AppDir>
<TuxConf>/home/yfli/apps/tux1213/domapp/domain1/tuxconfig</TuxConf>
<DmConf>/home/yfli/apps/tux1213/domapp/domain1/bdmconfig</DmConf>
<SaltConf>/home/yfli/apps/tux1213/domsalt/saltconfig</SaltConf>
<EnvFile>/home/yfli/apps/tux1213/domsalt/setenv.sh</EnvFile>
<Softwares> <Software>
<Name>test1</Name>
<Location>/home/yfli/apps/tux1213/cics</Location>
</Software>
<Softwares> </Host>
<Host>
<NetAddress>…...cn.oracle.com</NetAddress>
<JavaHome>/home/yfli/tools/jdk1.7.0_55</JavaHome>
<AppDir>/home/yfli/apps/tux12130/mp</AppDir>
<TuxDir>/home/yfli/oh/tux12130</TuxDir>
<TuxConf>/home/yfli/apps/tux12130/mp/tuxconfig</TuxConf>
<User>yfli</User>
<Pwd> </Pwd>
<Softwares>
<Software>
<Name>cmds</Name>
<Location>/home/yfli/cmds</Location>
</Software>
</Softwares> </Host>
</Hosts>
</CmdOptions>
12.4.2.2 Application/Library Package

A binary package zip file is created during introspection process for each of machine configured in the Tuxedo domain. This package includes all the applications, libraries, and all third party products that the domain needs. The file is named [lmid].zip and is configured in the Tuxedo domain package configuration file. For example, when introspecting the machine "LMID1" on a host, its binary package in the configuration file may look like the following:

Binary Package in Configuration File 
<?xml version="1.0" encoding="UTF-8"?>
<DomainPackageConfig>
…
<PackagesUsed>
<BinaryPackage>
<ArchiveFormat>ZIP</ArchiveFormat>
<SubFolders>
<FolderInfo>
<Name>APPDIR</Name>
<Destination/>
<IsShared>false</IsShared>
</FolderInfo>
</SubFolders>
<Name>SITE1.zip</Name>
<Description/>
<Location/>
<Destination/>
</BinaryPackage>
…
</PackagesUsed>
…
</DomainPackageConfig>

The zip file includes following contents which are all copied from APPDIR:

`-- APPDIR

|-- java.env

|-- setenv.sh

|-- simpcl

|-- simpserv1

|-- starttlisten

|-- tuxconfig

|-- tuxconfig.decompiled

|-- ubb

`-- ubb.test

Note:

The configuration files in this folder will be overwritten by the ones in config_LMID1 folder if those files destination location is APPDIR.
12.4.2.3 Limitation

When introspecting an existing domain running on the different machine with OMS, the machines configured in the domain can not post message in the .bashrc configuration file. This causes SFTP connection failure.

12.4.2.4 Placeholders File Format and Usage

Placeholders are used to replace old values in configuration files. These placeholders can be treated as "Variables" which will be filled with the real value at deployment time. All the placeholders are defined in the package configuration file. The following listing shows the definitions.

Placeholders Definition 

<Name></Name> // this is the variable name used in the configuration file in the format of ${name}
<Type> </Type> // Indicates that the macro is well-known or not
<Label> </Label> //Label name that will displayed on GUI
<Value> </Value> //Value of this placeholder delegate
<Description/> //Hint messages that will displayed on GUI
<IsSecurity></IsSecurity> //The value should be inputted by a security text box
<OriginalValue></OriginalValue> //Original value in the configuration file

Placeholders can be used in any configuration and script files which will be handled during provisioning procedure. The placeholder in these files is in format of ${placeholder}.

Placeholders Example


<?xml version="1.0" encoding="UTF-8"?>
<DomainPackageConfig>
…
<Placeholders>
<Placeholder>
<Name>SITE1-tsam-manager-host</Name>
<Type>UBB_TSAM_ADDR</Type>
<Label>TSAM Manager Address</Label>
<Description/>
<IsSecurity>false</IsSecurity>
<OriginalValue>10.182.55.120</OriginalValue>
</Placeholder>
…
</Placeholders>
…
</DomainPackageConfig>

UBB, DM, SALT, and Oracle TNS configuration files are parsed during introspecting, and replaced with placeholders at deployment time automatically. The following listing lists the well-known placeholder types:

Well-known Placeholder Types 
IPC_LOCAL //IPC key which will be filled value automatically
NET_PORT //Net port which will be filled value automatically
LOCAL_NET_ADDR //Local net address which will be filled value automatically
UBB_MACHINE_NAME //real host name of machine
UBB_NET_ADDR // net address
UBB_NLS_PORT //NLS net port
UBB_NA_PORT // NA net port
JMX_PORT //JMX net port
JMX_ADDRESS //JMX net address
DM_LOCAL_ADDRESS // Domain gateway local net address;
DM_LOCAL_PORT // Domain gateway local net port;
DM_REMTOTE_PORT // Domain gateway remote net port;
DM_REMOTE_ADDRESS // Domain gateway remote host address;
UBB_DOMAIN_IPCKEY //Domain IPC Key
UBB_DOMAIN_ID //Domain ID
DOMAIN_PWD //Domain Application password
DOMAIN_USER //User name if domain configured with ACL/Mandatory ACL
DOMAIN_USER_PWD //User password
GLOBAL_VAR //Global variable
CUSTOMIZED //User defined placeholder

The placeholders assigned with the type of UBB_MACHINE_NAME, UBB_NET_ADDR, UBB_NLS_PORT, UBB_NA_PORT, JMX_PORT, JMX_ADDRESS, DM_LOCAL_ADDRESS, DM_LOCAL_PORT are handled automatically. That is, their values are filled by provisioning procedure. For those placeholders assigned with the type of "GLOBAL_VAR", the value can be embedded with other placeholders. See the example shown in below:

Placeholders with GLOBAL_VAR
<?xml version="1.0" encoding="UTF-8"?>
<DomainPackageConfig>
…
<Placeholders>
<Placeholder>
<Name>SITE1-G_VAR</Name>
<Type> GLOBAL_VAR </Type>
<Label>TSAM Manager Address</Label>
<Value>${SITE1-ADDRESS}:${SITE1-PORT}</Value>
<Description/>
<IsSecurity>false</IsSecurity>
<OriginalValue>10.182.55.120</OriginalValue>
</Placeholder>
…
</Placeholders>
…
</DomainPackageConfig>

When manually making a domain package instead of using introspecting tool, you can use the following placeholders in the configuration and scripts files directly:

  • lmid-APPDIR
  • lmid-TUXDIR
  • lmid-ORAHOME

lmid is the logical name of the machine configured in UBB.

For those automatically handled placeholders, for example, ${SITE1-machine-name} is filled with a real host name at provisioning time without any input from end users. But in the case that there is no proper value to replace the placeholder, you need to input the values. For example, ${GWDOMAIN3-remote-port} in DM CONF will be filled with proper value to the best extent possible. If no proper value can be determined automatically, you need to input the value. Here is an example that shows the process of how to handle such placeholders.

Suppose two domains are connected with each other through domain gateway and both are included in a provisioning profile. Domain 1 connects to WTC which will be viewed as domain 3. The DM configuration will look like this:

Domain 1 DM configuration-dm1.conf 

*DM_RESOURCES
*DM_LOCAL
"GWDOMAIN1" GWGRP="SYSGRP"
ACCESSPOINTID="GWDOMAIN1"
…
*DM_REMOTE
"GWDOMAIN2" ACCESSPOINTID="GWDOMAIN2"
CREDENTIAL_POLICY="LOCAL"
"GWDOMAIN3" ACCESSPOINTID="GWDOMAIN3"
CREDENTIAL_POLICY="LOCAL"
*DM_TDOMAIN
"GWDOMAIN1" NWADDR="//${GWDOMAIN1-local-addr}:${GWDOMAIN1-local-port}"
NWPROTOCOL=LLE
"GWDOMAIN2" NWADDR="//${GWDOMAIN2-remote-addr}:${GWDOMAIN2-remote-port}"
"GWDOMAIN3" NWADDR="//${GWDOMAIN3-remote-addr}:${GWDOMAIN3-remote-port}"
Domain 2 DM configuration-dm2.conf 
*DM_RESOURCES
*DM_LOCAL
"GWDOMAIN2" GWGRP="SYSGRP"
ACCESSPOINTID="GWDOMAIN2"
…
*DM_REMOTE
"GWDOMAIN1" ACCESSPOINTID="GWDOMAIN1"
CREDENTIAL_POLICY="LOCAL"
*DM_TDOMAIN
"GWDOMAIN1" NWADDR="//${GWDOMAIN1-remote-addr}:${GWDOMAIN1-remote-port}"
NWPROTOCOL=LLE
"GWDOMAIN2" NWADDR="//${GWDOMAIN2-local-addr}:${GWDOMAIN2-local-port}"

When handling dm1.conf at provisioning time, the assembly procedure attempts to find the host in Domain 2 UBB configuration (find it by access point) by comparing original net address value. If the host is successfully found, the new address will be filled ${GWDOMAIN2-remote-addr}, but if domain 2 is not included in the profile or such host can not be found in domain 2 UBB, then you need to provide this value before submitting the provisioning procedure, for example, provide the value for ${GWDOMAIN3-remote-addr}.

Following configuration files are introspected and handled automatically:

  • UBB CONF
  • DM CONF
  • SALTCONFIG
  • Oracle TMS configuration file

    UBB sample assembled with placeholders: 

…
*MACHINES
"${SITE1-machine-name}" LMID="SITE1"
TUXCONFIG="${STITE1-APPDIR}/tuxconfig"
TUXDIR="${SITE1-TUXDIR}"
APPDIR="${SITE1-APPDIR}"
TLOGNAME="TLOG"
TLOGSIZE=100
MAXWSCLIENTS=20
"${SITE2-machine-name}" LMID="SITE2"
TUXCONFIG="${SITE2-APPDIR}/tuxconfig"
TUXDIR="${SITE2-TUXDIR}"
APPDIR="${SITE2-APPDIR}"
TLOGNAME="TLOG"
TLOGSIZE=100
…
*SERVERS
LMS" SRVGRP="GROUP1"
SRVID=100
CLOPT="-A -- -l ${SITE1-tsam-manager-host}:${SITE1-tsam-manager-port}/tsam"
RQPERM=0666
REPLYQ=N
RPPERM=0666
MIN=1
MAX=1
…

12.5 Introspecting ART Applications

When introspecting ART applications, following parameters and files are collected and zipped into a domain package.

Parent topic: Setting Up Oracle Tuxedo as a Cloud Service

12.5.1 ART CICS Introspection

Table 12-1 ART CICS Introspection

Description Source Type Placeholder Add to Package
ARTTCPL -n netaddr -S ssladdr -L pnetaddr CLOPT Network address Y n/a
ARTTCPL [-p profile-name] CLOPT File location Y N
ARTCSKL -p port CLOPT Network address Y n/a
DD_VSAMFILE Env Variable File location Y Y
KIXCONFIG Env Variable File location Y Y
KIXDIR Env Variable File location N (auto set to ARTCICS install dir) N
KIX_CWA_IPCKEY Env Variable IPC Key Y n/a
KIX_DUMP_FILE Env Variable File location Y N
KIX_JOURNAL_DIR Env Variable File location Y N
KIX_MAP_PATH Env Variable File location Y Y
KIX_QSPACE_IPCKEY Env Variable IPC Key Y n/a
KIX_SHR_IPCKEY Env Variable IPC Key Y n/a
KIX_SPOOL_OUTPUT_DIR Env Variable File location Y N
KIX_TD_DIR Env Variable File location Y N
KIX_TD_QSPACE_IPCKEY Env Variable IPC Key Y n/a
KIX_TECH_DIR Env Variable File location Y N
KIX_TRACE_PATH Env Variable File location Y N

Parent topic: Introspecting ART Applications

12.5.2 ART Batch Introspection

Table 12-2 ART Batch Introspection

Description Source Type Placeholder Add to Package
JESDIR Env Variable File location N (Batch RT install dir) N
$JESDIR/ejr/CONF/* Env Variable - Y Y
PROCLIB Env Variable File location Y N
MT_ACC_FILEPATH Env Variable File location Y N
MT_CTL_FILES Env Variable File location Y N
MT_KSH Env Variable File location N (pdksh dir) N
MT_DB_LOGIN Env Variable User/passwd Y n/a
MT_DB_LOGIN2 Env Variable User/passwd Y n/a
MT_GDG_DB_ACCESS Env Variable User/passwd Y n/a
MT_LOG Env Variable File location Y N
MT_ROOT Env Variable File location - -
MT_SYSOUT Env Variable File location Y N
MT_TMP Env Variable File location Y N
DATA Env Variable File location Y N
TMP Env Variable File location Y N
SYSIN Env Variable File location Y N
MT_CONFIG_FILE Env Variable File location Y Y
ARTJESADM -i JESCONFIG CLOPT File location Y Y
JESCONFIG:JESROOT Config option File location Y N
JESCONFIG:JES_ACL_FILE Config option File location Y Y
JESCONFIG: JOBREPOSITORY Config option File location Y Y
JES_TRACE_PATH Env Variable File location Y N

Parent topic: Introspecting ART Applications

12.5.3 ART IMS Introspection

Table 12-3 ART IMS Introspection

Description Source Type Placeholder Add to Package
IMSDIR Env Variable File location N (IMS RT install dir) N
ART_IMS_CONFIG Env Variable File location Y Y
ART_IMS_DB Env Variable File location Y Y
ART_IMS_FMT Env Variable File location Y Y

Parent topic: Introspecting ART Applications