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.
|
|
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
|
|
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
|
Global variable name
|
Description
|
Possible Values and Windchill ESI Defaults
|
ControlAttributesMaster
|
Oracle Object Attribute Master Control Flag
This flag specifies whether
Item attributes in the Oracle Applications distribution target system are controlled at the master level or the organization level.
If the flag is set to true, the Windchill ESI business logic will check if the master organization is included in the Windchill PDMLink data published for each particular Item. If it was not sent, then the Windchill ESI business logic creates the data to be published to the master organization. If the flag is set to false, the Windchill ESIbusiness logic continues normal processing, and expects every distribution target organization to be explicitly assigned in Windchill PDMLink.
If some of the business object attributes are controlled at the master level and some at the organization level, you must set this flag to true.
|
true, false
Default: true
|
ECNEnabled
|
Change Notice Management Flag
This flag determines the processing of CN information published from Windchill PDMLink. The flag has acceptable values of true or false. If the flag is set to true, Windchill PDMLink data responses may contain CN information, and if available, that CN information will be processed by the Windchill ESI business logic.
If the flag is set to falseWindchill PDMLink data responses may contain CN information; however, that CN information will not be processed by the Windchill ESI business logic.
If the Oracle Applications distribution target system does not support ECOs, the flag should be set to false.
|
true, false
Default: true
|
MPM_UsageFlag
|
Defines whether or not the Usage should be picked from the lookups file or from Windchill.
|
true, false
Default: false
|
EnableDebugging
|
The Windchill ESI business logic contains a utility used for development-time debugging called Debugging_Service. This variable, when set to true, and when this utility is used, enables debugging messages. These debug messages only print to the console window in TIBCO Designer when running the TIBCO BusinessWorks process engine in test mode, or to the console when the engine is run via a command window. These debug messages do not print to the TIBCO BusinessWorks process engine log file.
|
true, false
Default: false
|
PadRevisionLetter
|
Defines whether or not to pad the revision.
|
true, false
Default: true
|
WriteResponseToFile
|
A flag that enables writing the Windchill Response data to a file. The file name and location are determined by the global variables WCResponseDirectory and ResponseFileName defined in the group ESIOthers.
|
true, false
Default: true
|
isMultiplePE
|
A flag for enabling a single Process engine instance to dynamically generate the subject name. Refer to the section How to Configure a Single Process Archive for Multiple Instances in the Windchill Enterprise Systems Integration Customizer’s Guide – Oracle Applications for details.
|
true, false
Default: true
|
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
|
|
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
|
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
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.
|
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.
|
Any single valid e-mail address.
|
||||
SMTPHostServer
|
The value of the SMTP host server. Contact your IT department to get this value.
|
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.
|
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.
|
Global variable name
|
Description
|
Possible Values and Windchill ESI Defaults
|
EAISecondary
|
The flag to enable sending functional decision and warning messages back to Windchill PDMLink
|
Integer value: 1 = on; 0 = off; Default: 1
|
ERPPrimary
|
The flag to enable sending ERP Primary information back to Windchill PDMLink
|
Integer value: 1 = on; 0 = off; Default: 1
|
ERPSecondary
|
The flag to enable sending ERP Secondary information back to Windchill PDMLink
|
Integer value: 1 = on; 0 = off; Default: 1
|
RootCause
|
The flag to enable sending Root Cause messages back to Windchill PDMLink
|
Integer value: 1 = on; 0 = off; Default: 1
|
Delimiter
|
The delimiter used when returning information in the PostResultRPC message field to Windchill PDMLink
|
Default: ||
Note: EAI software components do not parse the message string to determine if the delimiter does not exist in the string. The value of this delimiter should be set to one or more characters that do not appear in the text of this field. Characters to avoid include – but are not restricted to - "," "." ";" ":" "^"
|
Processor
|
The message processor class passed in EMS message header.
|
Default: SoapMessage
|
Global variable name
|
Description
|
Possible Values and Windchill ESI Defaults
|
||
WCResponseDirectory
|
When the global variable ESIFlags/WriteResponseToFile is set to true the Windchill ESI data is generated in a file which is 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
|
||
BWInvokeBindExceptionClass
|
The name of the exception class for adapter bind errors.
|
Default:BindException
|
||
BWInvokeTimeOutClass
|
The name of the exception class for the adapter time-outs.
|
Default:ActivityTimedOutException
|
||
BWKillProcess
|
Used by the ErrorHandling_Service to intentionally end the process when a fatal error occurs.
|
Default: KillProcess
|
||
WCPostResultMethod
|
The method name for post result messages.
|
Default: PostResult
This value must match the RPC name for PostResult messages in Windchill ESI Services for the class identified by the global variable ESIClassNames/ReleaseResultClass.
|
||
WSHost
|
The host name for the ERP part information web service.
|
This can be a MachineName, or a WebServerDomain 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.
|
||
ORADateFormat
|
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 HH:mm:ss
This value must match the date format that is configured in the Oracle Apps system.
|
||
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 and for the Response data sent by Web service to Windchill.
|
ESISOAP_.xml
|
||
PadCharacter
|
Padding character for revision.
|
|||
ORAOffsetTime
|
The time value in hour:minute:second format that is used as an offset while creating date effectivity in Oracle Applications using the system date. The offsetting is done only when Windchill does not send the effectivity information.
|
00:05:00-05:00
|
||
RetryCount
|
The number of times business works logic should send requests to the adapter. This values is used when querying the TIBCO log table and the query does not return sufficient data.
|
Any integer.
Default: 20
|
||
RetryPeriod
|
The time in milliseconds for which the TIBCO business works logic should wait between consecutive request attempts from the adapter.
|
Any integer in milliseconds.
Default: 60000
|
||
TimeOutPeriod
|
The time in milliseconds for which the TIBCO BusinessWorks activity (mainly publish to adapter activity and wait for log message activity) should wait for a reply from the adapter.
|
60000
|
||
WCPostResult_PartialSuccessMethod
|
The method name for the post result message sent to indicate partial success of part publication in cases where part revision could not be created in ECN centric mode.
|
PartiallySuccededPostResult
|