Installation and Upgrade > Windchill ESI > Installing and Configuring Windchill ESI in an SAP Environment > Windchill ESI Preferences, Distribution Target Attributes and Global Variable Groups > Global Variable Groups
Global Variable Groups
Windchill ESI TIBCO global variables are grouped together in the following main categories:
• Process Engine global variables
• Adapter Instance global variables
* 
If you modify any global variables you must redeploy the application for any changes to take effect. The description for any global variable can be viewed as a tool-tip from the TIBCO Administrator GUI, by placing the mouse pointer over the respective global variable.
Process Engine Global Variable Groups
The following global variable groups contain variables that are used in the business logic.
Global Variable Group
Description
ESIClassName
This group contains the global variables that represent the class names of various objects like parts, BOMs, CNs, and process plans. If class names are changed in Windchill then these values also need to be changed accordingly.
These variables are used to compare and identify a type of object. Based on the identified type, a message is written to the Process Archive log.
ESIConstants
This group contains global variables for constant values; For example actions like Create, Change, Unchange, Delete and for boolean values like true, false.
ESIFlags
This group contains global variables that define actions based on the boolean value they are set to.
ESIJMS
This group contains global variables for JMS connection and related activities.
ESILog
This group contains global variables used to configure and identify the information that needs to written to the Process Archive log.
ESIMessaging
This group contains global variables used to configure and identify the information that needs to be sent to Windchill.
ESIMail
This group contains global variables used for configuring e-mail parameters.
ESIPaddingTruncate
This group contains global variables used to configure lengths for padding and truncation. Padding is automatic when certain object numbers are numeric. Truncation is based on the values set for the global variables in the ESIFlags group. For example; truncateNameDescription_Enable (SAP only).
ESIOthers
This group contains various other independent global variables used in the business logic.
ESIClassNames
The following table describes the global variables that make up this Process Engine Global Variable Group.
* 
These global variables should not be modified until they have been first modified in Windchill.
Global variable name
Description
Default Values
BOMClass
Class name for the BOM object
com.ptc.windchill.esi.BOMHeader
DocumentClass
Class name for the Document object
com.ptc.windchill.esi.Document
DocumentLinkClass
Class name for the DocumentLink object
com.ptc.windchill.esi.DocumentLink
ECNClass
Class name for the ECN object
com.ptc.windchill.esi.ChangeHeader
OperationClass
Class name for the Operation object
SAP only.
com.ptc.windchill.esi.mpml.Operation
PartClass
Class name for the Part object
com.ptc.windchill.esi.Part
ProcessMaterialClass
Class name for the ProcessMaterial object
SAP only.
com.ptc.windchill.esi.mpml.ProcessMaterial
ReleaseResultClass
Class name for the Result method specified by the global variable ESIOthers/WCPostResultMethod.
com.ptc.windchill.esi.ReleaseResult
ProcessPlanClass
Class name for the Process Plan object.
com.ptc.windchill.esi.mpml.ProcessPlan
ResourceClass
Class name for the Resource object
SAP only.
com.ptc.windchill.esi.mpml.Resource
SequenceClass
Class name for the Sequence object.
SAP only.
com.ptc.windchill.esi.mpml.Sequence
ToolingClass
Class name for the Tooling object
SAP only.
com.ptc.windchill.esi.mpml.Tooling
ESIConstants
The following table describes the global variables that make up this Process Engine Global Variable Group.
* 
These global variables should not be modified. These values are used extensively in the EAI business logic.
Global variable name
Description
Default Values
CHANGE
Action Flag for modified objects
Change
CREATE
Action Flag for new objects
Create
DELETE
Action Flag for deleted objects
Delete
UNCHANGE
Action flag for unchanged objects
Unchange
TRUE
Represents the boolean value True
true
FALSE
Represents the boolean value False
false
ESIJMS
The following table describes the global variables that make up this Process Engine Global Variable Group.
Global variable name
Description
Possible Values and Windchill ESI Defaults
JNDIContextURL
The JMS JNDI context URL.
tibemsnaming://<EMS Server
Name>:<EMS Server Port>
Default:tibemsnaming://localhost:7222
Username
The user used to logon to JMS through the EAI
Default : ESISYS
Password
The password for the user used to logon to JMS through the EAI.
Default : ESISYS
RetryCount
The number of times to attempt sending a result message to JMS before suspending the job.
Any integer.
Default: 3
RetryPeriod
The time in seconds to delay between consecutive attempts to send a result message to JMS
Any integer.
Default: 300
MaxSessions
The maximum number of JMS sessions to be created for incoming messages.
1
The following JMS queue names may be changed to a valid JMS queue name, with the following restrictions:
• New queues would need to be created on the EMS Server.
• The new queues must follow JMS queue configuration and security guidelines.
* 
Windchill JMS configurations may also need to be modified to support the new queue.
Global variable name
Description
Possible Values and Windchill ESI Defaults
DataResponseQueue
The DataResponse queue name for the JMS interface with Windchill. This value must match the DataResponse queue name specified on the TIBCO EMS server and byWindchill ESI Services.
In SAP
• Default:com.ptc.windchill.esi. DataResponse.<<system ID>>.<<client>>
Where <<system ID>> is the system name for the SAP distribution target. and <<client>> is the client for the SAP system. For example, 800.
<<system>> and <<client>> must match the values specified for the attributes System ID and Client respectively of the distribution target in Windchill.
In Oracle Applications:
• Default: com.ptc.windchill.esi.DataResponse.<DSN>
Where
<DSN> is the ODBC datasource name for Oracle Apps underlying database connection.
This is the same value that is provided for ESIOMAdapter/Datasource global variable.
ResultQueue
The Result queue name for the JMS interface with Windchill PDMLink. This value must match the Result queue name specified on the TIBCO EMS server and byWindchill ESI services.
Default:com.ptc.windchill.esi.Result
ESILog
The following table describes the global variables that make up this Process Engine Global Variable Group.
Global variable name
Description
Possible Values and Windchill ESI Defaults
ERPPrimary
The flag to enable logging of ERP Primary messages.
Integer value 1 = on; 0 = off; Default: 1
ERPSecondary
The flag to enable logging of ERP Secondary messages.
Integer value: 1 = on; 0 = off; Default: 1
Functional_Debug
The flag to enable logging of Type functional (1) and Severity debug (9) messages
Integer value: 1 = on; 0 = off; Default: 0
Functional_Error
The flag to enable logging of Type functional (1) and Severity error (1) messages
Integer value: 1 = on; 0 = off; Default: 1
Functional_Informational
The flag to enable logging of Type functional (1) and Severity informational (4) messages.
Integer value: 1 = on; 0 = off; Default: 0
Functional_Success
The flag to enable logging of Type functional (1) and Severity success (3) messages.
Integer value: 1 = on; 0 = off; Default: 1
Functional_Warning
The flag to enable logging of Type functional (1) and Severity warning (2) messages.
Integer value: 1 = on; 0 = off; Default: 1
RootCause
The flag to enable logging of root cause messages.
Integer value: 1 = on; 0 = off; Default: 1
Technical_Debug
The flag to enable logging of Type technical (2) and Severity debug (9) messages.
Integer value: 1 = on; 0 = off; Default: 0
Technical_Error
The flag to enable logging of Type technical (2) and Severity error (1) messages
Integer value: 1 = on; 0 = off; Default: 1
Technical_Informational
The flag to enable logging of Type technical (2) and Severity informational (4) messages.
Integer value: 1 = on; 0 = off; Default: 0
Technical_Success
The flag to enable logging of Type technical (2) and Severity success (3) messages.
Integer value: 1 = on; 0 = off; Default: 1
Technical_Warning
The flag to enable logging of Type technical (2) and Severity warning (2) messages.
Integer value: 1 = on; 0 = off; Default: 1
Delimiter
The delimiter used when logging messages
Any character. Default: , (comma)
Locale
Locale used to lookup logging message text.
Default: en_US
Following are valid locale values:Language / Country / Locale Encoding Value English / United States / en_US
English / United Kingdom / en_GB
French / France/ fr
German / Germany / de
Italian / Italy/ it
Spanish / Spain/ es
Japanese / Japan/ ja
Chinese Simplified / China (PRC) / zh_CN
Chinese Traditional / Taiwan / zh_TW
Korean / Korea / ko
Brazilian Portuguese / Brazil / pt_BR
* 
To log Asian character sets (for locales ja, zh_CN, zh_TW, ko) you must change your system encoding to the desired language: Japanese, Korean, Chinese. Or use the operating system for that language.
On Windows:
To set your system encoding to, for example, Japanese, on an English operating system:
1. Click Start>Settings>Control Panel.
2. Click Regional Options.
3. Change the locale encoding to Japanese.
4. Make sure that Japanese is checked in the language settings for the system. If you do not have the languages installed on your operating systems, refer to the Microsoft support site for help.
To view the log files on an English operating system:
1. Open the file in any text editor such as Notepad, that can display international characters.
2. Select the font as MS PMincho.
To view the log files in Internet Explorer:
If you do not have a text editor that can display international characters, view it in Internet Explorer by doing the following:
1. Rename the file with a .txt extension
2. Set the encoding value to Shift-JIS by selecting View > Encoding > More >Japanese (Shift_JIS)
To view the log files in the TIBCO Administrator GUI:
1. Select the tracing tab of the components of both the process engine and the adapters.
2. View the log file. If the characters appear incorrect, perform the next step.
3. Stop and restart all of your TIBCO services.
4. View the log file again.
ESIMail
The following table describes the global variables that make up this Process Engine Global Variable Group.
Global variable name
Description
Possible Values and Windchill ESI Defaults
BCCAddress
An optional field set to copy someone (using the BCC e-mail feature) on the alert e-mail message sent to the administrator when there is an error in the Result or the ResultResponse messages.
Any single valid e-mail address, or a series of valid e-mail addresses separated by commas.
CCAddress
An optional field set to copy someone (using the CC e-mail feature) on the alert e-mail message sent to the administrator when there is an error in the Result or the ResultResponse messages.
Any single valid e-mail address, or a series of valid e-mail addresses separated by commas.
FromAddress
A required field that should be set to the designated e-mail address of the sender of e-mail alert messages when there is an error in the Result or ResultResponse messages. This e-mail address appears in the From field.
* 
Failure to set a proper value for this variable can result in incomplete error handling. The process will suspend without a proper message. In order to remedy the error, the engine will need to be restarted after the variables have been set.
Any single valid e-mail address.
* 
Only one e-mail address is allowed.
SMTPHostServer
The value of the SMTP host server. Contact your IT department to get this value.
* 
Failure to set a proper value for this variable can result in incomplete error handling. The process will suspend without a proper message. In order to remedy the error, the engine will need to be restarted after the variables have been set.
Typically, a string that describes the server name, such as: mail.mycompany.com
ToAddress
A field that should be set to the e-mail address of theWindchill ESI administrator. The administrator gets an e-mail with the alerts if there is an error in the Result or ResultResponse message. The administrator could then examine the errors, make the appropriate fixes, and resume the process.
* 
Failure to set a proper value for this variable can result in incomplete error handling. The process will suspend without a proper message. In order to remedy the error, the engine will need to be restarted after the variables have been set.
Any single valid e-mail address, or a series of valid e-mail addresses separated by commas.
Note:You can also use the optional CCAddress and BCCAddress variables.
ESIPaddingTruncate
The following table describes global variables that are used either for padding or truncating the numbers of objects (such as documents, CNs, parts and resources) in order to make their lengths equal to those defined by default in SAP version ECC6.0
* 
The default value of each global variable is also the length of the relevant attribute, as defined in SAP. Also, padding will occur provided the value of the attribute is all numeric. Truncation will occur if the global variable ESIFlags/TruncateNameDescription_Enable is set to true
Global variable name
Description
Possible Values and Windchill ESI Defaults
PaddingNumber_DocumentLength
Used for padding the number attribute on a document, so as to make its length equal to that defined in SAP.
25
PaddingNumber_ECNLength
Used for padding the number attribute on a CN, so as to make its length equal to that defined in SAP.
12
PaddingNumber_PartLength
Used for padding the number attribute on a part, so as to make its length equal to that defined in SAP for a Material.
18
PaddingNumber_ResourceLength
Used for padding the number attribute on a resource, so as to make its length equal to that defined in SAP for a Material.
18
PaddingNumber_SequenceLength
Used for padding the number attribute on a sequence, so as to make its length equal to that defined in SAP for a Material.
6
PaddingNumber_SerialEffectivityLength
Used for padding the serial number in serial effectivity, so as to make its length equal to that defined in SAP.
18
TruncateDescript_ECNLength
Used for truncating the description attribute on a CN, so as to make its length equal to that defined in SAP.
40
TruncateName_ECNLength
Used for truncating the name attribute on a CN, so as to make its length equal to that defined in SAP.
40
TruncateName_DocumentLength
Used for truncating the name attribute on a document, so as to make its length equal to that defined in SAP.
40
ESIOthers
The following table describes the global variables that make up this Process Engine Global Variable Group.
Global variable name
Description
Possible Values and Windchill ESI Defaults
WCResponseDirectory
When the global variable ESIFlags/ WriteResponseToFile flag is set to ‘true’ theWindchill ESI Response data will be written to a file and that file will be stored inside this folder.
The file name format is determined by the value of the global variable ESIOthers/ ResponseFileName, with the transaction number appended to its end.
<tibco_home>/esi/bin/
SAPDateFormat
The date format that the distribution target expects (the date format of the user that is logged onto the distribution target). The format must use valid TIBCO notation.
Default: yyyy-MM-dd
This value must match the date format that is configured in the SAP system for theWindchill ESI user, specified for the global variable ESISAPAdapter/Username.
SAPMPMDateFormat
The SAP ECC date format that the Routing API and the ECN APIs expect for a Routing object.
Default: yyyyMMdd
This value must match the date format that is configured in the SAP system for theWindchill ESI user, specified in the ESISAPAdapter/Username global variable.
APIRetryPeriod
The time (in milliseconds) the TIBCO BusinessWorks engine should wait for a response from an adapter before sending an error message.
Any integer value
Default: 300000
BWInvokeBindExceptionClass
The name of the exception class for adapter bind errors.
Default:BindException
BWInvokeTimeOutClass
The name of the exception class for adapter time-outs.
Default:ActivityTimedOutException
BWKillProcess
Used by the ErrorHandling_Service to intentionally end the process when a fatal error occurs.
* 
Do not change the value of this global variable.
Default: KillProcess
WCPostResultMethod
The method name for post result messages.
Default: PostResult
This value must match the RPC name for PostResult messages inWindchill ESI Services for the class identified by the global variable ReleaseResultClass under the ESIClassNames global variable group.
WSHost
The host name for the ERP part information web service.
This can be a machine name or a WebServer domain name.
Default: localhost
WSPort
The port number for the ERP part information web service.
Any port number ranging from 1024 to the maximum value supported on the machine.
Default :6666
WCDateFormat
The date format expected from Windchill PDMLink.
The format must use valid TIBCO notation.
Default: yyyy-MM-dd HH:mm:ss
This value must match the date format used in messages sent from Windchill PDMLink.
ResponseFileName
Filename for the Response data sent by Windchill for a transaction.
ESIResponseFromWC_.xml
WSRequestResponseFileName
Filename for the Request data sent by Windchill to the ERP Part Information web service.
ESISOAP_.xml
ReplaceZeroQuantityWith
If quantity is set to “0” in Windchill then the value defined for this global variable will be used for quantity
Possible value: Integer > 0
Default value: 9999999999
PartBatchSize
The number of part that should be processed via a single call to SAP BAPI.
Possible value: any integer > 0.
Default value: 100
Global Variables for Adapter Instances
Adapter instance global variables belong to the global variable group named ESISAPAdapter. These can be further categorized by their usage parameters, as described below.
SAP connection parameters: These parameters are needed to connect to the SAP system:
• Username
• Password
• ApplicationServer
• Client
• System number
Adapter JMS transport parameters: These parameters are needed to ensure communication between the Process Engine and the Adapter for some of the BAPI/RFCs.
• JMSProviderURL
• JMSProviderContextFactory
Adapter log file parameters:
• LogFileCount
• LogFileSizeLimit
Adapter client connection parameters:
• MaxConnections
• MaxReconnectionAttempts
• ReconnectionAttemptsNumber
• ReconnectionAttemptsInterval
The following table describes the global variables that make up this Adapter Instance Global Variable Group.
Global variable name
Description
Possible Values and Windchill ESI Defaults
ApplicationServer
The application server connection string of the distribution target.
The valid values for the application server string when making one of the following connections:
• Through a firewall or an SAP router:
/H/<SAP Router>/S/<SAP Router Service>/W/<Password>/H/<Target Application Server>
where:
<SAP Router> is the IP address or name of the SAP router.
<SAP Router Service> is defaulted to 3299.
<Password> indicates the password for the connection between the predecessor and successor on the route and is also optional. The default is "" that is, no password.
<Target Application Server> is the IP address or name of the SAP application server.
* 
A relevant entry should be maintained in the route permission table for the application server. Standard entries in a route permission table appear as follows: P/S/D <source-host> <dest-host> <dest-serv> <password>
where:
<source-host> and <dest-host> could be SAP Routers.
For more information on SAP router string, refer to SAP help at http://help.sap.com.
• On the same network:
Enter the IP address or the application server name of the SAP server:
<Target Application Server>
SystemID
The Windchill PDMLink identifier for the System ID attribute of the distribution target. This value appears in the value of Destination element sent in the response message from Windchill as in <SystemID>.< Client>
* 
This value is case sensitive as is the value that Windchill PDMLink sends.
For SAP systems, this is typically a three-character string. This variable is used in the TIBCO Rendezvous subject name when publishing messages to the TIBCO Adapter for ECC instances. The ESI distribution target System ID value sent in the ESIResponse message by Windchill PDMLink must match the System value set in the corresponding TIBCO Adapter for ECC instances to ensure successful publishing of messages to the adapter instances and ultimately to SAP.
Client
The client number of the distribution target.
Value is the three-digit client number of the distribution target. This variable is used in the TIBCO Rendezvous subject name when publishing messages to the TIBCO Adapter for ECC instances. The ESI distribution target client value sent in the ESIResponse message by Windchill PDMLink must match the Client value set in the corresponding TIBCO Adapter for ECC instances to ensure successful publishing of messages to the adapter instances and ultimately to SAP.
CommitExpiry
Session Timeout in milli seconds for SAP “Commit Required” BAPIs.
360000
SystemNumber
The system number of the distribution target.
This is a two-digit integer value.
Username
The username used to log onto the distribution target.
This value could be any string. Default user name is: ESISYS.
Password
The password used to log onto the distribution target.
Value could be any string.
Locale
The locale of the distribution target. Determines the subject name the adapter is listening on.
* 
The Locale value must match the value specified for the JMS header property com_infoengine_locale that gets sent withWindchill ESI response.
The following are the ISO standard locale values. Default is en_US
Following are valid locale values :Language / Country / Locale Encoding Value
English / United States / en_US
English / United Kingdom / en_GB
French / France/ fr
German / Germany / de
Italian / Italy/ it
Spanish / Spain/ es
Japanese / Japan/ ja
Chinese Simplified / China (PRC) / zh_CN
Chinese Traditional / Taiwan / zh_TW
Korean / Korea / ko
Brazilian Portuguese / Brazil / pt_BR
This variable is used in the TIBCO Rendezvous subject name when publishing messages to the TIBCO Adapter for ECC instances. The com_infoengine_locale JMS header property value sent in the ESIResponse message by Windchill PDMLink must match the Locale value set in the corresponding TIBCO Adapter for ECC instances to ensure successful publishing of messages to the adapter instances and ultimately to SAP.
MaxConnections
The number of SAP connections in the client connection. This option is used to configure the maximum number of threads in the adapter instance.
By default, it is set to 5. A maximum of 99 connections is allowed.
ReconnectionAttemptsNumber
Number of Reconnect Attempts before suspending impacted service(s). In other words, it is the number of times the connection management process tries to connect to the application before the listener for a subscription or a one-way Request-Response Invocation service is suspended.
The default value for this field is 1.
MaxReconnectionAttempts
Maximum number of Reconnect Attempts - the maximum number of times the adapter will retry to establish a connection to the SAP ECC system.
By default, it is set to 1. This has to be greater than or equal to the value specified for the global variable ReconnectionAttemptsNumber. For the adapter to keep retrying forever, set the value to -1.
ReconnectionAttemptsInterval
Interval between Reconnect Attempts (milliseconds) The time interval between two successive retries, in milliseconds.
The default value is 30000 ms.
LogFilesizeLimit
Maximum size of the log file, in bytes.
Default is 3000000. Maximum is 2147483647 bytes.
LogFileCount
The number of Adapter Log files to be generated viz., the number of roll over files.
Default is 3.
JMSProviderURL
JMS Provider URL to connect to the EMS server by Adapter JMS transport.
Default is set to: tcp://<<EMSservername>>:7222
Was this helpful?