T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
T4X::PROP::MAPPING Namespace Reference

Namespaces

 DEMO
 Data View Demo - Add it to your mapping to see what you can do with the data view.
 

Functions

 begin args
 Start creating a piece of text which the T4x data view will render into a widget, e.g. a section. Must be paired with the end command. More...
 
 create args
 Create a piece of text which the T4x data view will render into a widget, e.g. a property. Do not pair it with the end command. More...
 
 createFieldEntry Name Translation Value MultiLine ?Control? ?WriteAccess? ?IsMandatory? ?BackgroundColor? ?BackgroundColorReadOnly? ?ForeColor? ?LabelColor? args
 This function will create the xml payload for one field entry in the data view. More...
 
 createMainEndEntry args
 This function will create the closing tags for the XML payload which will be used to transport the the data of the data view to the TC portal. This function MUST be called once at the end of the data view XML creation. More...
 
 createMainEntry ObjectType Status MessageString args
 This function will create the main (header) entry point of the XML payload which will be used to transport the the data of the data view to the TC portal. This function MUST be called once at the beginning of the data view XML creation. More...
 
 createSectionEndEntry args
 This function will create the closing tags of the xml payload for one expandable section in the data view. It MUST be called after a previous createSectionEntry function call. See createSectionEntry for more details. More...
 
 createSectionEntry Name Translation Expanded ?BackgroundColor? args
 This function will create the entry point of xml payload for one expandable section in the data view. This function can be used on order to group associated fields together in one section of the data view. If so, it must be called BEFORE the createFieldEntry function to create all the fields belonging together in the same section. More...
 
 createTableEndEntry args
 This function will create the closing tags of the 'table' created by createTableEntry. It MUST be called after a previous createTableEntry function call. See createTableEntry for more details. More...
 
 createTableEntry Name Translation lstColumns lstColumnTranslations ?TableHeight? ?BackgroundColor? ?BackgroundColorReadOnly? ?LabelColor? args
 This function will create the a 'table' in the xml payload used for the data view. Doing so, the data view will render a table control for the following fields. See createTableRecordEntry for more details. More...
 
 createTableRecordEntry lstValue ?WriteAccess? ?IsMandatory? ?BackgroundColor? ?BackgroundColorReadOnly? ?ForeColor? args
 This function will create the a 'table record' in the xml payload used for the data view. createTableEntry MUST be called before using this function. See createTableEntry for more details. More...
 
 end args
 

Variables

 BooleanAttributes
 
 EXCEPTIONAL_XSI_TYPES
 
 USE_XSI_TYPES
 

Detailed Description

Function Documentation

◆ begin()

T4X::PROP::MAPPING::begin   args  

Start creating a piece of text which the T4x data view will render into a widget, e.g. a section. Must be paired with the end command.

The piece of text is returned and the caller is responsible for composing it into a document that the data view can interpret.

The begin command is mostly used to build up complex structures with container widgets. It comes in companionship with the end command. The commands between an begin and its corresponding end command create the piece of text used to render the contents of the container widget.

These are the types of container widgets supported trough this command:

section - rectangular area that can be collapsed or expanded and that has a headline. The text displayed in the headline should be specified in the title attribute.

page - rectangular area that looks like a folder with a tab. The text of the tab should be specified in the title attribute. If there are multiple pages within the same container widget only one is fully visible. The others only show their tabs. Pages can be made visible by clicking on their tabs.

column - rectangular area without a title. If there are multiple columns within the same container widget the available space is divided among them according to their weight attribute. If no weights are given the space is divided equally. If weights are given for some but not all columns they are subtracted from 100 and the result is equally divided among those for which no weight was given. For example if you have three columns and specify 40 for the weight of the first the two others will get weights of 30 because 40 + 30 + 30 = 100.

Parameters
argslist of items to be interpreted according to the following rules: An item that starts with a hypen is the name of an attribute after removing the hypen. Items following attribute names are the values of the attributes. A single item not following an attribute name is the type of the widget, e.g. you could write

begin page -title "General Data"

but also

begin -title "General Data" page

◆ create()

T4X::PROP::MAPPING::create   args  

Create a piece of text which the T4x data view will render into a widget, e.g. a property. Do not pair it with the end command.

The piece of text is returned and the caller is responsible for composing it into a document that the data view can interpret.

The create command is mostly used to place simple graphical elements into the data view such as properties.

Parameters
argslist of items to be interpreted according to the following rules: An item that starts with a hypen is the name of an attribute after removing the hypen. Items following attribute names are the values of the attributes. A single item not following an attribute name is the type of the widget, e.g. you could write

create property -name "Item Revision ID" -value "123"

but also

create -name "Item Revision ID" -value "123" property

◆ createFieldEntry()

T4X::PROP::MAPPING::createFieldEntry   Name Translation Value MultiLine ?Control? ?WriteAccess? ?IsMandatory? ?BackgroundColor? ?BackgroundColorReadOnly? ?ForeColor? ?LabelColor? args  

This function will create the xml payload for one field entry in the data view.

Parameters
NameName of the attribute in the external (ERP) system - Not used at the moment
TranslationName of the attribute in the TC data view
ValueValue of the attribute in the TC data view
MultiLineTRUE or FALSE. If true, the attribute will be rendered as a "multi line" control in TC
ControlDefines the GUI control used for the attribute within TC. Can be "Text" or "Checkbox" - (Optional, Default -> Text)
WriteAccess- NOT USED at the moment (Optional, Default -> false)
IsMandatory- NOT USED at the moment (Optional, Default -> false)
BackgroundColorDefines the background color of the control rendered in TC. Format is R-G-B. (Optional, Default -> 255-255-255)
BackgroundColorReadOnlyDefines the background color of read only controls rendered in TC. Format is R-G-B. (Optional, Default -> 230-230-230)
ForeColorDefines the text color of the control rendered in TC. Format is R-G-B. (Optional, Default -> 0-0-0)
LabelColorDefines the text color of the label rendered in front of the actual control in TC. Format is R-G-B. (Optional, Default -> 0-0-0)
Returns
Part of the XML payload for the data view.

◆ createMainEndEntry()

T4X::PROP::MAPPING::createMainEndEntry   args  

This function will create the closing tags for the XML payload which will be used to transport the the data of the data view to the TC portal. This function MUST be called once at the end of the data view XML creation.

Returns
Part of the XML payload for the data view.

◆ createMainEntry()

T4X::PROP::MAPPING::createMainEntry   ObjectType Status MessageString args  

This function will create the main (header) entry point of the XML payload which will be used to transport the the data of the data view to the TC portal. This function MUST be called once at the beginning of the data view XML creation.

Parameters
ObjectTypeTC object type like Item, BillOfMaterial, ChangeOrder...
StatusThe status of the previous getInfo call. Can be OK or ERROR. If != OK, the data view will show an ERROR message in TC.
MessageStringIf Status is ERROR, this will be the corresponding error message. IF the Status is OK, this message can be empty.
Returns
Part of the XML payload for the data view.

◆ createSectionEndEntry()

T4X::PROP::MAPPING::createSectionEndEntry   args  

This function will create the closing tags of the xml payload for one expandable section in the data view. It MUST be called after a previous createSectionEntry function call. See createSectionEntry for more details.

Returns
Part of the XML payload for the data view.

◆ createSectionEntry()

T4X::PROP::MAPPING::createSectionEntry   Name Translation Expanded ?BackgroundColor? args  

This function will create the entry point of xml payload for one expandable section in the data view. This function can be used on order to group associated fields together in one section of the data view. If so, it must be called BEFORE the createFieldEntry function to create all the fields belonging together in the same section.

Returns
Part of the XML payload for the data view.

◆ createTableEndEntry()

T4X::PROP::MAPPING::createTableEndEntry   args  

This function will create the closing tags of the 'table' created by createTableEntry. It MUST be called after a previous createTableEntry function call. See createTableEntry for more details.

Returns
Part of the XML payload for the data view.

◆ createTableEntry()

T4X::PROP::MAPPING::createTableEntry   Name Translation lstColumns lstColumnTranslations ?TableHeight? ?BackgroundColor? ?BackgroundColorReadOnly? ?LabelColor? args  

This function will create the a 'table' in the xml payload used for the data view. Doing so, the data view will render a table control for the following fields. See createTableRecordEntry for more details.

Parameters
NameName of the table in the external (ERP) system - Not used at the moment
TranslationName of the table in the TC data view
lstColumnsTCL list containing all column names in the external (ERP) system - Not used at the moment. lstColumns and lstColumnTranslations must have the same number of list entries
lstColumnTranslationsTCL list containing all column names in the TC data view. lstColumns and lstColumnTranslations must have the same number of list entries
TableHeightHeight of the table in pixels (Optional - Default -> 120)
BackgroundColorDefines the background color of the table control rendered in TC. Format is R-G-B. (Optional, Default -> 255-255-255)
BackgroundColorReadOnlyDefines the background color of read only table controls rendered in TC. Format is R-G-B. (Optional, Default -> 230-230-230)
LabelColorDefines the text color of the label rendered in front of the actual table control in TC. Format is R-G-B. (Optional, Default -> 0-0-0)
Returns
Part of the XML payload for the data view.

◆ createTableRecordEntry()

T4X::PROP::MAPPING::createTableRecordEntry   lstValue ?WriteAccess? ?IsMandatory? ?BackgroundColor? ?BackgroundColorReadOnly? ?ForeColor? args  

This function will create the a 'table record' in the xml payload used for the data view. createTableEntry MUST be called before using this function. See createTableEntry for more details.

Parameters
lstValueTCL list containing the values for all columns in the table. lstValue must have the same number of list entries as lstColumns and lstColumnTranslations from createTableEntry
WriteAccess- Not used at the moment (Optional Default -> FALSE)
IsMandatory- Not used at the moment (Optional Default -> FALSE)
BackgroundColorDefines the background color of the table column entry rendered in TC. Format is R-G-B. (Optional, Default -> 255-255-255)
BackgroundColorReadOnlyDefines the background color of read only table column entry rendered in TC. Format is R-G-B. (Optional, Default -> 230-230-230)
ForeColorDefines the text color of the table column entry rendered in TC. Format is R-G-B. (Optional, Default -> 0-0-0)
Returns
Part of the XML payload for the data view.

◆ end()

T4X::PROP::MAPPING::end   args  

Use in conjunction with the begin command. See begin

Variable Documentation

◆ BooleanAttributes

BooleanAttributes
static

◆ EXCEPTIONAL_XSI_TYPES

EXCEPTIONAL_XSI_TYPES
static

◆ USE_XSI_TYPES

USE_XSI_TYPES
static