![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
addReverseMappingTableObjectRow Relation TableProperty ObjectTag | |
This will create the internal mapping buffer for a table row that should be used to update the row attributes and is also defines the order of the table rows and links it to already existing rows. More... | |
createReverseMappingTableObject Relation TableProperty TableType | |
This will create the internal mapping buffer for a table row that should be used to update the row attributes and is also defines the order of the table rows and links it to already existing rows. More... | |
decodeTcDataString EncodedString | |
This function decodes a given TcData array string attribute into a TclString value in the internal Tcl Unicode format. More... | |
FieldMapping FormName FieldName ?UseBinaryFormat? ?TrimValue? args | |
Returns the value of specified attribute in the specified format. More... | |
findIndexedObjectId4Value Index FormName FieldName Value ?CaseSensitive? args | |
Returns a list of attached objects for a given attribute value and BOM line index from the internal Teamcenter data buffer. More... | |
findIndexedObjectList4Attribute Index FormName FieldName args | |
Returns a list of attached objects for a given BOM line index from the internal Teamcenter data buffer. More... | |
findObjectId4Value FormName FieldName Value ?CaseSensitive? args | |
Returns first attached object for a given attribute value from the internal Teamcenter data buffer. More... | |
findObjectList FormName FieldName ?CaseSensitive? args | |
Returns a list of attached objects for the given object from the internal Teamcenter data buffer. More... | |
findObjectList4Value FormName FieldName Value ?CaseSensitive? args | |
Returns a list of attached objects for a given attribute value from the internal Teamcenter data buffer. More... | |
findRootTaskObjectList FormName FieldName args | |
Returns the ids of specified attached root task object attribute. More... | |
findRootTaskObjectList2 FormName FieldName | |
Returns the ids of specified attached root task object attribute. More... | |
getFormNames4Object Tag | |
Returns a list of relation names for the given object from the internal Teamcenter data buffer. More... | |
getLogChannelBasedOnTransactionId LogChannelId | |
Validated if the provided log-channel is a supported by the defined log-channel structure. If not the default log-channel is returned. More... | |
getObjectAttributeValue Tag RelationName FieldName ?UseBinaryFormat? args | |
Returns the value of specified attribute for the given ItemInfo in the specified format. More... | |
getObjectsValueList FormName FieldName ?UseBinaryFormat? ?TrimValue? | |
Returns a value list of all objects that have the same relation name string with the same attribute. More... | |
getPreferenceValue PreferenceScope PreferenceType PreferenceName | |
This function will return the value of a specified preference name. More... | |
getQueryArgumentValue ArgumentName args | |
Returns the query argument value defined by the user. More... | |
getRootTaskFieldMappingValueList FormName FieldName ?UseBinaryFormat? args | |
Returns the values of specified attached root task object attribute. More... | |
getTeamcenterEncodingName args | |
returns the detected Tcl encoding name based on the input of the variables ::TcData(SystemEncodingAliasList), ::TcData(TC_CHARACTER_ENCODING_SET) or the defined ::T4X::TC::MAPPING::CtrlInfo(useTcCodePage) value More... | |
getWorkflowArgumentValue2 ArgumentName ?CaseSensitive? | |
Returns the work-flow argument value. More... | |
getWorkflowArgumentValue3 ArgumentName ?DefaultValue? ?CaseSensitive? | |
Returns the workflow argument value including the possibility to define a default value if the argument is not found. More... | |
IndexedFieldMapping Index FormName FieldName ?UseBinaryFormat? ?TrimValue? args | |
Returns the value of specified BOM line attribute in the specified format. More... | |
printIndexTcData ?TransactionId? args | |
Prints the content of the internal tcl buffer received BOM data from the tcserver process. More... | |
printTcBomLineData ?TransactionId? ?Level? ?PositionInfoPrefix? args | |
Prints the content of the internal Tcl buffer received BOM data from the tcserver process. More... | |
printTcData ?TransactionId? args | |
Prints the content of the internal tcl buffer received from the tcserver process. More... | |
printTcRootTaskData ?TransactionId? | |
Prints the content of the internal tcl buffer received from the tcserver process. More... | |
RootTaskFieldMapping FormName FieldName ?UseBinaryFormat? ?TrimValue? args | |
Returns the value of specified attribute for the work-flow root task object in the specified format. More... | |
save_unlockTcObject LockedObject args | |
function to save and unlock a given Teamcenter Workspace object More... | |
searchIndexedObjectList Index FormNamePattern | |
Returns a list of objects matching the given pattern from the internal Teamcenter data buffer. More... | |
searchObjectList FormNamePattern | |
Returns a list of objects matching the given pattern from the internal Teamcenter data buffer. More... | |
searchRootTaskObjectList FormNamePattern | |
Returns a list of objects matching the given pattern from the internal Teamcenter data buffer of the additional objects specified by the -addObject4Mapping handler argument. More... | |
storeReverseMapping2TcObject2 ObjectTag4Update | |
Function updates the Teamcenter database based on the stored information of the reverse mapping. More... | |
storeReverseMapping2TcObject3 ObjectTag4Update TransactionId EaNameSpace EAObjectTypeName | |
Function updates the Teamcenter database based on the stored information of the reverse mapping and the defined preference definition for the reverse mapping (is using the same functionality like the work-flow based transfer). More... | |
storeReverseMappingAttribute ObjectType Relation Attribute AttributeValue args | |
Store the reverse mapping information into the internal status info buffer array for later Teamcenter database update. More... | |
storeReverseMappingAttribute2 Relation Attribute AttributeValue | |
Store the reverse mapping information into the internal status info buffer array for later Teamcenter database update. More... | |
storeReverseMappingObjectAttribute ObjectTag ObjectType Attribute AttributeValue | |
Store the reverse mapping information into the internal status info buffer array for later Teamcenter database update. More... | |
storeReverseMappingTableRowObjectAttribute Relation TableProperty RowIndex Attribute AttributeValue | |
This will store the row attribute value to the internal buffer. More... | |
testFieldExists FormName FieldName args | |
Tests the existence of specified attribute for the object. More... | |
testIndexedFieldExists Index FormName FieldName args | |
Tests the existence of specified attribute for the object. More... | |
testRootTaskFieldExists FormName FieldName args | |
Tests the existence of specified attribute for the work-flow root task object. More... | |
translateTcEncoding2TclEncodingName TcEncodingName | |
Translate the provided Tc character encoding code page name to the corresponding Tcl character encoding name. More... | |
translateValue2Boolean Value | |
Translate the provided Tc character string to the corresponding Tcl boolean value true or false. The input can be yes,no, true, false, t, f or 1, 0. More... | |
Variables | |
CtrlInfo | |
Namespace array buffer to define defaults used in the context of the mapping functions. CtrlInfo(useTcCodePage) Overwrites the Teamcenter system encoding detected by the T4x environment (default: FALSE) More... | |
T4X::TC::MAPPING::addReverseMappingTableObjectRow | Relation TableProperty ObjectTag | ||
This will create the internal mapping buffer for a table row that should be used to update the row attributes and is also defines the order of the table rows and links it to already existing rows.
Relation | relation string to the attribute e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
TableProperty | attribute name in the data-model |
ObjectTag | this could be an already existing TableRow object tag or NULLTAG for a new Row |
Sample code sequence for storing the table row properties (update an existing one and add a new one)
T4X::TC::MAPPING::createReverseMappingTableObject | Relation TableProperty TableType | ||
This will create the internal mapping buffer for a table row that should be used to update the row attributes and is also defines the order of the table rows and links it to already existing rows.
Relation | relation string to the table property e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
TableProperty | property name in the data-model |
TableType | table row type name in the data-model |
Sample code sequence for storing the table row properties
Sample code sequence for deleting the complete table property content
T4X::TC::MAPPING::decodeTcDataString | EncodedString | ||
This function decodes a given TcData array string attribute into a TclString value in the internal Tcl Unicode format.
The decode uses the detected Teamcenter EncodingName.
EncodedString | Teamcenter encoded string value stored in ::TcData array (like ::TcData(PersonName)) |
Sample code sequence
T4X::TC::MAPPING::FieldMapping | FormName FieldName ?UseBinaryFormat? ?TrimValue? args | ||
Returns the value of specified attribute in the specified format.
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
FieldName | object attribute name |
UseBinaryFormat | flag defines if the value is returned in hex format or not default FALSE. |
TrimValue | flag defines if the attribute value string is trimmed. default TRUE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::findIndexedObjectId4Value | Index FormName FieldName Value ?CaseSensitive? args | ||
Returns a list of attached objects for a given attribute value and BOM line index from the internal Teamcenter data buffer.
Index | |
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
Value | object attribute value to look for |
CaseSensitive | flag defines if the attribute value is checked case sensitive, default TRUE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::findIndexedObjectList4Attribute | Index FormName FieldName args | ||
Returns a list of attached objects for a given BOM line index from the internal Teamcenter data buffer.
Index | |
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::findObjectId4Value | FormName FieldName Value ?CaseSensitive? args | ||
Returns first attached object for a given attribute value from the internal Teamcenter data buffer.
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
Value | object attribute value to look for |
CaseSensitive | flag defines if the attribute value is checked case sensitive, default TRUE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::findObjectList | FormName FieldName ?CaseSensitive? args | ||
Returns a list of attached objects for the given object from the internal Teamcenter data buffer.
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
CaseSensitive | flag defines if the attribute value is checked case sensitive, default TRUE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::findObjectList4Value | FormName FieldName Value ?CaseSensitive? args | ||
Returns a list of attached objects for a given attribute value from the internal Teamcenter data buffer.
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
Value | object attribute value to look for |
CaseSensitive | flag defines if the attribute value is checked case sensitive, default TRUE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::findRootTaskObjectList | FormName FieldName args | ||
Returns the ids of specified attached root task object attribute.
FormName | relation name string to the objects e.g. RootTask:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like RootTask:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::findRootTaskObjectList2 | FormName FieldName | ||
Returns the ids of specified attached root task object attribute.
FormName | relation name string to the objects e.g. RootTask:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end and/or the beginning, like RootTask:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:* or *:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:* or *:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
FieldName | object attribute name |
T4X::TC::MAPPING::getFormNames4Object | Tag | ||
Returns a list of relation names for the given object from the internal Teamcenter data buffer.
Tag | This is the object tag used to access the extracted data in the TcData buffer, if the tag is not found in the buffer the function will return an error. |
T4X::TC::MAPPING::getLogChannelBasedOnTransactionId | LogChannelId | ||
Validated if the provided log-channel is a supported by the defined log-channel structure. If not the default log-channel is returned.
LogChannelId | defines the log-channel that should be used to print the TcData buffer. |
T4X::TC::MAPPING::getObjectAttributeValue | Tag RelationName FieldName ?UseBinaryFormat? args | ||
Returns the value of specified attribute for the given ItemInfo in the specified format.
Tag | This is the object tag used to access the extracted data in the TcData buffer, if the tag is not found in the buffer the function will return an error. |
RelationName | Navigation information string to the objects from the source object e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master This parameter is just used for the debug output of this function, it has no impact on the data retrieval. |
FieldName | object attribute name |
UseBinaryFormat | flag defines if the value is returned in hex format or not default FALSE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::getObjectsValueList | FormName FieldName ?UseBinaryFormat? ?TrimValue? | ||
Returns a value list of all objects that have the same relation name string with the same attribute.
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
UseBinaryFormat | flag defines if the value is returned in hex format or not default FALSE. |
TrimValue | flag defines if the attribute value string is trimmed. default TRUE. |
Sample code sequence
T4X::TC::MAPPING::getPreferenceValue | PreferenceScope PreferenceType PreferenceName | ||
This function will return the value of a specified preference name.
PreferenceScope | Supported PreferenceScopes are:
|
PreferenceType | Supported PreferenceTypes are:
|
PreferenceName | object attribute name |
T4X::TC::MAPPING::getQueryArgumentValue | ArgumentName args | ||
Returns the query argument value defined by the user.
ArgumentName | query argument name |
args | additional arguments |
Sample code sequence
T4X::TC::MAPPING::getRootTaskFieldMappingValueList | FormName FieldName ?UseBinaryFormat? args | ||
Returns the values of specified attached root task object attribute.
FormName | relation name string to the objects e.g. RootTask:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:Item Master It is also possible to specify a wild-card at the end, like RootTask:EPM_target_attachment:ItemRevision:items_tag:Item:IMAN_master_form:* |
FieldName | object attribute name |
UseBinaryFormat | flag defines if the value is returned in hex format or not default FALSE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::getTeamcenterEncodingName | args | ||
returns the detected Tcl encoding name based on the input of the variables ::TcData(SystemEncodingAliasList), ::TcData(TC_CHARACTER_ENCODING_SET) or the defined ::T4X::TC::MAPPING::CtrlInfo(useTcCodePage) value
args | not used |
T4X::TC::MAPPING::getWorkflowArgumentValue2 | ArgumentName ?CaseSensitive? | ||
Returns the work-flow argument value.
ArgumentName | work-flow argument name |
CaseSensitive | "" (default) | UPPERCASE | LOWERCASE (default) argument and value are checked and returned case sensitive use UPPERCASE letters for the check and for the returned information use LOWERCASE letters for the check and for the returned information |
Sample code sequence
T4X::TC::MAPPING::getWorkflowArgumentValue3 | ArgumentName ?DefaultValue? ?CaseSensitive? | ||
Returns the workflow argument value including the possibility to define a default value if the argument is not found.
ArgumentName | work-flow argument name |
DefaultValue | if provided, this value will be returned, if the argument with the given name does not exist. |
CaseSensitive | "" (default) | UPPERCASE | LOWERCASE (default) argument and value are checked and returned case sensitive use UPPERCASE letters for the check and for the returned information use LOWERCASE letters for the check and for the returned information |
Sample code sequence
T4X::TC::MAPPING::IndexedFieldMapping | Index FormName FieldName ?UseBinaryFormat? ?TrimValue? args | ||
Returns the value of specified BOM line attribute in the specified format.
Index | |
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
FieldName | object attribute name |
UseBinaryFormat | flag defines if the value is returned in hex format or not default FALSE. |
TrimValue | flag defines if the attribute value string is trimmed. default TRUE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::printIndexTcData | ?TransactionId? args | ||
Prints the content of the internal tcl buffer received BOM data from the tcserver process.
TransactionId | (optional) transaction log-channel (default TEST_MAPPING) |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::printTcBomLineData | ?TransactionId? ?Level? ?PositionInfoPrefix? args | ||
Prints the content of the internal Tcl buffer received BOM data from the tcserver process.
TransactionId | transaction log-channel (default TEST_MAPPING) |
Level | |
PositionInfoPrefix | |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::printTcData | ?TransactionId? args | ||
Prints the content of the internal tcl buffer received from the tcserver process.
TransactionId | (optional) transaction log-channel |
if not given the default value is set to TEST_MAPPING
args | additional arguments, currently unused. |
T4X::TC::MAPPING::printTcRootTaskData | ?TransactionId? | ||
Prints the content of the internal tcl buffer received from the tcserver process.
TransactionId | (optional) transaction log-channel |
if not given the default value is set to TEST_MAPPING
T4X::TC::MAPPING::RootTaskFieldMapping | FormName FieldName ?UseBinaryFormat? ?TrimValue? args | ||
Returns the value of specified attribute for the work-flow root task object in the specified format.
FormName | relation name string to the objects e.g. RootTask:EPM_reference_attachment:TransferStatusInfo |
FieldName | object attribute name |
UseBinaryFormat | flag defines if the value is returned in hex format or not default FALSE. |
TrimValue | flag defines if the attribute value string is trimmed. default TRUE. |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::save_unlockTcObject | LockedObject args | ||
function to save and unlock a given Teamcenter Workspace object
LockedObject | object of the start for the search |
args | additional arguments |
T4X::TC::MAPPING::searchIndexedObjectList | Index FormNamePattern | ||
Returns a list of objects matching the given pattern from the internal Teamcenter data buffer.
FormNamePattern | pattern (ala string match) to match with the relation name string |
T4X::TC::MAPPING::searchObjectList | FormNamePattern | ||
Returns a list of objects matching the given pattern from the internal Teamcenter data buffer.
FormNamePattern | pattern (ala string match) to match with the relation name string |
T4X::TC::MAPPING::searchRootTaskObjectList | FormNamePattern | ||
Returns a list of objects matching the given pattern from the internal Teamcenter data buffer of the additional objects specified by the -addObject4Mapping handler argument.
FormNamePattern | pattern (ala string match) to match with the relation name string |
T4X::TC::MAPPING::storeReverseMapping2TcObject2 | ObjectTag4Update | ||
Function updates the Teamcenter database based on the stored information of the reverse mapping.
This function replaces the old storeReverseMapping2TcObject function. Remark: In the moment no Teamcenter Objects are created.
ObjectTag4Update | Object tag of the Teamcenter object in the Tcl string format. |
T4X::TC::MAPPING::storeReverseMapping2TcObject3 | ObjectTag4Update TransactionId EaNameSpace EAObjectTypeName | ||
Function updates the Teamcenter database based on the stored information of the reverse mapping and the defined preference definition for the reverse mapping (is using the same functionality like the work-flow based transfer).
ObjectTag4Update | Object tag of the Teamcenter object in the Tcl string format. |
TransactionId | Transaction log-file name |
EaNameSpace | |
EAObjectTypeName | ReverseMapping Preference Prefix |
T4X::TC::MAPPING::storeReverseMappingAttribute | ObjectType Relation Attribute AttributeValue args | ||
Store the reverse mapping information into the internal status info buffer array for later Teamcenter database update.
ObjectType | not used any more |
Relation | relation string to the attribute e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
Attribute | attribute name in the data-model |
AttributeValue | new value of the attribute |
args | additional arguments |
T4X::TC::MAPPING::storeReverseMappingAttribute2 | Relation Attribute AttributeValue | ||
Store the reverse mapping information into the internal status info buffer array for later Teamcenter database update.
Relation | relation string to the attribute e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
Attribute | attribute name in the data-model |
AttributeValue | new value of the attribute |
T4X::TC::MAPPING::storeReverseMappingObjectAttribute | ObjectTag ObjectType Attribute AttributeValue | ||
Store the reverse mapping information into the internal status info buffer array for later Teamcenter database update.
ignored
.ObjectTag | Teamcenter object tag string in a corresponding Tcl representation |
ObjectType | Teamcenter object type (internal name defined in the BMIDE) e.g. Item Master |
Attribute | attribute name in the data-model (internal name defined in the BMIDE) |
AttributeValue | new value of the attribute |
Sample code sequence
T4X::TC::MAPPING::storeReverseMappingTableRowObjectAttribute | Relation TableProperty RowIndex Attribute AttributeValue | ||
This will store the row attribute value to the internal buffer.
Relation | relation string to the attribute e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
TableProperty | Name of the table property in the specified Tc object |
RowIndex | used to define the Attribute row index for the value |
Attribute | attribute name in the data-model |
AttributeValue | new value of the attribute |
Sample code sequence for appending a new row to an existing table property content
T4X::TC::MAPPING::testFieldExists | FormName FieldName args | ||
Tests the existence of specified attribute for the object.
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
FieldName | object attribute name |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::testIndexedFieldExists | Index FormName FieldName args | ||
Tests the existence of specified attribute for the object.
Index | |
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
FieldName | object attribute name |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::testRootTaskFieldExists | FormName FieldName args | ||
Tests the existence of specified attribute for the work-flow root task object.
FormName | relation name string to the objects e.g. ItemRevision:items_tag:Item:IMAN_master_form:Item Master |
FieldName | object attribute name |
args | additional arguments, currently unused. |
T4X::TC::MAPPING::translateTcEncoding2TclEncodingName | TcEncodingName | ||
Translate the provided Tc character encoding code page name to the corresponding Tcl character encoding name.
TcEncodingName | Name of the used code page in the Teamcenter server (e.g. ISO8859_1) |
T4X::TC::MAPPING::translateValue2Boolean | Value | ||
Translate the provided Tc character string to the corresponding Tcl boolean value true or false. The input can be yes,no, true, false, t, f or 1, 0.
Value | String that should be translated to boolean. |
|
static |
Namespace array buffer to define defaults used in the context of the mapping functions.
CtrlInfo(useTcCodePage) Overwrites the Teamcenter system encoding detected by the T4x environment (default: FALSE)