T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
TPSAP::USER Namespace Reference

Namespaces

 GEN
 

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 EmployeeId ReadDB
 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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO libraries. More...
 
 getEmployeeList2 ?LastName? ?SurName? ?ObjectId?
 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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO 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 userName
 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 userId
 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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO libraries. More...
 
 getUserList2
 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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO 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
Returns
OK and global TCL array ::EmployeeResultDat or ERROR

References getEmployeeDetail2().

◆ getEmployeeDetail2()

TPSAP::USER::getEmployeeDetail2   EmployeeId ReadDB  

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

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 TCL array ::EmployeeResultDat or ERROR

References TPSAP::getSessionLogChannel().

Referenced by getEmployeeDetail().

◆ 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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO libraries.

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

References getEmployeeList2().

◆ getEmployeeList2()

TPSAP::USER::getEmployeeList2   ?LastName? ?SurName? ?ObjectId?  

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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO libraries.

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

References TPSAP::getSessionLogChannel().

Referenced by getEmployeeList().

◆ 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
Returns
OK and global TCL array ::UserResultDat or ERROR

References getUserDetail2().

◆ getUserDetail2()

TPSAP::USER::getUserDetail2   userName  

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

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 global TCL array ::UserResultDat

References TPSAP::getSessionLogChannel().

Referenced by getUserDetail().

◆ 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
Returns
OK and global TCL array ::UserResultDat or ERROR

References getUserEmployee2().

◆ getUserEmployee2()

TPSAP::USER::getUserEmployee2   userId  

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

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 global TCL array ::UserResultDat or ERROR

References TPSAP::getSessionLogChannel().

Referenced by getUserEmployee().

◆ 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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO libraries.

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

References getUserList2().

◆ getUserList2()

TPSAP::USER::getUserList2

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 JCO technology is used. Therefor it is necessary to download and install the proper SAP JCO libraries.

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 ::UserResultDat or ERROR

References TPSAP::getSessionLogChannel().

Referenced by getUserList().