T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
SA ITK functions

All ITK functions of group SA supported by T4x. More...

Functions

 SA_add_role_to_group HexGroupTag HexRoleTag
 adds a role to the group More...
 
 SA_ask_current_location_code
 This function calls return the the Current LocationCode for the session. More...
 
 SA_ask_current_organization
 This function calls return the Current Organization for the session. More...
 
 SA_ask_current_project
 gets with SA_ask_current_project the current project tag More...
 
 SA_ask_current_role
 gets the current role More...
 
 SA_ask_current_role_name
 gets with SA_ask_current_role the current role and asks its name with SA_ask_role_name More...
 
 SA_ask_current_user_context
 This function calls return the the Current LocationCode for the session. More...
 
 SA_ask_current_work_context
 This function calls return the the Current LocationCode for the session. More...
 
 SA_ask_group_full_name HexGroupTag
 gets the full group name More...
 
 SA_ask_group_parent HexGroupTag
 returns a parent of the group More...
 
 SA_ask_groupmember_role HexGroupMemberTag
 returns a role of the group member More...
 
 SA_ask_person_attr HexPersonTag HexAttributeName
 This function calls the ITK pipe server function SA_ask_person_attr to read the value of the person named attribute. More...
 
 SA_ask_role_name HexRoleTag
 gets the role name More...
 
 SA_ask_roles_from_group HexGroupTag
 gets all roles of the group More...
 
 SA_ask_user_login_group HexUserTag
 This function calls the ITK pipe server function SA_ask_user_login_group to get the default group for the given user. More...
 
 SA_ask_user_work_contexts
 This function calls the work contexts associated with the user's workflow tasks (Tasks to Perform) or their targets. More...
 
 SA_change_group_by_name GroupName RoleName
 This function calls the ITK pipe server function executeQuery to change the current group of the pipe server. More...
 
 SA_create_discipline HexDisciplineName
 This function calls the ITK pipe server function SA_create_discipline to create the disciplineTag with the given discipline name. AOM_save is called after creation. More...
 
 SA_create_groupmember HexGroupTag HexUserTag AdminFlag
 This function calls the ITK pipe server function SA_create_groupmember to create the group member for the given groupTag and userTag. AOM_save is called after creation. More...
 
 SA_create_h_group HexGroupName Privilege HexParentGroupTag HexVolumeName
 This function calls the ITK pipe server function SA_create_h_group to create the group with the given group name. AOM_save is called after creation. More...
 
 SA_create_person HexPersonName
 This function calls the ITK pipe server function SA_create_person to create the personTag with the given person name. AOM_save is called after creation. More...
 
 SA_create_role HexRoleName
 This function calls the ITK pipe server function SA_create_role to create the role with the given role name. AOM_save is called after creation. More...
 
 SA_create_user HexUserId HexPersonName HexUserPassword HexGroupTag HexVolumeName
 This function calls the ITK pipe server function SA_create_user to create the user with the given user name. AOM_save is called after creation. More...
 
 SA_create_user2 HexUserId HexPersonName HexUserPassword
 This function calls the ITK pipe server function SA_create_user to create the user with the given user name. More...
 
 SA_create_user2_x HexUserId HexPersonName HexUserPassword HexGroupTag HexVolumeName
 This function calls the ITK pipe server function SA_create_user to create the user with the given user name. AOM_save is called after creation. More...
 
 SA_find_discipline HexDisciplineName
 This function calls the ITK pipe server function SA_find_discipline to find the disciplineTag of the given discipline name. More...
 
 SA_find_group HexGroupName
 This function calls the ITK pipe server function SA_find_group to find the group tag of the given user name. More...
 
 SA_find_groupmember_by_role HexGroupTag HexRoleTag
 This function calls the ITK pipe server function SA_find_groupmember_by_role to find the memberTags of the given groupTag and roleTag. More...
 
 SA_find_groupmember_by_user HexUserTag
 This function calls the ITK pipe server function SA_find_groupmember_by_user to find the memberTags of the given userTag. More...
 
 SA_find_groupmembers HexGroupTag HexUserTag
 This function calls the ITK pipe server function SA_find_groupmembers to find the memberTags of the given groupTag. More...
 
 SA_find_groupmembers_by_group HexGroupTag
 This function calls the ITK pipe server function SA_find_groupmembers_by_group to find the memberTags of the given groupTag. More...
 
 SA_find_person HexPersonName
 This function calls the ITK pipe server function SA_find_person to find the personTag of the given person name. More...
 
 SA_find_role HexRoleName
 This function calls the ITK pipe server function SA_find_role to find the roleTag of the given role name. More...
 
 SA_find_user HexUserId
 This function calls the ITK pipe server function SA_find_user to find the userTag of the given user id. More...
 
 SA_find_user2
 This function calls the user tag for given userid. More...
 
 SA_remove_role_from_group HexGroupTag HexRoleTag
 removes a role from the group More...
 
 SA_set_current_project HexProjectTag
 set the given project as Current Project for the session. More...
 
 SA_set_default_role HexUserTag HexGroupTag HexRoletag
 This function calls the ITK pipe server function SA_set_default_role to set the default role with for the user in the group. More...
 
 SA_set_group_parent HexParentGroupTag HexChildGroupTag
 sets a parent for the group More...
 
 SA_set_groupmember_group HexGroupMemberTag HexGroupTag
 This function calls the ITK pipe server function SA_set_groupmember_group to set the userTag for the groupMemberTag. More...
 
 SA_set_groupmember_inactive HexGroupMemberTag InactiveFlag
 sets a group member active or inactive More...
 
 SA_set_groupmember_role HexGroupMemberTag HexRoleTag
 This function calls the ITK pipe server function SA_set_groupmember_role to set the roleTag for the groupMemberTag. More...
 
 SA_set_groupmember_user HexGroupMemberTag HexUserTag
 This function calls the ITK pipe server function SA_set_groupmember_user to set the userTag for the groupMemberTag. More...
 
 SA_set_user_login_group HexUserTag HexGroupTag
 This function calls the ITK pipe server function SA_set_user_login_group to set the given group as a default group for the user. More...
 
 SA_set_user_person HexUserTag HexPersonTag
 This function calls the ITK pipe server function SA_set_user_person to connect the userTag with the personTag. More...
 
 SA_set_user_status HexUserTag InactiveFlag
 sets user to active or inactive More...
 

Detailed Description

All ITK functions of group SA supported by T4x.

This group specifies all ITK functions of group SA for which wrappers have been defined in T4x

Function Documentation

◆ SA_add_role_to_group()

ITK::SA_add_role_to_group   HexGroupTag HexRoleTag  

adds a role to the group

Parameters
HexGroupTag
HexRoleTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_ask_current_location_code()

ITK::SA_ask_current_location_code

This function calls return the the Current LocationCode for the session.

Returns
0 and location_code (could be empty list) or list of ITK status and error message

◆ SA_ask_current_organization()

ITK::SA_ask_current_organization

This function calls return the Current Organization for the session.

Returns
0 and ProjectTag (could be empty list) or list of ITK status and error message

◆ SA_ask_current_project()

ITK::SA_ask_current_project

gets with SA_ask_current_project the current project tag

Returns
0 and ProjectTag (could be empty list) or list of ITK status and error message

◆ SA_ask_current_role()

ITK::SA_ask_current_role

gets the current role

Returns
0 and HexRoleTag or list of ITK status and error message

◆ SA_ask_current_role_name()

ITK::SA_ask_current_role_name

gets with SA_ask_current_role the current role and asks its name with SA_ask_role_name

Returns
0 and HexRoleName or list of ITK status and error message

◆ SA_ask_current_user_context()

ITK::SA_ask_current_user_context

This function calls return the the Current LocationCode for the session.

Returns
0 and current_user_context (could be empty list) or list of ITK status and error message

◆ SA_ask_current_work_context()

ITK::SA_ask_current_work_context

This function calls return the the Current LocationCode for the session.

Returns
0 and current_work_context (could be empty list) or list of ITK status and error message

◆ SA_ask_group_full_name()

ITK::SA_ask_group_full_name   HexGroupTag  

gets the full group name

Parameters
HexGroupTag
Returns
0 and HexGroupName or list of ITK status and error message

◆ SA_ask_group_parent()

ITK::SA_ask_group_parent   HexGroupTag  

returns a parent of the group

Parameters
HexGroupTag
Returns
ITK_ok (=0) only if no parent set or ITK_ok and HexParentTag or list of ITK status and error message

◆ SA_ask_groupmember_role()

ITK::SA_ask_groupmember_role   HexGroupMemberTag  

returns a role of the group member

Parameters
HexGroupMemberTag
Returns
ITK_ok (=0) only if no role set or ITK_ok and HexRoleTag or list of ITK status and error message

◆ SA_ask_person_attr()

ITK::SA_ask_person_attr   HexPersonTag HexAttributeName  

This function calls the ITK pipe server function SA_ask_person_attr to read the value of the person named attribute.

Parameters
HexPersonTag
HexAttributeName
Returns
0 and HexAttributeValue or list of ITK status and error message

◆ SA_ask_role_name()

ITK::SA_ask_role_name   HexRoleTag  

gets the role name

Parameters
HexRoleTag
Returns
0 and HexRoleName or list of ITK status and error message

◆ SA_ask_roles_from_group()

ITK::SA_ask_roles_from_group   HexGroupTag  

gets all roles of the group

Parameters
HexGroupTag
Returns
ITK_ok (=0) and list of roleTags or list of ITK status and error message

◆ SA_ask_user_login_group()

ITK::SA_ask_user_login_group   HexUserTag  

This function calls the ITK pipe server function SA_ask_user_login_group to get the default group for the given user.

Parameters
HexUserTag
Returns
ITK_ok (=0) and Tag of Default Login Group or list of ITK status and error message

◆ SA_ask_user_work_contexts()

ITK::SA_ask_user_work_contexts

This function calls the work contexts associated with the user's workflow tasks (Tasks to Perform) or their targets.

Returns
0 and current_work_contexts (could be empty list) or list of ITK status and error message

◆ SA_change_group_by_name()

ITK::SA_change_group_by_name   GroupName RoleName  

This function calls the ITK pipe server function executeQuery to change the current group of the pipe server.

Parameters
GroupNamename of the Teamcenter Group to switch to
RoleNamename of the Teamcenter Role to switch to Remark: The parameter RoleName is not jet supported
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_create_discipline()

ITK::SA_create_discipline   HexDisciplineName  

This function calls the ITK pipe server function SA_create_discipline to create the disciplineTag with the given discipline name. AOM_save is called after creation.

Parameters
HexDisciplineName
Returns
ITK_ok (=0) and HexDisciplineTag or list of ITK status and error message

◆ SA_create_groupmember()

ITK::SA_create_groupmember   HexGroupTag HexUserTag AdminFlag  

This function calls the ITK pipe server function SA_create_groupmember to create the group member for the given groupTag and userTag. AOM_save is called after creation.

Parameters
HexGroupTag
HexUserTag
AdminFlag- 0 or 1
Returns
ITK_ok (=0) and HexGroupMemberTag or list of ITK status and error message

◆ SA_create_h_group()

ITK::SA_create_h_group   HexGroupName Privilege HexParentGroupTag HexVolumeName  

This function calls the ITK pipe server function SA_create_h_group to create the group with the given group name. AOM_save is called after creation.

Parameters
HexGroupName
Privilege- 0 or 1
HexParentGroupTag
HexVolumeName- optional or if equals "" no Volume will be set
Returns
ITK_ok (=0) and HexGroupTag or list of ITK status and error message

◆ SA_create_person()

ITK::SA_create_person   HexPersonName  

This function calls the ITK pipe server function SA_create_person to create the personTag with the given person name. AOM_save is called after creation.

Parameters
HexPersonName
Returns
ITK_ok (=0) and HexPersonTag or list of ITK status and error message

◆ SA_create_role()

ITK::SA_create_role   HexRoleName  

This function calls the ITK pipe server function SA_create_role to create the role with the given role name. AOM_save is called after creation.

Parameters
HexRoleName
Returns
ITK_ok (=0) and HexRoleTag or list of ITK status and error message

◆ SA_create_user()

ITK::SA_create_user   HexUserId HexPersonName HexUserPassword HexGroupTag HexVolumeName  

This function calls the ITK pipe server function SA_create_user to create the user with the given user name. AOM_save is called after creation.

Parameters
HexUserId
HexPersonName- the person has to exists (can be created using SA_create_person)
HexUserPassword
HexGroupTag- to find via SA_find_group
HexVolumeName- optional or if equals "" no Volume will be set
Returns
ITK_ok (=0) and HexUserTag or list of ITK status and error message

◆ SA_create_user2()

ITK::SA_create_user2   HexUserId HexPersonName HexUserPassword  

This function calls the ITK pipe server function SA_create_user to create the user with the given user name.

Parameters
HexUserId- the user id
HexPersonName- the person has to exist (can be created using SA_create_person)
HexUserPassword- the user password
Returns
ITK_ok (=0) and HexUserTag or list of ITK status and error message

◆ SA_create_user2_x()

ITK::SA_create_user2_x   HexUserId HexPersonName HexUserPassword HexGroupTag HexVolumeName  

This function calls the ITK pipe server function SA_create_user to create the user with the given user name. AOM_save is called after creation.

Parameters
HexUserId- the user id
HexPersonName- the person has to exist (can be created using SA_create_person)
HexUserPassword- the user password
HexGroupTag- to find via SA_find_group
HexVolumeName- optional
Returns
ITK_ok (=0) and HexUserTag or list of ITK status and error message

◆ SA_find_discipline()

ITK::SA_find_discipline   HexDisciplineName  

This function calls the ITK pipe server function SA_find_discipline to find the disciplineTag of the given discipline name.

Parameters
HexDisciplineName
Returns
ITK_ok (=0) and HexDisciplineTag or list of ITK status and error message

◆ SA_find_group()

ITK::SA_find_group   HexGroupName  

This function calls the ITK pipe server function SA_find_group to find the group tag of the given user name.

Parameters
HexGroupName
Returns
ITK_ok (=0) and HexGroupTag or list of ITK status and error message

◆ SA_find_groupmember_by_role()

ITK::SA_find_groupmember_by_role   HexGroupTag HexRoleTag  

This function calls the ITK pipe server function SA_find_groupmember_by_role to find the memberTags of the given groupTag and roleTag.

Parameters
HexGroupTag
HexRoleTag
Returns
ITK_ok (=0) and list of HexGroupMemberTags or list of ITK status and error message

◆ SA_find_groupmember_by_user()

ITK::SA_find_groupmember_by_user   HexUserTag  

This function calls the ITK pipe server function SA_find_groupmember_by_user to find the memberTags of the given userTag.

Parameters
HexUserTag
Returns
ITK_ok (=0) and list of HexGroupMemberTags or list of ITK status and error message

◆ SA_find_groupmembers()

ITK::SA_find_groupmembers   HexGroupTag HexUserTag  

This function calls the ITK pipe server function SA_find_groupmembers to find the memberTags of the given groupTag.

Parameters
HexGroupTag
HexUserTag
Returns
ITK_ok (=0) and list of HexGroupMemberTags or list of ITK status and error message

◆ SA_find_groupmembers_by_group()

ITK::SA_find_groupmembers_by_group   HexGroupTag  

This function calls the ITK pipe server function SA_find_groupmembers_by_group to find the memberTags of the given groupTag.

Parameters
HexGroupTag
Returns
ITK_ok (=0) and list of HexGroupMemberTags or list of ITK status and error message

◆ SA_find_person()

ITK::SA_find_person   HexPersonName  

This function calls the ITK pipe server function SA_find_person to find the personTag of the given person name.

Parameters
HexPersonName
Returns
ITK_ok (=0) and HexPersonTag or list of ITK status and error message

◆ SA_find_role()

ITK::SA_find_role   HexRoleName  

This function calls the ITK pipe server function SA_find_role to find the roleTag of the given role name.

Parameters
HexRoleName
Returns
ITK_ok (=0) and HexRoleTag or list of ITK status and error message

◆ SA_find_user()

ITK::SA_find_user   HexUserId  

This function calls the ITK pipe server function SA_find_user to find the userTag of the given user id.

Deprecated:
It will be removed from Tc12. From Tc10 onwards, please use ITK::SA_find_user2 instead.
Parameters
HexUserId
Returns
ITK_ok (=0) and HexUserTag or list of ITK status and error message

◆ SA_find_user2()

ITK::SA_find_user2

This function calls the user tag for given userid.

Returns
ITK_ok (=0) and HexUserTag or list of ITK status and error message

◆ SA_remove_role_from_group()

ITK::SA_remove_role_from_group   HexGroupTag HexRoleTag  

removes a role from the group

Parameters
HexGroupTag
HexRoleTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_current_project()

ITK::SA_set_current_project   HexProjectTag  

set the given project as Current Project for the session.

Parameters
HexProjectTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_default_role()

ITK::SA_set_default_role   HexUserTag HexGroupTag HexRoletag  

This function calls the ITK pipe server function SA_set_default_role to set the default role with for the user in the group.

Parameters
HexUserTag
HexGroupTag
HexRoletag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_group_parent()

ITK::SA_set_group_parent   HexParentGroupTag HexChildGroupTag  

sets a parent for the group

Parameters
HexParentGroupTag- set to "" if the parent group shall be removed from the child group
HexChildGroupTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_groupmember_group()

ITK::SA_set_groupmember_group   HexGroupMemberTag HexGroupTag  

This function calls the ITK pipe server function SA_set_groupmember_group to set the userTag for the groupMemberTag.

Parameters
HexGroupMemberTag
HexGroupTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_groupmember_inactive()

ITK::SA_set_groupmember_inactive   HexGroupMemberTag InactiveFlag  

sets a group member active or inactive

Parameters
HexGroupMemberTag
InactiveFlag- 0/1
Returns
ITK_ok (=0) and list of roleTags or list of ITK status and error message

◆ SA_set_groupmember_role()

ITK::SA_set_groupmember_role   HexGroupMemberTag HexRoleTag  

This function calls the ITK pipe server function SA_set_groupmember_role to set the roleTag for the groupMemberTag.

Parameters
HexGroupMemberTag
HexRoleTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_groupmember_user()

ITK::SA_set_groupmember_user   HexGroupMemberTag HexUserTag  

This function calls the ITK pipe server function SA_set_groupmember_user to set the userTag for the groupMemberTag.

Parameters
HexGroupMemberTag
HexUserTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_user_login_group()

ITK::SA_set_user_login_group   HexUserTag HexGroupTag  

This function calls the ITK pipe server function SA_set_user_login_group to set the given group as a default group for the user.

Parameters
HexUserTag
HexGroupTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_user_person()

ITK::SA_set_user_person   HexUserTag HexPersonTag  

This function calls the ITK pipe server function SA_set_user_person to connect the userTag with the personTag.

Parameters
HexUserTag
HexPersonTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ SA_set_user_status()

ITK::SA_set_user_status   HexUserTag InactiveFlag  

sets user to active or inactive

Parameters
HexUserTag
InactiveFlag- 0/1
Returns
ITK_ok (=0) or list of ITK status and error message