Delivered Configuration Plug-ins

PeopleTools delivers these plug-ins for customer usage. The properties of each plug-in are described in the following sections.

Application class - PTEM_CONFIG:ConfigurePTF

The ConfigurePTF plug-in grants PTF User role to the PTF user and allows to accept non SSL requests.

Property

Default Value

Description

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 untrusted 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.

Application class - PTEM_CONFIG:PTIBActivateDomain

The PTIPActivateDomain plug-in activates pub/sub domain.

Property

Default Value

Description

domain.activate_retry_count

10

Enter the number of retries.

domain.activate_wait_time

10

Enter the wait time for domain activation.

Application class: PTEM_CONFIG:PTIBActivateLocalServices

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTIBActivateQueues

The PTIBActivateQueues plug-ins activates the Integration Broker queue.

Property

Default Value

Description

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.

Application class: PTEM_CONFIG:PTIBCleanUpNetworkData

PTIBCleanUpNetworkData clears Integration Broker Network configuration data from the system.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTIBConfigureDBNode

The PTIBConfigureDBNode plug-in configures the database node.

Property

Default Value

Description

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

Application class - PTEM_CONFIG:PTIBConfigureGatewayNodes

The PTIBConfigureGatewayNodes plug-in configures gateway URL, load connectors, and defines node in the gateway.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTIBConfigureGatewayProperties

The PTIBConfigureGatewayProperties plug-in sets keystore password, proxy host, proxy port, and non proxy host in gateway properties file.

Property

Default Value

Description

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

Application class: PTEM_CONFIG:PTIBIntrospectionDeployment

PTIBIntrospectionDeployment introspects and deploys the selected services.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTIBNodeRegistration

The PTIBNodeRegistration plug-in registers new nodes to the Integration Broker network.

Property

Default Value

Description

integration_network.NODEGROUP1

NODE1,NODE2,NODE3,NODE4

Comma-separated list of nodes to register.

Application class: PTEM_CONFIG:PTIBMapApprovalSvcInstall

This plug-in does not require parameters as input. It invokes the Application Engine program: HMAP_MAPUP internally.

Application class: PTEM_CONFIG:PTMapLayoutEnableSSL

PTMapLayoutEnableSSL enables SSL for the specified MAP layouts or all MAP layouts in a system.

Property

Default Value

Description

env.map_layout_names

NONE

Comma delimited list of MAP layouts to be enabled for SSL.

env.map_enable_all_layouts

false

Enables all MAP layouts to be enabled for SSL if the value is set to true.

Application class - PTEM_CONFIG:PTIBRenameNode

The PTIBRenameNode plug-in renames the default local node.

Property

Default Value

Description

env.default_local_node

@nodename@

Default local node.

env.app_msg_purge_all_dms

true

Purge application server messages.

Application class: PTEM_CONFIG:PTIBRoutingDefinition

PTIBRoutingDefinition configures the Integration Broker routing definition.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTPerformanceMonitor

Before you run the PTPerformanceMonitor plug-in, ensure that the following pre-requisites are set in the monitoring system and in the monitored system:

Note: The PTPerformanceMonitor plug-in must be run in the monitoring and in the monitored systems.

  • Perf Collator should be set to Yes (enabled) for the corresponding application server domain.

  • In the psappsrv.cfg file and the psprcs.cfg file, the EnablePPM Agent parameter should be set to 1.

  • Process scheduler domain must be up and running so that the reaper and archive jobs can be scheduled successfully.

  • In the web profile configuration, set the following:

    • In the General tab, select the EnablePPM Agent parameter.

    • In the Custom Properties tab, set the value of PPMConsole parameter to True.

      If the PPMConsole parameter is not present, add the parameter. The parameter must be of Boolean type.

Additionally, to enable Usage Monitor as part of the performance monitor configurations, the following pre-requisites are required:

  • In the psappsrv.cfg file, the Usage Monitoring State parameter should be set to 1 or 2.

  • On the System Defaults page (PeopleTools, Performance Monitor, Administration, System Defaults), the Enable Usage Monitoring check box should be selected. Alternatively, in the PTPerformanceMonitor plug-in properties, you can set the env.usemon_sw property to 1.

Important! After executing the PTPerformanceMonitor plug-in, clear the cache and restart the application server and Web server for the configurations to take effect.

Property

Default Value

Description

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.

Application class: PTEM_CONFIG:PTPNSystemConfig

The PTEM_CONFIG:PTPNSystemConfig plug-in sets the system configurations required for Push Notification.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTURLConfiguration

The PTURLConfiguration plug-in configures URL configurations.

Property

Default Value

Description

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.”

Application class - PTEM_CONFIG:PTPPConfigurePortalCluster

The PTPPConfigurePortalCluster plug-in configures portal host nodes of the portal cluster.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTUNConfigureRemoteFolders

The PTUNConfigureRemoteFolders plug-ins configures unified navigation remote folders.

Property

Default Value

Description

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 drop-down 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.

Application class - PTEM_CONFIG:PTProcessSchedulerReportNode

The PTProcessSchedulerReportNode plug-in configures Process Scheduler report node configuration.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTProcessSchedulerServerConfig

The PTProcessSchedulerServerConfig plug-in configures Process Scheduler server configuration.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTSFAdministerRemoteSearch

The PTSFAdministerRemoteSearch plug-in configures remote search groups as specified in search network.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTSFAdministerSearch

The PTSFAdministerSearch plug-in deploys, undeploys, and schedules index generation for search definitions/categories from a selected list.

Property

Default Value

Description

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_lanaguages

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.

Application class: PTEM_CONFIG:PTSFCleanupDeploymentData

PTSFCleanupDeploymentData deletes deployment configuration data related to Search Framework from database.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTSFConfigureSrchInstance

The PTSFConfigureSrchInstance plug-in configures Elasticsearch search instance, nodes, and deploys/undeploys search definitions.

Property

Default Value

Description

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.

Application Class:PTEM_CONFIG:PTWebProfileConfig

The PTWebProfileConfig plug-in sets the supported values of the web profile. The property tables are categorized by the page they appear on in the Web Profile component. For more details on each web profile setting, see Configuring Web Profiles.

Note: Not every web profile setting that you see on the web profile configuration pages in PIA is accessible in the configuration plug-in.

General Tab Properties

Property

Default Value

Description

env.webprofilename

PROD

Sets the web profile name to be modified.

env.descr

Sets the Description Property

env.authtokendomain

example.com

Sets the Authentication Domain property.

env.helpurl

http://www.example.com

Sets the Help URL property.

env.compressresponse

N

Sets the Compress Responses property.

env.compresscachefiles

N

Sets the Compress Response References property.

env.compressmimetypes

application/x-javascript

Sets the Compress MIME Types property.

env.compressquery=N

N

Sets the Compress Query property.

env.saveconfirmdisplay

3111

Sets the Save Confirmation Display Time property. (Milliseconds)

env.enableprocesswait

N

Sets the Enable Processing Message property.

env.enablenewwindow

N

Sets the Enable New Window property.

env.enableppmagent

N

Sets the Enable PPM Agent property (enable PeopleSoft Performance Monitor agent).

env.ppmmonitorbuffsize

51211

Sets the PPM Monitor Buffer Size property (PeopleSoft Performance Monitor buffer size).

env.threaddelay

1111

Sets the Single Thread Delay property.

env.physicalpath

Sets the Non-standard Base Path property.

env.reportrepositorypt

Sets the Report Repository Path property.

env.enablereportrepos

Y

Sets the Enable Report Repository property.

env.compressreports

A

Sets the Compress Report Output property.

env.enableprint

Y

Sets the Enable Print property.

Security Tab

Property

Default Value

Description

env.useridcookieage

7

Sets the Days to Autofill User ID property.

env.viewfilettl

0

Sets the View File Time to Live property.

env.portalusehttp

N

Sets the PIA use HTTP Same Server (PeopleSoft Pure Internet Architecture use HTTP same server) property.

env.allowunregcontent

Y

Sets the Allow Unregistered Content property.

env.sslrequired

N

Sets the Secured Access Only property.

env.usesecurecookiessl

Y

Sets the Secure Cookie with SSL property.

env.warningtimeout

1011

Sets the Inactivity Warning property.

env.sessiontimeout

1211

Inactivity Logout property.

env.authuserhttpintrvl

0

Sets the HTTP Session Inactivity property.

env.timeoutwarnscript

WEBLIB_TIMEOUT.PT_TIMEOUTWARNING.FieldFormula.IScript_TIMEOUTWARNING

Timeout Warning Script property.

env.bypasssignon

N

Sets the Allow Public Access property.

env.defaultuserid

Sets the User ID property for public access.

env.defaultpwd

Sets the Password property for public access.

env.publicsesstimeout

0

Sets the HTTP Session Inactivity property for public access.

env.tuxnetdistimeout

0

Sets the Disconnect Timeout property.

env.tuxedosendtimeout

51

Sets the Send Timeout property.

env.tuxedorcvtimeout

1311

Sets the Receive Timeout property.

env.defaultxmllinkuse=

Sets the User ID property.

env.defaultxmllinkpwd

Sets the Password property.

env.xmllnkhttpsamserv

N

Sets the XML Link Use HTTP Same Server property.

Virtual Addressing Tab

Property

Default Value

Description

env.relativeurl

Y

Sets the Generate Relative URLs property.

env.defaultscheme

Sets the Protocol property.

env.pswebservername

Sets the Name property.

env.defaultport

0

Sets the Port property.

env.scheme

Sets the Protocol (RPS) property.

env.hostname

Sets the Host (RPS) property.

env.httpport

Sets the HTTP (RPS) property.

env.httpsport

Sets the HTTPS (RPS) property.

Cookie Rules Tab

Property

Default Value

Description

env.cookiepattern

*abcd*

Sets the Cookie Pattern property.

env.forwarddomain

test

Sets the Cookies Passed to Server property.

env.blockdomain

test

Sets the Cookies Not Passed to Server property.

env.deleteonlogout

Y

Sets the Delete Cookie on Logout property.

env.proxied

Y

Sets the Proxied property.

env.secure

N

Sets the Secure property.

Authorized Site Tab

Property

Default Value

Description

env.pttokendomaincomp

Y

This parameter enables or disables the ps-token check across domains in a cluster setup.

Caching Tab

Property

Default Value

Description

env.enablebrowsercache

Y

Sets the Cache Generated HTML property.

env.maxsavedstate

6

Sets the Number of States Supported property.

env.statusblocktimeout

0

Sets the State Discard Interval property.

env.portalcachehpbrow

N

Sets the Cache Homepage property.

env.portalhpstaleint

1211

Sets the Homepage Stale Interval property.

env.useragentid

Sets the User Agent ID

env.cachehomepage

Sets the Cache Homepage property.

env.portalusecacheprox

N

Sets the Cache Proxied JavaScripts property.

env.portalcacheobjects

N

Sets the Cache Portal Objects property.

env.portalcachestale

86399

Sets the Cache Stale Interval property.

env.cachetargetcontent

N

Sets the Cache Target Content property.

env.cachemenuonwebsrvr

N

Sets the Cache Menu property.

env.cachepurgeallhitct

1011

Sets the Cache Purge All Hit Count property.

env.imagedirphys

/cache

Sets the Image Directory property.

env.imagedirweb

/cache

Sets the Image Web Directory property.

env.cssdirphys

/cache

Sets the CSS Directory (cascading style sheet directory) property.

env.cssdirweb

/cache

Sets the CSS Web Directory property.

env.enablenoversion

Y

Sets the Copy Image/CSS (No Versioning) property.

env.chartdirphys

/cache/chart

Sets the Chart Directory property.

env.chartdirweb

/cache/chart

Sets the Chart Web Directory property.

env.jsdirphys

/cache

Sets the JavaScript Directory property.

env.jsdirweb

/cache

Sets the JavaScript Web Directory property.

env.pt_cache_search

N

Sets the Enable Caching property.

env.pt_cache_search_ws

N

Sets the Enable Caching on Web Browser property.

Debugging Tab

Property

Default Value

Description

env.ppmtrace

N

Trace Monitoring Server

env.traceppmagent

N

Trace PPM Agent

env.connectinfo

Y

Show Connection Information

env.enabletrace

Y

Show Trace Link at Signon

env.debugshowlayout

Y

Show Layout

env.debugoverlap

Y

Show Overlapping Fields

env.debuginliness

Y

Show StyleSheet Inline HTML

env.debuginlinejs

Y

Show JavaScript Inline HTML

env.testing

N

Generate HTML for testing.

env.enabledebugdumpfl

N

Write dump file.

env.debugsavefile

Y

Create file from PIA HTML page.

Look and Feel Tab

Property

Default Value

Description

env.startpage

WEBLIB_PTBR.ISCRIPT1.FieldFormula.IScript_StartPage

Sets the Page (Start) property.

env.startpagescript

Sets the Override property.

env.expirepage

start.html,start.wml

Sets the Page (Expire) property.

env.expirepagecontname

PT_EXPIRE,PT_EXPIRE_WML env.exceptionpage=start.html,start.wml

Sets the Content Name property.

env.pageleterrorpage

Sets the Pagelet Error Page property.

env.portaldtlerrpage

Sets the Portal Detail Error Page property.

env.portaltrgterrpage

Sets the Portal Target Error Page property.

env.mcfauthfailurepage

Sets the MCF Auth Failure Page (multichannel framework authorization failure page) property.

env.authtokenablepage

Sets the Auth Token Enable Page (authorization token enable page) property.

env.signontracepage

Sets the Enable Trace Page property.

env.cookierequiredpage

Sets the Cookies Required Page property.

env.sslrequiredpage

Sets the SSL Required Page property.

env.userprofilepage

Sets the User Profile Page property.

env.signonpage

signon.html

Sets the Signon Page property.

env.signonresultdocpag

start.html

Sets the Signon Result Doc Page (signon result document page) property.

env.signonerrorpage

signin.html

Sets the Signon Error Page property.

env.logoutpage

signin.html

Sets the Logout Page property.

env.passwordexpiredpag

start.html

Sets the Password Expired Page property.

env.passwordwarnpage

start.html

Sets the Password Warning Page property.

env.chgpwdonexpire

MAINTAIN_SECURITY.EXPIRE_CHANGE_PSWD.GBL

Sets the Change Password on Expire property.

env.chgpwdonwarn

MAINTAIN_SECURITY.CHANGE_PASSWORD.GBL

Sets the Change Password On Warning property.

env.languagesupport

zh_HK=ZHT1

Sets the Language Support property.

Custom Properties Tab

Property

Default Value

Description

env.updateonlycustomproperty

N

This flag if set to true will update the custom properties (based on values of parameters below) and will exit without performing any other configuration. Used in the scenario where you only want to update a custom property.

env.propertyname

Custom property name. For example:

EnablePCModal

PPMConsole

checkForDuplicateCookies

env.validationtype

1

Validation type:

1= Boolean

2 = Number

3 = String

env.longvalue

false

Custom property value.

Application class - PTEM_CONFIG:PTWorkflowEmailConfiguration

Used to configure e-mail details for the logged-in user. On PIA, you can navigate to the Edit Email Addresses link using PeopleTools > Security > User Profiles > User Profiles, click the General tab, and then click the Edit Email Addresses. For more information on setting e-mail addresses, see Setting General User Profile Attributes.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTWorkflowProfileUpdate

Used to configure the routing preferences for the logged-in user. On PIA, you can navigate to the Workflow tab using PeopleTools > Security > User Profiles > User Profiles, and then click the Workflow tab. For more information on setting routing preferences, see Specifying Workflow Settings.

Property

Default Value

Description

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.

Application class - PTEM_CONFIG:PTWorkflowSystemConfiguration

Used to configure system wide route settings. On the PIA, you can navigate to the Worklist System Defaults page by using PeopleTools > Workflow > Defaults & Messages > Set Workflow Defaults. For more information on Worklist System Defaults, see Setting Workflow Defaults.

Property

Default Value

Description

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.