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.

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

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

RevisionsEnabled

Defines whether or not a revision should be created in SAP for the following object types - Part, Process Material or Tooling of type Tool.

true, false

Default: true

EnableSortStringIdentification

Specifies that a valid Sort String attribute defined in SAP be used as a unique identifier for items on a Bill of Materials.

true, false

Default: false

EnableDocument

ECNLock

A flag that enables a document version to be modified in a CN-centric environment without requiring a revision change. If set to true, Change Master information is written to the document object in the SAP distribution target when documents are created or changed. Once a document version is published to SAP, no changes can be made to that document unless the document is revised. If set to false, Change Master information is not written to the document object in the SAP distribution target when documents are created or changed. In this case, changes are limited to document links and distribution targets, and can be made to the same document version without revising the document. Changes to document data other than document links and distribution targets always requires a version change irrespective of how this global variable is set. In an object-centric environment, this global variable does not apply, and document links and distribution targets can be modified without revising the document.

true, false

Default: false

RevisionsEnabled under ESIFlags must be set to true for this global variable to be used.

EnableDocument

LinksToMARA

A flag that enables creation of document links in MARC and MARA tables in SAP distribution targets. If set to true, when an organization specific document link is created, it is created in both MARC and MARA tables in the SAP distribution target – that is, the part document links are able to be viewed looking at the part and the document in the SAP distribution target. If set to false, it only creates a link in MARC table in the SAP distribution target – that is, the part document link is only apparent when looking at the document in SAP (not the part).

true, false

Default: false

EnableChange

ComponentDefaults

A flag that enables overwriting the values in the SAP distribution target for changed components. If set to true, when changing a BOM component that includes an Alternate Item Group, the default values for use strategy, priority, and usage probability overwrite the existing values for those fields in SAP.

true, false

Default: true

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 debug messages. These debug messages only print to the console window in TIBCO Designer when the running the TIBCO BusinessWorks Process Engine in test mode, or to the console when the engine is run from a command window. These debug messages do not print to the TIBCO BusinessWorks process engine log file.

true, false

Default: false

WriteResponseToFile

A flag that enables writing the Windchill Response data to a file. The file name and location are determined by the global variables WCResponseFileName and WCResponseDirectory defined in the group ESIOthers.

true, false

Default: true

PartEffectivityFlag

A flag that checks if effectivity dates for all children in a BOM should be set separately or not.

true, false

Default: false

TruncateNameDescription_Enable

A flag that enables truncating the name and/or description of objects of the following types - Document, CN. The truncation length is defined for the above object types in the global variable group ESIPaddingTruncate.

true, false

Default: true

UseZRFC

A flag for enabling the ZRFC in cases where a not released RFC/API does not work in a production environment. ZRFC must be imported if the value is set to “true”.

This flag is applicable for Create and Update Equipment functionality.

true

usingZRFC_MODIFY_ROUTING

A flag for enabling the ZRFC in cases where a not released RFC/API does not work in a production environment. ZRFC must be imported if the value is set to “true”.

This flag is applicable for Update Routing functionality.

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 – SAP for details.

true, false

Default: true

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

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

In Oracle Applications:

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

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.

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.

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

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

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.

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