Delivered Configuration Plug-ins

env.ptf_user

@userid@

Enter the PTF user.

The userid variable is a template variable and @userid@ resolves at run time to the provided value.

See Defining Template Variables.

env.ptf_allow_untrusted

True

Flag to allow non-trusted SSL certificates.

env.ptf_use_page_prompt

True

Select to use Page Prompt and Prompt OK steps during recording in place of menu navigation. The Use Page Prompt option is also available on the PTF Test Recorder toolbar. The option selected here is the default for all users in this environment. The option selected on the PTF Test Recorder toolbar overrides this selection for that recording session.

env.ptf_use_message_recognition

True

Select to create entries for the Message Recognition feature during recording automatically. The Use Message Recognition option is also available on the PTF Test Recorder toolbar. The option selected here is the default for all users in this environment. The option selected on the PTF Test Recorder toolbar overrides this selection for that recording session.

domain.activate_retry_count

10

Enter the number of retries.

domain.activate_wait_time

10

Enter the wait time for domain activation.

env.activate_local_integration_groups

A comma separated list of the Integration Groups to be activated.

env.activate_service

A comma separated list of Services to be activated.

queue.activate_queue_list

PS_ALL

Use PS_ALL to activate all queues. If you want to activate selected queues, enter queue names separated by commas.

queue.activate_queue_status

1

Valid values:

• 1 - activate a queue

• 0 - pause a queue

Default value is 1.

env.network_nodenames_to_cleanup

NODE1,NODE2

Comma delimited list of node names to have configuration data cleared from network.

If left bank, the plug-in clears configuration data from the network for all nodes currently in the  network, except for the default local node.

env.pia_webserver_host

@host@.@domain@

Server host of the PIA domain.

env.pia_webserver_port

@httpport@

HTTP port on which the PIA domain listens.

env.pia_webserver_ssl_port

@sslport@

HTTPS port on which the PIA domain listens.

env.pia_site_name

PS

PeopleSoft site name.

env.gateway_host

@host@.@domain@

If using multiple machines, enter the gateway server host.

env.gateway_port

@httpport@

If using multiple machines, enter the gateway HTTP port.

env.gateway_ssl_port

@sslport@

If using multiple machines, enter the gateway HTTPS port.

env.use_ssl_gateway

False

This Boolean value specifies whether an SSL gateway is configured for the PeopleSoft system.

env.use_ssl_webserver

False

This Boolean value specifies whether SSL is used or not. It is based on this flag that the security mode is set. If the flag is not set, HTTP is used, else HTTPS is used for node URI.

env.default_user_id

@userid@

Default user ID for the environment.

env.default_local_node_pass

Default local node password.

env.anonymous_default_user_id

@userid@

Specifies the default user ID for message node name ANONYMOUS.

env.default_local_node

@nodename@

Default local node

env.wsdl_external_user_id

@userid@

Specifies the external user ID for wsdl_node.

env.wsdl_external_pass

Specifies the external user password for wsdl_node.

env.configure_wsdl_node

False

Flag to configure WSDL node

env.wsdl_node_tokentype

NONE

Specifies the authentication token type for WSDL.

Valid values:

• NONE

• STSD - SAML token

• USRT - User name token

env.wsdl_node_tokenencrypted

0

Encryption for WSDL node

env.wsdl_node_tokensigned

0

Digital Signature for WSDL node

env.wsdl_node_ibencryptionlevel

A

Specifies the encryption level for WSDL node.

Valid values:

• A - All

• B - Body

• H - Header level

env.gateway_host

@host@.@domain@

Gateway host

env.gateway_port

@httpport@

Gateway port

env.gateway_ssl_port

@sslport@

Gateway SSL port

env.use_ssl_gateway

False

Flag to determine whether the configuration is secure or non secure.

Valid values:

• False - indicates non secure (http) configuration

• True - indicates secure (https) configuration

env.default_local_node

@nodename@

Default local node

env.gateway_user

administrator

Specify the gateway administrator user ID.

env.gateway_password

Specify the password for the gateway administrator user ID.

env.ib_appserver_host

@host@.@domain@

Server host of the application server domain.

env.ib_jolt_port

@jslport@

Jolt port.

env.ib_node_proxy_userid

@userid@

User ID for proxy, if used.

env.ib_node_proxy_password

Password for proxy, if used.

env.tools_release

@tools_release@

PeopleTools release level.

env.ib_appserver_domain_password

Password for the application server domain.

env.ib_virtual_node

When you want a PeopleSoft node to process an inbound request that was sent without a destination node, the integration system directs the request to the node specified for this property.

env.ib_set_as_default_node

True

This flag is set for the node which hosts the common gateway. The flag is true only for the cluster node which hosts the common gateway.

env.gateway_host

@host@.@domain@

Gateway host.

env.gateway_port

@httpport@

Gateway port.

env.gateway_ssl_port

@sslport@

Gateway SSL port.

env.use_ssl_gateway

false

Flag to determine whether the configuration is secure or non-secure.

Valid values:

• True - HTTPS

• False - HTTP

env.gateway_user

administrator

Gateway user name.

env.gateway_password

Gateway user password.

env.gateway_keystore_password

Gateway keystore password.

env.gateway_proxy_host

Gateway proxy host.

env.gateway_proxy_port

Gateway proxy port.

env.gateway_non_proxy_hosts

@host@.@domain@|localhost|*.example.com

Gateway non proxy hosts.

env.ib_synchronize_map_files

Y

Execute MAP File Synchronization

route.nodes.PT_LOCAL.NODEGROUP1

NODE1,NODE2,NODE3

Comma delimited list of nodes to introspect.

route.integration_groups.PT_LOCAL.NODEGROUP1

INTGROUP1,INTGROUP2

Comma delimited list of integration groups to introspect.

route.local_rest_introspection.PT_LOCAL

Y

Enables local REST introspection for this database.

integration_network.NODEGROUP1

NODE1,NODE2,NODE3,NODE4

Comma-separated list of nodes to register.

env.default_local_node

@nodename@

Default local node.

env.app_msg_purge_all_dms

true

Purge application server messages.

env.routingdefinitionname

Integration Broker routing definition name.

env.connector_prop_id

Connector property ID.

env.connector_prop_name

Connector property name.

env.connector_prop_value

Connector property value.

env.add_connector_properties

Y

A flag determining if connector properties need to be added.

env.delete_connector_properties

N

A flag determining if connector properties need to be deleted.

env.pm_sampling_rate

0

Agent PMU sample rate (1/X).

env.pm_buff_int

0

Agent buffering interval (in seconds).

env.pm_sample_int

0

Agent event sample rate (in seconds).

env.pm_ping_int

0

Agent heartbeat interval (in seconds).

env.pm_user_trace

Allow performance trace.

env.pm_max_buff

0

Agent maximum buffer size (in bytes).

env.pm_max_hist_age

0

Retention period (in days).

env.usemon_sw

0

Enable usage monitoring.

env.pm_max_trans_tmout

0

PMU timeout (in days).

env.pm_archive_mode

Valid values for archiving:

• 0 - Archive nothing

• 1 - Archive data

• 2 - Delete data

• 3 - Delete system

env.pm_filter_level2

Filter level values for log documentation:

• 01 - Standby

• 02 - Error

• 03 - Warning

• 04 - Standard

• 05 - Verbose

• 06 - Debug

env.monitor_url

Enter an URL in the following format or enter NONE.

Format:

http(s)://host[:port]/monitor/[site]/

If you enter NONE, the performance monitor components on the monitored system are not enabled.

env.ppmi_user_name

PPMI user ID.

env.ppmi_password

PPMI password.

env.collator_row_limit

Collator row limit.

Use 0 for unlimited rows.

env.ppmi_url

PPMI URL.

Format:

http://host[:port]/monitor/[site]/

env.schedule_reaper_job

Y

Flag to determine whether the Reaper job needs to be scheduled.

env.schedule_lookup_job

Y

Flag to determine whether the Lookup job needs to be scheduled.

env.schedule_archive_job

Y

Flag to determine whether the Archive job needs to be scheduled.

env.schedule_umlookup_job

Y

Flag to whether the Usage Monitor Lookup job needs to be scheduled.

env.cluster_list

List of performance monitor clusters.

env.insert_cluster_urls

N

Flag to determine whether performance monitor clusters need to be inserted or not.

env.delete_cluster_urls

N

Flag to determine whether performance monitor clusters need to be deleted or not.

env.tbe_status

N

Enables TBE.

env.ptpn_row_cnt

10

Sets the maximum number of rows to be displayed in the notification window.

env.ptpn_cat_cnt

10

Sets the maximum number of categories.

env.ptpn_max_cnt

100

Sets the maximum number of notifications to load.

env.url_config_url_id

TEST

URL ID.

env.url_config_url_descr

DESCR

URL description.

env.url_config_url

http://

URL name.

env.url_config_comments

Comments

Comments

env.url_config_property_name

Property name.

env.url_config_property_value

Property value.

env.password_property_value

Holds the property value in case the env.url_config_property_name equals "PASSWORD.”

env.portal_cluster_nodes

PA,HRMS,ERP,EPM,CRM

Comma separated values determine the names of nodes that needs to be part of the portal cluster.

env.remote_folders

HRMS

Comma separated values specify remote node names that need to be accessed for Unified Navigation.

env.remote_folders

NODE1

Comma separated values specify remote node names that need to be accessed for Unified Navigation.

env.portal_cluster_nodes

Comma separated values determine the names of nodes that need to be part of the portal cluster.

NODE1.label

Label for the folder, which will appear in the portal system's menu.

NODE1.portal_name

EMPLOYEE

Portal name.

NODE1.remote_node_name

NODE1

Remote node name.

NODE1.remote_folder_name

PORTAL_ROOT_OBJECT

Remote folder name.

NODE1.local_parent_folder_name

PORTAL_ROOT_OBJECT

Parent of the remote folder.

env.pt_prop_name

Property name.

env.wrkpassword

Node password.

env.wrkcnfpassword

Confirm password.

env.wrkoperpswd

Operator password (encrypted).

env.cdm_ssl_mode

Valid values for SSL mode:

• 0 - EXPLICIT

• 1 - IMPLICIT

env.url

URL ID.

env.uri_host

URI host.

env.pt_fileencpasswd

Encrypted password.

env.distnodename

Distribution node name.

env.ftpaddress

File transfer protocol address.

env.winnetworkpath

Windows network path.

env.cdm_trprotocol

Transfer protocol.

env.descrlong

Description

env.uri_port

0

URI port.

env.uri_resource

URI resource.

env.operpswd

Operator password (encrypted).

env.cdm_proto

Valid values for protocol:

• 0 - HTTP

• 1 - HTTPS

• 2 - XCOPY

• 3 - FTP

• 4 - FTPS

• 5 - SFTP

env.opsys

Valid values for operating system:

• 0 - DOS

• 1 - NT/Win95 Client

• 2 - Windows

• 3 - OS/2

• 4 - UNIX

• 5 - VMS

• 6 - MPE/XL

• 7 - OS390

• 9- OS/400

env.ftpid

File transfer ID.

env.ftpdirectory

Directory for FTP.

env.pt_prop_value

Property value.

env.daemonprcsinst

0

Process instance.

env.maxconcurrent

0

Maximum concurrent processes.

env.notifywhensusp

0

Notify when suspended.

env.transfermaxretry

0

Maximum transfer retries.

env.srvrloadbaloptn

Server load balancing option.

Valid values:

• 0 - Do Not Use for Load Balancing

• 1 - Use for Load Balancing

env.redistwrkoption

Redistribute workload option.

Valid values:

• 0 - Do not redistribute

• 1 - Redistribute with same O/S

• 2 - Redistribute to any O/S

env.minmem

0

Minimum memory required.

env.distid

Distribution ID.

env.servername

Server name.

env.prcsnotifyfreq

0

Notify frequency.

env.start_hours

Start hours.

env.notifywhenstartd

0

Notify when started.

env.maxapiaware

0

Maximum API aware tasks.

env.daemonenabled

Daemon enabled.

env.end_hours

End hours.

env.end_minutes

End minutes.

env.notifydisabled

Notify disabled.

env.prcspriority

Process priority.

Valid values:

• 1 - Low

• 5 - Medium

• 9 - High

env.maxcpu

0

Maximum CPU usage required.

env.prcstype

Process type.

env.day_ofweek

Day

Valid values:

• 0 - Sunday

• 1 - Monday

• 2 - Tuesday

• 3 - Wednesday

• 4 - Thursday

• 5 - Friday

• 6 - Saturday

env.distnodename

Distribution node name.

env.prcscategory

Process category.

env.notifyservererror

0

Server errors.

env.notifywhendown

0

Notify when down.

env.sleeptime

0

Sleep time.

env.heartbeat

0

Heartbeat

env.transferlogfiles

Transfer log files to content.

env.transferinterval

0

Interval for transfer attempt.

env.daemongroup

Daemon procedure group.

env.start_minutes

Time

env.distidtype

Distribution ID type.

Valid values:

• 2 - User ID

• 3 - Role name

env.daemonsleeptime

0

Daemon sleep time.

env.daemoncyclecnt

0

Daemon recycle count.

env.descr

Description

env.opsys

Operating system.

Valid values:

• 0 - DOS

• 1 - NT/Win95 Client

• 2 - Windows

• 3 - OS/2

• 4 - UNIX

• 5 - VMS

• 6 - MPE/XL

• 7 - OS390

• 9- OS/400

env.processtypepriority

1

Process type priority.

Valid values:

• 1 - Low

• 5 - Medium

• 9 - High

env.processtypemaxconcurrent

3

Process type maximum concurrent value.

env.search_network.operation

REGISTER

Valid values:

• REGISTER

• UNREGISTER

env.search_network.dest_node_names

NODE1

Comma-separated list of nodes from which search groups need to be imported from.

env.search_network.NODE1

Comma-separated list of nodes from which search groups need to be imported to the NODE1 node.

env.ptsf_selection_type

Global

Valid values:

• All

• Global

• List

env.ptsf_include_definitions

True

Comma separated list of search category names to be included. You can use % as an operator.

env.ptsf_exclude_definitions

True

Comma separated list of search category names to be excluded. You can use % as an operator.

env.ptsf_check_audit_errors

True

If true check for access to query/connected query, or invalid objects and stop if errors found.

env.ptsf_admin_operations

DEPLOY, INDEX

Comma-separated list of administration operations. Valid values:

• Deploy

• Index

• Undeploy

• Deploy,Index

You can use any combination of comma-separated values.

env.ptsf_index_all_languages

False

If true the schedules are created to index all languages.

env.report_schedule_status_after_minutes

Maximum minutes to wait before reporting scheduling status. Enter 0 to wait till finish; leave blank to skip report.

env.ptsf_schedule_on_server

Specify the Process Scheduler to run the indexing on. Leave this blank to use master scheduler.

env.ptsf_cleanup_operations

CLEANUP

Indicates the operation to perform.

env.ptsf_cleanup_remotegroups

true

Indicates whether there are remote search groups to clear from the database in clustered environments.

env.ptsf_search_instance

The search instance name.

env.search_provider

ES

Name of the search engine. Valid value is ES.

env.search_nodes

1

The number of nodes you want to create in the Elasticsearch cluster.

If you create multiple nodes, then you will see additional properties specific to each node, such as, env.node1_search_host, env.node2_search_host, env.node3_search_host.

env.node1_search_host

@searchhost@

Search engine host name.

env.node1_search_port

9200

Search engine port. The default port number for Elasticsearch is 9200.

env.node1_search_use_ssl

False

SSL option.

env.node1_search_admin_user

Search engine administrator user name.

env.node1_search_admin_password

Search engine administrator password.

env.node1_search_read_user

User name for query service.

env.node1_search_read_password

Password for query service.

env.search_call_back_user

@userid@

Call back user name.

env.search_call_back_password

Call back password.

env.ps_search_administrator_user

@userid@

Search administrator user name.

env.ps_search_developer_user

@userid@

Search developer user name.

env.gateway_host

@host@.@domain@

Gateway host.

env.gateway_port

Gateway port.

env.gateway_ssl_port

Gateway SSL port.

env.use_ssl_gateway

False

Flag to determine whether the configuration is secure or non secure.

Valid values:

• False - indicates non secure (http) configuration

• True - indicates secure (https) configuration

env.default_local_node

@nodename@

Default local node.

env.enable_global_menu_search

ALL

Enables global search and menu search for All, Local or comma separated list of portals.

env.monitor_es_host

Sets the host name of the monitoring Elasticsearch server.

env.monitor_es_port

Sets the port of the Elasticsearch monitoring server.

env.monitor_es_ssl

False

Flag to determine whether the monitoring Elasticsearch server configuration is secure or non secure.

Valid values:

• False - indicates non-secure (http) configuration.

• True - indicates secure (https) configuration.

env.monitor_es_user

esadmin

Search engine administrator user name.

env.monitor_es_password

Search engine administrator password.

The password should be encrypted.

env.monitor_kibana_host

Sets the host name of the monitoring Kibana server.

env.monitor_kibana_port

Sets the port of the Kibana server.

env.monitor_kibana_ssl

Flag to determine whether the Kibana server configuration is secure or non secure.

env.scan_interval

5

Sets the time interval (in seconds) to retrieve system metrics from Elasticsearch server.

env.purge_retention

1

Sets the number of days to store the system and indexing metrics.

env.enable_index_metrics

No

Flag to determine whether index metrics should be collected or not.

env.enable_system_metrics

No

Flag to determine whether system metrics should be collected or not.

env.dashboard_selection

ALL

Specifies the dashboards to be deployed. The valid values are:

• ALL

• LIST

env.dashboard_list

Comma separated list of PeopleSoft Health Center dashboards to be deployed to Kibana.

env.email_id_types

Valid values are:

• BB — Blackberry

• BUS

• HOME

• OTH

• WORK

env.email_ids

If you enter multiple e-mail IDs, separate e-mail IDs by using comma.

env.primary_email

Primary e-mail account.

env.worklists_user

Y

Flag to set routing preference to worklist, that is, the system will deliver work items to a worklist.

env.email_user

Y

Flag to set routing preferences to an e-mail address, that is, the system will deliver work items to an e-mail address.

env.worklists_active

Y

Flag to enable worklists for your users.

env.email_active

Y

Flag to enable the system to send e-mail to workflow users.

env.hr_installed

Flag to specify whether you are using PeopleSoft HCM applications.

env.cert_type

ROOT,NODE

Defines the type of certificate whether it is RootCA or Remote Node.

If it is RootCA, enter certificate type as ROOT, else enter NODE for public certificate.

env.cert_alias

Enter an alias name for the RootCA and local node name for Remote Node in Alias.

env.cert_issuer_alias

Issuer alias name will be same as the RootCA alias name.

env.cert_string

Enter certificate PEM data as a string.

env.cert_file_path

Enter the path to certificate file containing certificate PEM formatted data.