T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
TPSAP::USER Namespace Reference

Functions

 getEmployeeDetail EmployeeId args
 Retrieves SAP employee information. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee. More...
 
 getEmployeeDetail2 inputDict
 Retrieves SAP employee information. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee. More...
 
 getEmployeeList ?LastName? ?SurName? ?ObjectId? args
 Matchcode search for all employees in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries. More...
 
 getEmployeeList2 inputDict
 Matchcode search for all employees in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries. More...
 
 getUserDetail UserName args
 Retrieves SAP user information. All import parameters are transferred via the global ::SAPDat TCL array within the section User. More...
 
 getUserDetail2 inputDict
 Retrieves SAP user information. All import parameters are transferred via the global ::SAPDat TCL array within the section BAPI_USER_GET_DETAIL. More...
 
 getUserEmployee UserId args
 Determines SAP user employee. All import parameters are transferred via the global ::SAPDat TCL array within the section User. More...
 
 getUserEmployee2 inputDict
 Determines SAP user employee. All import parameters are transferred via the global ::SAPDat TCL array within the section User. More...
 
 getUserList args
 Search for all users in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section User. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries. More...
 
 getUserList2 inputDict
 Search for all users in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section User. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries. More...
 

Function Documentation

◆ getEmployeeDetail()

TPSAP::USER::getEmployeeDetail   EmployeeId args  

Retrieves SAP employee information. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee.

Deprecated:
Please use the getEmployeeDetail2 function
Parameters
EmployeeId
Returns
OK and global TCL array ::EmployeeResultDat or ERROR

◆ getEmployeeDetail2()

TPSAP::USER::getEmployeeDetail2   inputDict  

Retrieves SAP employee information. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee.

Parameters
inputDicta dictionary with required keys what are EMPLOYEE_ID READDB the possible keys are:
  • EMPLOYEE_ID Employee Id
  • READDB re read database
  • AUTHORITY_CHECK Authorization check
  • BLDING_NO Search String for Building Number
  • COSTCENTER Search String for Cost Center
  • DATE Search Date
  • EMPLOYEE_ID Search String for Employee Id
  • EXTENSION Telephone extension
  • FSTNAME_M Search String for First Name
  • FST_NAME_K Search String for First Name (Katakana)
  • FST_NAME_R Search String for First Name (Romaji)
  • JOBTXT Search String for Job
  • JOBTXT_LG Search String for Job (long)
  • LASTNAME_M Search String for Last Name
  • LIPLATE_NO Search String for License Plate Number
  • LST_NAME_K Search String for Last Name (Katakana)
  • LST_NAME_R Search String for Last Name (Romaji)
  • ORGTXT Search String for Organizational Unit
  • ORGTXT_LG Search String for Organizational Unit (long)
  • PHONE_NO Search String for Telephone Number
  • POSTXT Search String for Position
  • POSTXT_LG Search String for Position (long)
  • READDB Re-Read Database
  • ROOM_NO Search String for Room Number
  • USERID Search String for Communications ID
Returns
dict structure with the following elements:
  • Status OK|ERROR
  • ErrorMessage last error message
  • NoOfMessages number of messages
  • LogMessageMessage(1 .. n)
  • LogMessageSeverity(1 .. n) and TCL array ::EmployeeResultDat or ERROR

Sample code sequence for getEmployeeDetail2

1 set resultDict [::TPSAP::USER::getEmployeeDetail2 [dict create EMPLOYEE_ID 100353 READDB 1]]
2 if { [dict get $resultDict Status] eq "OK"} {
3  foreach e [array names ::EmployeeDetailResultDat] {
4  puts "$e => $::EmployeeDetailResultDat($e)"
5  }
6 }

◆ getEmployeeList()

TPSAP::USER::getEmployeeList   ?LastName? ?SurName? ?ObjectId? args  

Matchcode search for all employees in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries.

Deprecated:
Please use the getEmployList2 function
Parameters
LastName
SurName
Returns
OK and global TCL array ::EmployeeResultDat or ERROR

◆ getEmployeeList2()

TPSAP::USER::getEmployeeList2   inputDict  

Matchcode search for all employees in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section Employee. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries.

Parameters
inputDicta dictionary with required keys what is OBJECT_ID, the possible keys are:
  • BUILDING_SEARK Search String for Buildings
  • INHOUSE_TEL1_SEARK Search String for Telephone Number
  • INHOUSE_TEL2_SEARK Search String for 2nd Telephone Number (Fax)
  • JOB_SEARK Search String for Jobs
  • LST_NAME_SEARK Search String for Last Names
  • OBJECT_ID Only Included Formally
  • ORG_SEARK Search String for Organizational Units
  • ROOM_SEARK Search String for Rooms
  • SEARCH_DATE Date for Search (Default: Current Date)
  • SUR_NAME_SEARK Search String for First Names
Returns
dict structure with the following elements:
  • Status OK|ERROR|JCO_ERROR
  • JCoStatus OK|ERROR
  • ErrorMessage last error message
  • NoOfMessages number of messages
  • LogMessageMessage(1 .. n)
  • LogMessageSeverity(1 .. n) and OK and global TCL array ::EmployeeResultDat or ERROR

Sample code sequence

1 set resultDict [::TPSAP::USER::getEmployeeList2 [dict create OBJECT_ID 00000000 SUR_NAME_SEARK * LST_NAME_SEARK *]]
2 if { [dict get $resultDict Status] eq "OK"} {
3  foreach e [array names ::EmployeeListResultDat] {
4  puts "$e => $::EmployeeListResultDat($e)"
5  }
6 }

◆ getUserDetail()

TPSAP::USER::getUserDetail   UserName args  

Retrieves SAP user information. All import parameters are transferred via the global ::SAPDat TCL array within the section User.

Deprecated:
Please use the getUserDetail2 function
Parameters
UserName
argsnot used
Returns
OK and global TCL array ::UserResultDat or ERROR

◆ getUserDetail2()

TPSAP::USER::getUserDetail2   inputDict  

Retrieves SAP user information. All import parameters are transferred via the global ::SAPDat TCL array within the section BAPI_USER_GET_DETAIL.

Parameters
inputDicta dictionary with required keys what is USERNAME, the possible keys are:
  • CACHE_RESULTS Temporarily buffer results in work process
  • USERNAME User Name
Returns
dict structure with the following elements:
  • Status OK|ERROR
  • JCoStatus OK
  • ErrorMessage last error message
  • NoOfMessages number of messages
  • LogMessageMessage(1 .. n)
  • LogMessageSeverity(1 .. n) and global TCL array ::UserDetailResultDat

Sample code sequence

1 set resultDict [::TPSAP::USER::getUserDetail2 [dict create USERNAME tpuser01]]
2 if { [dict get $resultDict Status] eq "OK"} {
3  foreach e [array names ::UserDetailResultDat] {
4  puts "$e => $::UserDetailResultDat($e)"
5  }
6 }

◆ getUserEmployee()

TPSAP::USER::getUserEmployee   UserId args  

Determines SAP user employee. All import parameters are transferred via the global ::SAPDat TCL array within the section User.

Deprecated:
Please use the getUserEmployee2 function
Parameters
userId
Returns
OK and global TCL array ::UserResultDat or ERROR

◆ getUserEmployee2()

TPSAP::USER::getUserEmployee2   inputDict  

Determines SAP user employee. All import parameters are transferred via the global ::SAPDat TCL array within the section User.

Parameters
inputDicta dictionary with required keys what is ID, the possible keys are:
  • BEGINDATE Begin date
  • ENDDATE Begin date
  • ID User name
Returns
dict structure with the following elements:
  • Status OK|ERROR|JCO_ERROR
  • JCoStatus OK
  • ErrorMessage last error message
  • NoOfMessages number of messages
  • LogMessageMessage(1 .. n)
  • LogMessageSeverity(1 .. n) and global TCL array ::UserResultDat or ERROR

Sample code sequence

1 set resultDict [::TPSAP::USER::getUserEmployee2 [dict create ID 100353]]
2 if { [dict get $resultDict Status] eq "OK"} {
3  foreach e [array names ::UserEmployeeResultDat] {
4  puts "$e => $::UserEmployeeResultDat($e)"
5  }
6 }

◆ getUserList()

TPSAP::USER::getUserList   args  

Search for all users in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section User. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries.

Deprecated:
Please use the new getUserDetail2 function
Returns
OK and global TCL array ::UserListResultDat or ERROR

◆ getUserList2()

TPSAP::USER::getUserList2   inputDict  

Search for all users in SAP. All import parameters are transferred via the global ::SAPDat TCL array within the section User. To achieve this functionality, the T4S netweaver technology is used. Therefor it is necessary to download and install the proper SAP netweaver libraries.

Parameters
inputDicta dictionary with no required keys, the possible keys are:
  • MAX_ROWS Maximum Number of Lines of Hits, 0 mean without limits
  • WITH_USERNAME Read User with Name, X mean with user names
Returns
dict structure with the following elements:
  • Status OK|ERROR
  • JCoStatus OK
  • ErrorMessage last error message
  • NoOfMessages number of messages
  • LogMessageMessage(1 .. n)
  • LogMessageSeverity(1 .. n) and ::UserResultDat or ERROR

Sample code sequence

1 set resultDict [::TPSAP::USER::getUserList2 [dict create]]
2 if { [dict get $resultDict Status] eq "OK"} {
3  foreach e [array names ::UserListResultDat] {
4  puts "$e => $::UserListResultDat($e)"
5  }
6 }