Creating a Template File Manually

This section discusses:

  • Working with the structure and general settings of a template file.

  • Specifying general settings.

  • Specifying template settings.

  • Enabling configuration plug-ins.

This section discusses:

  • Naming the template file.

  • Setting the structure of the template file.

Naming the Template File

Using the text editor for your operating system, create a new file and save it using the following convention:

<file_name>.<file_extension>

The file extension can be .txt, .properties, or any extension that is readable in ASCII format.

Note: You need to specify the template name using the PTEM_PROP environment variable prior to running the PTEM_CONFIG Application Engine program.

Setting the Structure of the Template File

The content of the properties should be structured in the following order:

  1. General settings.

  2. Template settings.

  3. Individual configuration plug-in settings.

To enable a plug-in, you include a reference to that plug-in, such as:

plugin.IB.1=PTEM_CONFIG:PTIBRenameNode

where

  • IB - refers to the category of the plug-in.

  • 1- represents the sequence number in which plug-ins are configured.

  • PTEM_CONFIG:PTIBRenameNode - represents the plug-in name, which consists of application package name (PTEM_CONFIG) and class name (PTIBRenameNode).

Then, you include the properties for that plug-in immediately following the plug-in reference. The following example illustrates a sample template file:

configure=true
verify=true
decrypt_password=true

template.domain=@webhist.SESSIONCOOKIEDOM
template.host=@webhist.WEBSERVERNAME
template.httpport=@webhist.PORTALHTTPPORT
template.jslport=@webhist.jolt_port
template.localnode=%LocalNode
template.piasite=@webhist.ps.discovery.siteName
template.sslport=@webhist.PORTALHTTPSPORT
template.tools_release=%ToolsRelease
template.userid=%UserId

#Group:Integration Broker
#Description:Integration Broker Configurations

##### Rename the default local node#####

plugin.IB.1=PTEM_CONFIG:PTIBRenameNode

#Default local node
env.default_local_node=@localnode@

#Purge application server messages
env.app_msg_purge_all_dms=true

Note: All other configuration plug-ins you want to enable can be included in the file as needed.

The general settings appear at the top of the template file. These settings apply to the overall configuration program run.

Property

Description

configure

Enables you to set the entire template file as active by setting it to true. If set to false, the PTEM_CONFIG Application Engine program ignores the plug-ins and settings stored within the template file.

verify

If set to true, the automated configuration management framework verifies the settings. The parameters provided in the template file are validated against the corresponding values inserted into the database to ensure they are identical.

encrypt_password

If set to true, any sensitive data stored in the template file will be encrypted, and it will generate a template file where the sensitive data is encrypted.

decrypt_password

Set to true if the template file contains any encrypted sensitive data.

generate_property_file

Set to true if the template file consists only plug-in names and the properties for each plug-in is to be generated. If set to True, the property generates a new file (new_config_file.txt) with the plug-in properties in the same path where the template file is stored.

Template settings are a group of settings that apply to almost all configuration plug-ins and can be shared across multiple property settings. For example, HTTP port is a template setting, and rather than specifying it for each and every configuration value where it is needed (PIA ‘URL, URI URL, Integration Gateway URL, and so on), you can specify it once in the template settings, and it will be replicated as needed throughout the template file, where referenced. This avoids unnecessary repetition and errors.

You can use %SystemVariable to default the value to a system variable; and use

%ENV_VARIABLE_NAME% to set.

You can also retrieve stored values in the web profile web history, by using

@webhist.<property_name>.

The following example illustrates the template settings section of a sample template file:

template.domain=@webhist.SESSIONCOOKIEDOM
template.host=@webhist.WEBSERVERNAME
template.httpport=@webhist.PORTALHTTPPORT
template.jslport=@webhist.jolt_port
template.localnode=%LocalNode
template.piasite=@webhist.ps.discovery.siteName
template.sslport=@webhist.PORTALHTTPSPORT
template.tools_release=%ToolsRelease
template.userid=%UserId

Property

Description

template.domain

Name of the PIA domain, such as ‘peoplesoft’.

template.host

Server host for the web server installation.

template.httpport

The HTTP port on which the PIA domain listens.

template.jslport

Jolt port.

template.localnode

The current node used by the system. %Dbname or %LocalNode can be used if applicable.

template.piasite

The name of the PeopleSoft site.

template.sslport

The HTTPS port on which the PIA domain listens.

template.tools_release

PeopleTools release.

template.userid

User ID for accessing and configuring the system.

You can include the configuration plug-ins in this section within your template file.

The following example illustrates the PTIBRenameNode configuration plug-in. In this example, the plug-in is not enabled because the plug-in is commented (#). To enable the plug-in, delete the (#) hash sign preceding the plug-in name. For example, plugin.IB.1=PTEM_CONFIG:PTIBRenameNode.

##### Rename the default local node#####

#plugin.IB.1=PTEM_CONFIG:PTIBRenameNode

#Default local node
env.default_local_node=@localnode@

#Purge application server messages
env.app_msg_purge_all_dms=true

Note: All other configuration plug-ins you want to enable can be included in the file as needed.

In PIA, you can enable a plug-in in a template by selecting the check box corresponding to the plug-in on the Configuration Template Definition page.

See Creating a Template.