T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
PROJ ITK functions

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

Functions

 PROJ__set_default_project HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ__set_default_project to set the project as the default for the given members. More...
 
 PROJ_activate_project HexProjectTag Flag
 This function calls the ITK pipe server function PROJ_activate_project to set the project active or inactive. More...
 
 PROJ_add_author_members HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_add_author_members to add members the project. More...
 
 PROJ_add_members HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_add_members to add members the project. More...
 
 PROJ_ask_assigned_objects ProjectId
 This function calls the ITK pipe server function PROJ_ask_assigned_objects to get the project objects. More...
 
 PROJ_ask_author_members HexProjectTag
 This function calls the ITK pipe server function PROJ_ask_author_members to get the project members. More...
 
 PROJ_ask_id HexProjectTag
 This function calls the ITK pipe server function PROJ_ask_id to get the project id. More...
 
 PROJ_ask_name HexProjectTag
 This function calls the ITK pipe server function PROJ_ask_name to get the project name. More...
 
 PROJ_assign_objects HexProjectTag args
 This function calls the ITK pipe server function PROJ_assign_objects to assign objects to the project. More...
 
 PROJ_assign_team_members HexProjectTag MembersCount HexMembersTag1,..., HexMembersTagN AdministratorsCount HexAdministratorsTag1 HexAdministratorsTag1 ... HexAdministratorsTagN PrivilegedUsersCount HexPrivilegedUsersTag1 ... HexPrivilegedUsersTagN
 This function calls the ITK pipe server function PROJ_assign_team_members to assign team members to the project. More...
 
 PROJ_create_project ProjectId ProjectName ProjectDescr
 This function calls the ITK pipe server function PROJ_create_project to create a project. More...
 
 PROJ_create_project_with_options ProjectId ProjectName ProjectDescr SecurityFlag
 This function calls the ITK pipe server function PROJ_create_project_with_options to create a project with program security level. More...
 
 PROJ_edit_project_options HexProjectTag SecurityFlag
 This function calls the ITK pipe server function PROJ_edit_project_options to edit the project security level. More...
 
 PROJ_find ProjectId
 This function calls the ITK pipe server function PROJ_find to find the project with the given Id. More...
 
 PROJ_find_user_project HexUserTag IncludeInactiveFlag
 This function calls the ITK pipe server function PROJ_find_user_project to find the users projects. More...
 
 PROJ_find_user_projects HexUserTag ActiveOnlyFlag PrivilegedOnlyFlag ProgramOnlyFlag
 This function calls the ITK pipe server function PROJ_find_user_projects to find the users projects. More...
 
 PROJ_initialize HexProjectTag ProjectId ProjectName ProjectDescr
 This function calls the ITK pipe server function PROJ_initialize to set projects id, name and description. More...
 
 PROJ_is_project_active HexProjectTag
 This function calls the ITK pipe server function PROJ_is_project_active to check if the project is activated. More...
 
 PROJ_is_user_a_member HexProjectTag HexUserTag
 This function calls the ITK pipe server function PROJ_is_user_a_member to check if the user is a member of the given project. More...
 
 PROJ_is_user_a_privileged_member HexProjectTag HexUserTag
 This function calls the ITK pipe server function PROJ_is_user_a_privileged_member to check if the user is a privileged member of the given project. More...
 
 PROJ_remove_members HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_remove_members to remove the members from the project. More...
 
 PROJ_remove_objects HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_remove_objects to remove the objects from the project. More...
 

Detailed Description

All ITK functions of group PROJ supported by T4x.

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

Function Documentation

◆ PROJ__set_default_project()

ITK::PROJ__set_default_project   HexProjectTag HexMemberTag1 ... HexMemberTagX  

This function calls the ITK pipe server function PROJ__set_default_project to set the project as the default for the given members.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
HexMemberTag1... HexMemberTagX
Returns
ITK_ok (=0) or List of ITK status and error message

◆ PROJ_activate_project()

ITK::PROJ_activate_project   HexProjectTag Flag  

This function calls the ITK pipe server function PROJ_activate_project to set the project active or inactive.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
Flag- true / false
Returns
ITK_ok (=0) or List of ITK status and error message

◆ PROJ_add_author_members()

ITK::PROJ_add_author_members   HexProjectTag HexMemberTag1 ... HexMemberTagX  

This function calls the ITK pipe server function PROJ_add_author_members to add members the project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
HexMemberTag1... HexMemberTagX
Returns
ITK_ok (=0) or List of ITK status and error message

◆ PROJ_add_members()

ITK::PROJ_add_members   HexProjectTag HexMemberTag1 ... HexMemberTagX  

This function calls the ITK pipe server function PROJ_add_members to add members the project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
HexMemberTag1... HexMemberTagX
Returns
ITK_ok (=0) or List of ITK status and error message

◆ PROJ_ask_assigned_objects()

ITK::PROJ_ask_assigned_objects   ProjectId  

This function calls the ITK pipe server function PROJ_ask_assigned_objects to get the project objects.

Parameters
ProjectIdstring format
Returns
List of ITK_ok (=0) and HexObjectTags or list of ITK status and error message

◆ PROJ_ask_author_members()

ITK::PROJ_ask_author_members   HexProjectTag  

This function calls the ITK pipe server function PROJ_ask_author_members to get the project members.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexMemberTags or list of ITK status and error message

◆ PROJ_ask_id()

ITK::PROJ_ask_id   HexProjectTag  

This function calls the ITK pipe server function PROJ_ask_id to get the project id.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexProjectId or list of ITK status and error message

◆ PROJ_ask_name()

ITK::PROJ_ask_name   HexProjectTag  

This function calls the ITK pipe server function PROJ_ask_name to get the project name.

Parameters
HexProjectTag,Teamcenteritem tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexProjectName or list of ITK status and error message

◆ PROJ_assign_objects()

ITK::PROJ_assign_objects   HexProjectTag args  

This function calls the ITK pipe server function PROJ_assign_objects to assign objects to the project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
args- HexObjectTag1 ... HexObjectTagX
Returns
ITK_ok (=0) or List of ITK status and error message

◆ PROJ_assign_team_members()

ITK::PROJ_assign_team_members   HexProjectTag MembersCount HexMembersTag1, ..., HexMembersTagN AdministratorsCount HexAdministratorsTag1 HexAdministratorsTag1 ... HexAdministratorsTagN PrivilegedUsersCount HexPrivilegedUsersTag1 ... HexPrivilegedUsersTagN  

This function calls the ITK pipe server function PROJ_assign_team_members to assign team members to the project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
MembersCountNumber of members to assign
HexMembersTag1... HexMembersTagN Tags of group members to assign (could be retrieved by ITK::SA_find_groupmember_by_user or ITK::SA_find_groupmembers for a given user)
AdministratorsCountNumber of administrators to assign
HexAdministratorsTag1... HexAdministratorsTagN Tags of administrators to assign
PrivilegedUsersCountNumber of privileged users to assign
HexPrivilegedUsersTag1... HexPrivilegedUsersTagN Tags of privileged users to assign
Returns
ITK_ok (=0) or List of ITK status and error message

Sample code sequence

1 # define user list of member tags
2 set HexMembersTagList [list $MyAdminTag]
3 # define administrator user list of member tags
4 set HexAdministratorsTagList [list $MyAdminTag]
5 # define privileged user list of member tags
6 set HexPrivilegedUsersTagList [list]
7 #
8 # Now we insert the length as first element into the list to the corresponding member tag list
9 #
10 set MembersString [linsert $HexMembersTagList 0 [llength $HexMembersTagList]]
11 set AdministratorsString [linsert $HexAdministratorsTagList 0 [llength $HexAdministratorsTagList]]
12 set PrivilegedUsersString [linsert $HexPrivilegedUsersTagList 0 [llength $HexPrivilegedUsersTagList]]
13 
14 set rc [::ITK::PROJ_assign_team_members $HexProjectTag {*}$MembersString {*}$AdministratorsString {*}$PrivilegedUsersString]
15 if {[::ITK::isITK_ok $StatusList]} {
16  #ITK_ok
17  set PropertyValue [::ITK::getObjectValue $StatusList]
18 } else {
19  # any error
20  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
21  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
22 }

◆ PROJ_create_project()

ITK::PROJ_create_project   ProjectId ProjectName ProjectDescr  

This function calls the ITK pipe server function PROJ_create_project to create a project.

Parameters
ProjectIdstring format
ProjectNamestring format
ProjectDescrstring format
Returns
List of ITK_ok (=0) and HexProjectTag or list of ITK status and error message

◆ PROJ_create_project_with_options()

ITK::PROJ_create_project_with_options   ProjectId ProjectName ProjectDescr SecurityFlag  

This function calls the ITK pipe server function PROJ_create_project_with_options to create a project with program security level.

Parameters
ProjectIdstring format
ProjectNamestring format
ProjectDescrstring format
SecurityFlagtrue / false
Returns
List of ITK_ok (=0) and HexProjectTag or list of ITK status and error message

◆ PROJ_edit_project_options()

ITK::PROJ_edit_project_options   HexProjectTag SecurityFlag  

This function calls the ITK pipe server function PROJ_edit_project_options to edit the project security level.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
SecurityFlagtrue / false
Returns
ITK_ok (=0) or list of ITK status and error message

◆ PROJ_find()

ITK::PROJ_find   ProjectId  

This function calls the ITK pipe server function PROJ_find to find the project with the given Id.

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

◆ PROJ_find_user_project()

ITK::PROJ_find_user_project   HexUserTag IncludeInactiveFlag  

This function calls the ITK pipe server function PROJ_find_user_project to find the users projects.

Parameters
HexUserTagTeamcenter item tag in the Tcl string format
IncludeInactiveFlagstring - true / false
Returns
List of ITK_ok (=0) and HexProjectTags or list of ITK status and error message

◆ PROJ_find_user_projects()

ITK::PROJ_find_user_projects   HexUserTag ActiveOnlyFlag PrivilegedOnlyFlag ProgramOnlyFlag  

This function calls the ITK pipe server function PROJ_find_user_projects to find the users projects.

Parameters
HexUserTagTeamcenter item tag in the Tcl string format
ActiveOnlyFlagstring - true / false
PrivilegedOnlyFlagstring - true / false
ProgramOnlyFlagstring - true / false
Returns
List of ITK_ok (=0) and HexProjectTags or list of ITK status and error message

◆ PROJ_initialize()

ITK::PROJ_initialize   HexProjectTag ProjectId ProjectName ProjectDescr  

This function calls the ITK pipe server function PROJ_initialize to set projects id, name and description.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
ProjectIdstring format
ProjectNamestring format
ProjectDescrstring format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ PROJ_is_project_active()

ITK::PROJ_is_project_active   HexProjectTag  

This function calls the ITK pipe server function PROJ_is_project_active to check if the project is activated.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and 1-active/0-inactive or list of ITK status and error message

◆ PROJ_is_user_a_member()

ITK::PROJ_is_user_a_member   HexProjectTag HexUserTag  

This function calls the ITK pipe server function PROJ_is_user_a_member to check if the user is a member of the given project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
HexUserTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and 1-yes/0-no or list of ITK status and error message

◆ PROJ_is_user_a_privileged_member()

ITK::PROJ_is_user_a_privileged_member   HexProjectTag HexUserTag  

This function calls the ITK pipe server function PROJ_is_user_a_privileged_member to check if the user is a privileged member of the given project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
HexUserTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and 1-yes/0-no or list of ITK status and error message

◆ PROJ_remove_members()

ITK::PROJ_remove_members   HexProjectTag HexMemberTag1 ... HexMemberTagX  

This function calls the ITK pipe server function PROJ_remove_members to remove the members from the project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
HexMemberTag1... HexMemberTagX
Returns
ITK_ok (=0) or List of ITK status and error message

◆ PROJ_remove_objects()

ITK::PROJ_remove_objects   HexProjectTag HexMemberTag1 ... HexMemberTagX  

This function calls the ITK pipe server function PROJ_remove_objects to remove the objects from the project.

Parameters
HexProjectTagTeamcenter item tag in the Tcl string format
HexObjectTag1... HexObjectTagX
Returns
ITK_ok (=0) or List of ITK status and error message