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

Functions

 addMemberships MemberShipAddDict
 This function calls the TcSoa based function addMemberships to update the membership of a given Schedule in Teamcenter. More...
 
 createDependencies CreateDependenciesDict
 This function calls the TcSoa based function createDependencies to create a dependency between two Task in Teamcenter. More...
 
 createMilestone MilestoneCreateDict args
 This function calls the TcSoa based function createMilestone to create a Milestone Task in Teamcenter. More...
 
 createSchedule ScheduleCreateDict
 This function calls the TcSoa based function createSchedule to create a new Schedule based on a given parameters in Teamcenter. More...
 
 createScheduleFromTemplate ScheduleCreateDict CopyOptionsDict
 This function calls the TcSoa based function createScheduleFromTemplate to create a new Schedule based on a given Schedule template in Teamcenter. More...
 
 createScheduleNewBaselines ScheduleBaselineCreateDict
 This function calls the TcSoa based function createScheduleNewBaselines to create a Baseline for a given Schedule in Teamcenter. More...
 
 createScheduleProxyTask ScheduleProxyTaskCreateDict
 This function calls the TcSoa based function createScheduleProxyTask to create a Proxy Task in Teamcenter. More...
 
 createScheduleTask ScheduleTaskCreateDict
 This function calls the TcSoa based function createScheduleTask to create a Schedule Task in Teamcenter. More...
 
 deleteDependencies DeleteDependenciesDict
 This function calls the TcSoa based function deleteDependencies to delete a dependency between two Task in Teamcenter. More...
 
 deleteScheduleTask ScheduleTaskDeleteDict
 This function calls the TcSoa based function deleteScheduleTaskExecution to delete a given Task in Teamcenter. More...
 
 detachSchedule ScheduleDetachDict
 This function calls the TcSoa based function detachSchedule to detach a given Sub-Schedule from a defined Master-Schedule in Teamcenter. More...
 
 insertSchedule ScheduleInsertDict
 This function calls the TcSoa based function insertSchedule to insert a given Sub-Schedule into a defined Master-Schedule in Teamcenter. More...
 
 logoutSession args
 This function calls the TcSoa based function logoutSession to close the connection to the Teamcenter server. More...
 
 moveScheduleTask ScheduleTaskMoveDict
 This function calls the TcSoa based function moveScheduleTask to move a Schedule Task in the structure of a given schedule in Teamcenter. More...
 
 shiftSchedule ScheduleShiftDict
 This function calls the TcSoa based function shiftScheduleNonInteractive to shift a Schedule to a new start or finish date. More...
 
 updateDependencies UpdateDependenciesDict
 This function calls the TcSoa based function updateDependencies to update a dependency between two Task in Teamcenter. More...
 
 updateSchedule ScheduleUpdateDict
 This function calls the TcSoa based function updateSchedule to update the corresponding Schedule in Teamcenter. More...
 
 updateScheduleObject UpdateObjectAttributesDict
 This function calls the TcSoa based function updateScheduleObject to update a given Schedule object in Teamcenter. More...
 
 updateScheduleTask ScheduleTaskUpdateDict
 This function calls the TcSoa based function updateScheduleTask to update a given Task in Teamcenter. More...
 
 updateScheduleTaskExecution UpdateScheduleTaskExecutionDict
 This function calls the TcSoa based function updateScheduleTaskExecution to update a given Task in Teamcenter. More...
 

Function Documentation

◆ addMemberships()

TC11::SCHMGR::addMemberships   MemberShipAddDict  

This function calls the TcSoa based function addMemberships to update the membership of a given Schedule in Teamcenter.

Parameters
MemberShipAddDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id, this represents the schedule for the new membership.
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • MemberShip resource: The resource to add to the schedule. The resource can be a User, Group, or Discipline. Valid value is tag of the resource.
  • MemberShip membershipLevel: The membership level of the resource in the schedule. Following are the valid values: 0-Observer,1-Participant,2-Coordinator.
  • MemberShip cost: This is the string representing the cost value of the resource.
  • MemberShip currency: This is the string representing the ISO-4217 currency code. Only those keys are used during the update that are specified all other informations will be untouched, any other key will be ignored.
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 set UserStatus [::ITK::SA_find_user [tpco_scanHEX16 $UserName]]
2 if {[::ITK::isITK_ok $UserStatus]} {
3  set UserTag [string range [tpco_formatHEX16 [lindex $UserStatus 1]] 0 13]
4 }
5 dict set addMemberShipDict Schedule item_id $ScheduleId
6 dict set addMemberShipDict Schedule object_type Schedule
7 dict set addMemberShipDict MemberShip membershipLevel "2"; # Coordinator
8 dict set addMemberShipDict MemberShip resource $UserTag; # Tag representation of the user
9 set Status [::TC11::SCHMGR::addMemberships $addMemberShipDict]
10 puts "::TC11::SCHMGR::addMemberships $Status"

◆ createDependencies()

TC11::SCHMGR::createDependencies   CreateDependenciesDict  

This function calls the TcSoa based function createDependencies to create a dependency between two Task in Teamcenter.

Parameters
CreateDependenciesDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • PredecessorTask item_id: task id (required)
  • PredecessorTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • SuccessorTask item_id: task id (required)
  • SuccessorTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Dependency dependency_type Task dependency type, with the following possible values:
    • FF: finish->finish
    • FS: finish->start
    • SS: start->start
    • SF: start->finish
  • Dependency lag_time
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set DependencyCreateDict Schedule item_id $ScheduleId
2 dict set DependencyCreateDict Schedule object_type Schedule
3 
4 dict set DependencyCreateDict PredecessorTask item_id $TaskId1
5 dict set DependencyCreateDict PredecessorTask object_type ScheduleTask
6 
7 dict set DependencyCreateDict SuccessorTask item_id $TaskId2
8 dict set DependencyCreateDict SuccessorTask object_type ScheduleTask
9 
10 dict set DependencyCreateDict Dependency dependency_type "SS"
11 dict set DependencyCreateDict Dependency lag_time ScheduleTask
12 
13 set Status [::TC11::SCHMGR::createDependencies $DependencyCreateDict]
14 puts "::TC11::SCHMGR::createDependencies $Status"

◆ createMilestone()

TC11::SCHMGR::createMilestone   MilestoneCreateDict args  

This function calls the TcSoa based function createMilestone to create a Milestone Task in Teamcenter.

Parameters
MilestoneCreateDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • ParentTask item_id: task id (required)
  • ParentTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • PreviousSiblingTask item_id: task id (required)
  • PreviousSiblingTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task item_id: task id (required)
  • Task object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task object_name
  • Task start_date Start date of the Schedule Task (format yyyymmdd hhmmss)
  • Task finish_date Finish date of the Schedule Task (format yyyymmddhhMMss)
  • Task work_estimate
  • Task duration
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set MilestoneCreateDict Schedule item_id $ScheduleId
2 dict set MilestoneCreateDict Schedule object_type Schedule
3 
4 if {[string length $ParentTaskId] > 0} {
5  dict set MilestoneCreateDict ParentTask item_id $ParentTaskId
6  dict set MilestoneCreateDict ParentTask object_type ScheduleTask
7 }
8 if {[string length $PreviousTaskId] > 0} {
9  dict set MilestoneCreateDict PreviousSiblingTask item_id $PreviousTaskId
10  dict set MilestoneCreateDict PreviousSiblingTask object_type ScheduleTask
11 }
12 
13 dict set MilestoneCreateDict Task item_id $TaskId
14 dict set MilestoneCreateDict Task object_type ScheduleTask
15 dict set MilestoneCreateDict Task object_name $TaskName
16 
17 dict set MilestoneCreateDict Task start_date $MilestoneDate
18 dict set MilestoneCreateDict Task finish_date $MilestoneDate
19 #dict set MilestoneCreateDict Task work_estimate 480
20 set Status [::TC11::SCHMGR::createMilestone $MilestoneCreateDict]
21 puts "::TC11::SCHMGR::createMilestone $Status"

References createScheduleTask().

◆ createSchedule()

TC11::SCHMGR::createSchedule   ScheduleCreateDict  

This function calls the TcSoa based function createSchedule to create a new Schedule based on a given parameters in Teamcenter.

Parameters
ScheduleCreateDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id
  • Schedule object_name: Schedule name
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • Schedule start_date: Start date of the Schedule (format yyyymmddhhMMss)
  • Schedule finish_date: Finish date of the Schedule (format yyyymmddhhMMss)
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set ScheduleCreateDict Schedule item_id $ScheduleId; # Schedule Id
2 dict set ScheduleCreateDict Schedule object_type Schedule; # Schedule object type
3 dict set ScheduleCreateDict Schedule object_name $ScheduleName
4 dict set ScheduleCreateDict Schedule start_date $StartDate
5 dict set ScheduleCreateDict Schedule finish_date $FinishDate
6 
7 set Status [::TC11::SCHMGR::createSchedule $ScheduleCreateDict]
8 puts "::TC11::SCHMGR::createSchedule $Status"

◆ createScheduleFromTemplate()

TC11::SCHMGR::createScheduleFromTemplate   ScheduleCreateDict CopyOptionsDict  

This function calls the TcSoa based function createScheduleFromTemplate to create a new Schedule based on a given Schedule template in Teamcenter.

Parameters
ScheduleCreateDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • Schedule object_name: Schedule name
  • ScheduleTemplate item_id: Schedule Id of the template Schedule
  • ScheduleTemplate object_type: Schedule template object type (optional, only needed if a customer specific one is used)
CopyOptionsDictDict containing the following possible keys:
  • copy_baseline flag
  • reset_work flag
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set ScheduleCreateDict Schedule item_id $ScheduleId; # Schedule Id
2 dict set ScheduleCreateDict Schedule object_type Schedule; # Schedule object type
3 dict set ScheduleCreateDict Schedule object_name $ScheduleName
4 
5 dict set ScheduleCreateDict ScheduleTemplate item_id $ScheduleId; # Schedule template Id
6 dict set ScheduleCreateDict ScheduleTemplate object_type Schedule; # Schedule template object type
7 
8 dict set CopyOptionsDict copy_baseline "0"; # copy baselines also to the new Schedule
9 dict set CopyOptionsDict reset_work "1"; # reset work status of the tasks
10 set Status [::TC11::SCHMGR::createScheduleFromTemplate $ScheduleCreateDict $CopyOptionsDict]
11 puts "::TC11::SCHMGR::createScheduleFromTemplate $Status"

◆ createScheduleNewBaselines()

TC11::SCHMGR::createScheduleNewBaselines   ScheduleBaselineCreateDict  

This function calls the TcSoa based function createScheduleNewBaselines to create a Baseline for a given Schedule in Teamcenter.

Parameters
ScheduleBaselineCreateDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • Baseline item_id: Schedule Baseline item_id
  • Baseline object_type: Schedule Baseline object type (optional, only needed if a customer specific one is used)
  • Baseline object_name: Schedule Baseline object name
  • Baseline isActive: Define Baseline as active (default = 1) or inactive (0)
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set BaselineCreateDict Schedule item_id $ScheduleId; # Schedule Id
2 dict set BaselineCreateDict Schedule object_type Schedule; # Schedule object type
3 
4 dict set BaselineCreateDict Baseline item_id $BaselineScheduleId; # baseline Id
5 dict set BaselineCreateDict Baseline object_type Schedule; # Schedule object type
6 dict set BaselineCreateDict Baseline object_name $BaselineScheduleName
7 dict set BaselineCreateDict Baseline isActive 1;
8 set Status [::TC11::SCHMGR::createScheduleNewBaselines $BaselineCreateDict]
9 puts "::TC11::SCHMGR::createScheduleNewBaselines $Status"

◆ createScheduleProxyTask()

TC11::SCHMGR::createScheduleProxyTask   ScheduleProxyTaskCreateDict  

This function calls the TcSoa based function createScheduleProxyTask to create a Proxy Task in Teamcenter.

Parameters
ScheduleProxyTaskCreateDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id of the schedule were the proxy is being created
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • ReferenceTask item_id: Id of the reference task in the schedule (otional)
  • ReferenceTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task item_id: Task Id of the real task being proxied (otional)
  • Task object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task sublevels: Number of sub-levels (if this should be mirrored in the sub schedules (-1 = all, 0 = only this schedule, 1= first level, 2 = 1st and 2nd level, etc)
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 set Status [::TC11::SCHMGR::createScheduleProxyTask $ScheduleProxyTaskCreateDict]
2 puts "::TC11::SCHMGR::createScheduleProxyTask $Status"

◆ createScheduleTask()

TC11::SCHMGR::createScheduleTask   ScheduleTaskCreateDict  

This function calls the TcSoa based function createScheduleTask to create a Schedule Task in Teamcenter.

Parameters
ScheduleTaskCreateDictDict containing the following possible keys:
  • Schedule id: Schedule Id
  • Schedule id: Schedule object type (optional, only needed if a customer specific one is used)
  • ParentTask item_id: task id of the parent task (optional)
  • ParentTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • PreviousSiblingTask item_id: task id of the previous sibling task (optional)
  • PreviousSiblingTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task item_id: task id (required)
  • Task object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task object_name
  • Task start_date Start date of the Schedule Task (format yyyymmdd hhmmss)
  • Task finish_date Finish date of the Schedule Task (format yyyymmddhhMMss)
  • Task work_estimate
  • Task duration
  • Task constraint Task Constraint with the following possible values:
    • 0: No constraint
    • 1: As Late As Possible
    • 2: As Soon As Possible
    • 3: fixed
  • Task status Task status optional it is possible to specify additional attributes by using the following approach:
  • otherAttributes.String.<attribute_name> for attributes of type String
  • otherAttributes.Integer.<attribute_name> for attributes of type Integer
  • otherAttributes.Double.<attribute_name> for attributes of type Double
  • otherAttributes.Float.<attribute_name> for attributes of type Float
  • otherAttributes.Boolean.<attribute_name> for attributes of type Boolean
  • otherAttributes.Date.<attribute_name> for attributes of type Date
  • otherAttributes.Calendar.<attribute_name> for attributes of type Calendar
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set TaskCreateDict Schedule item_id $ScheduleId
2 dict set TaskCreateDict Schedule object_type Schedule
3 
4 if {[string length $ParentTaskId] > 0} {
5  dict set TaskCreateDict ParentTask item_id $ParentTaskId
6  dict set TaskCreateDict ParentTask object_type ScheduleTask
7 }
8 if {[string length $PreviousTaskId] > 0} {
9  dict set TaskCreateDict PreviousSiblingTask item_id $PreviousTaskId
10  dict set TaskCreateDict PreviousSiblingTask object_type ScheduleTask
11 }
12 
13 dict set TaskCreateDict Task item_id $TaskId
14 dict set TaskCreateDict Task object_type ScheduleTask
15 dict set TaskCreateDict Task object_name $TaskName
16 
17 dict set TaskCreateDict Task start_date $TaskStartDate
18 dict set TaskCreateDict Task finish_date $TaskFinishDate
19 #dict set TaskCreateDict Task work_estimate 4800
20 #dict set TaskCreateDict Task otherAttributes.String.wbs_code xxxxx; #sample for an additional string attribute
21 set Status [::TC11::SCHMGR::createScheduleTask $TaskCreateDict]
22 puts "::TC11::SCHMGR::createScheduleTask $Status"

Referenced by createMilestone().

◆ deleteDependencies()

TC11::SCHMGR::deleteDependencies   DeleteDependenciesDict  

This function calls the TcSoa based function deleteDependencies to delete a dependency between two Task in Teamcenter.

Parameters
DeleteDependenciesDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • PredecessorTask item_id: task id (required)
  • PredecessorTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • SuccessorTask item_id: task id (required)
  • SuccessorTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Dependency dependency_type Task dependency type, with the following possible values:
    • FF: finish->finish
    • FS: finish->start
    • SS: start->start
    • SF: start->finish
  • Dependency lag_time new lag time for the dependency
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set DependencyDeleteDict Schedule item_id $ScheduleId
2 dict set DependencyDeleteDict Schedule object_type Schedule
3 
4 dict set DependencyDeleteDict PredecessorTask item_id $TaskId1
5 dict set DependencyDeleteDict PredecessorTask object_type ScheduleTask
6 
7 dict set DependencyDeleteDict SuccessorTask item_id $TaskId2
8 dict set DependencyDeleteDict SuccessorTask object_type ScheduleTask
9 
10 set Status [::TC11::SCHMGR::deleteDependencies $DependencyDeleteDict]
11 puts "::TC11::SCHMGR::deleteDependencies $Status"

◆ deleteScheduleTask()

TC11::SCHMGR::deleteScheduleTask   ScheduleTaskDeleteDict  

This function calls the TcSoa based function deleteScheduleTaskExecution to delete a given Task in Teamcenter.

Parameters
ScheduleTaskDeleteDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id (required)
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • Task item_id: item_id of the Task to delete (required)
  • Task object_type: ScheduleTask object type of the task to delete (optional, only needed if a customer specific one is used)
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set ScheduleTaskDeleteDict Schedule item_id $ScheduleId
2 dict set ScheduleTaskDeleteDict Schedule object_type Schedule
3 
4 dict set ScheduleTaskDeleteDict Task item_id $ScheduleTaskId
5 dict set ScheduleTaskDeleteDict Task object_type ScheduleTask
6 
7 set Status [::TC11::SCHMGR::deleteScheduleTask $ScheduleTaskDeleteDict]
8 puts "::TC11::SCHMGR::deleteScheduleTask $Status"

◆ detachSchedule()

TC11::SCHMGR::detachSchedule   ScheduleDetachDict  

This function calls the TcSoa based function detachSchedule to detach a given Sub-Schedule from a defined Master-Schedule in Teamcenter.

Parameters
ScheduleDetachDictDict containing the following possible keys:
  • MasterSchedule item_id: Schedule Id (required)
  • MasterSchedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • SubSchedule item_id: Schedule Id (required)
  • SubSchedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set DetachScheduleDict MasterSchedule item_id $MasterScheduleId
2 dict set DetachScheduleDict MasterSchedule object_type Schedule
3 
4 dict set DetachScheduleDict SubSchedule item_id $SubScheduleId
5 dict set DetachScheduleDict SubSchedule object_type Schedule
6 
7 set Status [::TC11::SCHMGR::detachSchedule $DetachScheduleDict]
8 puts "::TC11::SCHMGR::detachSchedule $Status"

◆ insertSchedule()

TC11::SCHMGR::insertSchedule   ScheduleInsertDict  

This function calls the TcSoa based function insertSchedule to insert a given Sub-Schedule into a defined Master-Schedule in Teamcenter.

Parameters
ScheduleInsertDictDict containing the following possible keys:
  • MasterSchedule item_id: Schedule Id (required)
  • MasterSchedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • SubSchedule item_id: item_id of the Schedule that is requested to be inserted in the master Schedule (required)
  • SubSchedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • MasterScheduleTask item_id: item_id of a previous sibling master schedule task (optional)
  • MasterScheduleTask object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • Schedule adjustMasterDates: If true the operation adjusts the start date and the end date of the master Schedule to match the start date and the end date of the sub Schedule. If false (default) the operation does not adjust the dates of the master Schedule
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set InsertScheduleDict MasterSchedule item_id $MasterScheduleId
2 dict set InsertScheduleDict MasterSchedule object_type Schedule
3 
4 dict set InsertScheduleDict SubSchedule item_id $SubScheduleId
5 dict set InsertScheduleDict SubSchedule object_type Schedule
6 
7 dict set InsertScheduleDict MasterScheduleTask item_id $PreviousTaskId
8 dict set InsertScheduleDict MasterScheduleTask object_type Schedule
9 
10 dict set InsertScheduleDict Schedule adjustMasterDates true
11 
12 set Status [::TC11::SCHMGR::insertSchedule $InsertScheduleDict]
13 puts "::TC11::SCHMGR::updateScheduleTaskExecution $Status"

◆ logoutSession()

TC11::SCHMGR::logoutSession   args  

This function calls the TcSoa based function logoutSession to close the connection to the Teamcenter server.

Parameters
argscurrently not in use
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set UpdateScheduleTaskExecutionDict Task item_id $ScheduleId
2 dict set UpdateScheduleTaskExecutionDict Task object_type Schedule
3 dict set UpdateScheduleTaskExecutionDict Task work_complete "60"; # one hour completed
4 dict set UpdateScheduleTaskExecutionDict Task work_remaining "600"; # 10 hour still to do
5 dict set UpdateScheduleTaskExecutionDict Task status "In Work"
6 set Status [::TC11::SCHMGR::updateScheduleTaskExecution $UpdateScheduleTaskExecutionDict]
7 puts "::TC11::SCHMGR::updateScheduleTaskExecution $Status"
9 puts "::TC11::SCHMGR::logoutSession $Status"

◆ moveScheduleTask()

TC11::SCHMGR::moveScheduleTask   ScheduleTaskMoveDict  

This function calls the TcSoa based function moveScheduleTask to move a Schedule Task in the structure of a given schedule in Teamcenter.

Parameters
ScheduleTaskMoveDictDict containing the following possible keys:
  • Schedule id: Schedule Id
  • Schedule id: Schedule object type (optional, only needed if a customer specific one is used)
  • ParentTask item_id: task id of the parent task (optional)
  • ParentTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • PreviousSiblingTask item_id: task id of the previous sibling task (optional)
  • PreviousSiblingTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task item_id: task id (required)
  • Task object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set ScheduleTaskMoveDict Schedule item_id $ScheduleId
2 dict set ScheduleTaskMoveDict Schedule object_type Schedule
3 
4 if {[string length $ParentTaskId] > 0} {
5  dict set ScheduleTaskMoveDict ParentTask item_id $ParentTaskId
6  dict set ScheduleTaskMoveDict ParentTask object_type ScheduleTask
7 }
8 if {[string length $PreviousTaskId] > 0} {
9  dict set ScheduleTaskMoveDict PreviousSiblingTask item_id $PreviousTaskId
10  dict set ScheduleTaskMoveDict PreviousSiblingTask object_type ScheduleTask
11 }
12 
13 dict set ScheduleTaskMoveDict Task item_id $TaskId
14 dict set ScheduleTaskMoveDict Task object_type ScheduleTask
15 set Status [::TC11::SCHMGR::moveScheduleTask $ScheduleTaskMoveDict]
16 puts "::TC11::SCHMGR::moveScheduleTask $Status"

◆ shiftSchedule()

TC11::SCHMGR::shiftSchedule   ScheduleShiftDict  

This function calls the TcSoa based function shiftScheduleNonInteractive to shift a Schedule to a new start or finish date.

Parameters
ScheduleShiftDictDict containing the following possible keys:
  • Schedule id: Schedule Id
  • Schedule id: Schedule object type (optional, only needed if a customer specific one is used)
  • Schedule shift_date: shift date of the Schedule to this value (format yyyymmddhhMMss)
  • Schedule new_finish: Is the newDate a new finish date? 1 if it is a new finish date. 0 if it is a new start date.
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 # in this example a new start date (2015-02-02 12:00:00) of the schedule is defined
2 dict set ScheduleShiftDict Schedule id $ScheduleId; # Schedule Id
3 dict set ScheduleShiftDict Schedule object_type Schedule; # Schedule object type
4 dict set ScheduleShiftDict Schedule shift_date $ShiftDate
5 dict set ScheduleShiftDict Schedule new_finish 0
6 set Status [::TC11::SCHMGR::shiftSchedule $ScheduleShiftDict]
7 puts "::TC11::SCHMGR::shiftSchedule $Status"

◆ updateDependencies()

TC11::SCHMGR::updateDependencies   UpdateDependenciesDict  

This function calls the TcSoa based function updateDependencies to update a dependency between two Task in Teamcenter.

Parameters
UpdateDependenciesDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • PredecessorTask item_id: task id (required)
  • PredecessorTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • SuccessorTask item_id: task id (required)
  • SuccessorTask object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Dependency dependency_type Task dependency type, with the following possible values:
    • FF: finish->finish
    • FS: finish->start
    • SS: start->start
    • SF: start->finish
  • Dependency lag_time new lag time for the dependency
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set DependencyUpdateDict Schedule item_id $ScheduleId
2 dict set DependencyUpdateDict Schedule object_type Schedule
3 
4 dict set DependencyUpdateDict PredecessorTask item_id $TaskId1
5 dict set DependencyUpdateDict PredecessorTask object_type ScheduleTask
6 
7 dict set DependencyUpdateDict SuccessorTask item_id $TaskId2
8 dict set DependencyUpdateDict SuccessorTask object_type ScheduleTask
9 
10 dict set DependencyUpdateDict Dependency dependency_type "SS"
11 dict set DependencyUpdateDict Dependency lag_time ScheduleTask
12 
13 set Status [::TC11::SCHMGR::updateDependencies $DependencyUpdateDict]
14 puts "::TC11::SCHMGR::updateDependencies $Status"

◆ updateSchedule()

TC11::SCHMGR::updateSchedule   ScheduleUpdateDict  

This function calls the TcSoa based function updateSchedule to update the corresponding Schedule in Teamcenter.

Parameters
ScheduleUpdateDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id of the schedule were the proxy is being created
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • Schedule object_name: Schedule name
  • Schedule start_date: Start date of the Schedule (format yyyymmddhhMMss)
  • Schedule finish_date: Finish date of the Schedule (format yyyymmddhhMMss)
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set ScheduleUpdateDict Schedule item_id $ScheduleId; # Schedule Id
2 dict set ScheduleUpdateDict Schedule object_type Schedule; # Schedule object type
3 dict set ScheduleUpdateDict Schedule object_name $ScheduleName
4 dict set ScheduleUpdateDict Schedule start_date $StartDate
5 dict set ScheduleUpdateDict Schedule finish_date $FinishDate
6 
7 set Status [::TC11::SCHMGR::updateSchedule $ScheduleUpdateDict]
8 puts "::TC11::SCHMGR::updateSchedule $Status"

◆ updateScheduleObject()

TC11::SCHMGR::updateScheduleObject   UpdateObjectAttributesDict  

This function calls the TcSoa based function updateScheduleObject to update a given Schedule object in Teamcenter.

Parameters
UpdateObjectAttributesDictDict containing the following possible keys:
  • item_id: Schedule Id, this represents the schedule for the new membership.
  • object_type: Schedule object type (optional, only needed if a customer specific one is used) Only those keys are used during the update that are specified all other informations will be untouched, any other key will be ignored.
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set UpdateObjectAttributesDict item_id $ScheduleId
2 dict set UpdateObjectAttributesDict object_type ScheduleTask
3 dict set UpdateObjectAttributesDict z9Attribute My Value
4 set Status [::TC11::SCHMGR::updateScheduleObject $UpdateObjectAttributesDict]
5 puts "::TC11::SCHMGR::updateScheduleObject $Status"

◆ updateScheduleTask()

TC11::SCHMGR::updateScheduleTask   ScheduleTaskUpdateDict  

This function calls the TcSoa based function updateScheduleTask to update a given Task in Teamcenter.

Parameters
ScheduleTaskUpdateDictDict containing the following possible keys:
  • Schedule item_id: Schedule Id (required)
  • Schedule object_type: Schedule object type (optional, only needed if a customer specific one is used)
  • Task item_id: task id (required)
  • Task object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task object_name
  • Task start_date Start date of the Schedule Task (format yyyymmdd hhmmss)
  • Task finish_date Finish date of the Schedule Task (format yyyymmddhhMMss)
  • Task work_estimate
  • Task constraint Task Constraint with the following possible values:
    • 0: No constraint
    • 1: As Late As Possible
    • 2: As Soon As Possible
    • 3: fixed
  • Task status Task status optional it is possible to specify additional attributes by using the following approach:
  • otherAttributes.String.<attribute_name> for attributes of type String
  • otherAttributes.Integer.<attribute_name> for attributes of type Integer
  • otherAttributes.Double.<attribute_name> for attributes of type Double
  • otherAttributes.Float.<attribute_name> for attributes of type Float
  • otherAttributes.Boolean.<attribute_name> for attributes of type Boolean
  • otherAttributes.Date.<attribute_name> for attributes of type Date
  • otherAttributes.Calendar.<attribute_name> for attributes of type Calendar
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set UpdateScheduleTaskDict Schedule item_id $ScheduleId
2 dict set UpdateScheduleTaskDict Schedule object_type Schedule
3 
4 dict set UpdateScheduleTaskDict Task item_id $TaskId
5 dict set UpdateScheduleTaskDict Task object_type ScheduleTask
6 dict set UpdateScheduleTaskDict Task object_name $TaskName
7 
8 dict set UpdateScheduleTaskDict Task start_date $NewTaskStartDate
9 dict set UpdateScheduleTaskDict Task finish_date $NewTaskFinishDate
10 dict set UpdateScheduleTaskDict Task work_estimate 4800
11 dict set UpdateScheduleTaskDict Task constraint 0
12 #dict set UpdateScheduleTaskDict Task otherAttributes.String.wbs_code xxxxx; #sample for an additional string attribute
13 set Status [::TC11::SCHMGR::updateScheduleTask $ScheduleTaskUpdateDict]
14 puts "::TC11::SCHMGR::updateScheduleTask $Status"

◆ updateScheduleTaskExecution()

TC11::SCHMGR::updateScheduleTaskExecution   UpdateScheduleTaskExecutionDict  

This function calls the TcSoa based function updateScheduleTaskExecution to update a given Task in Teamcenter.

Parameters
UpdateScheduleTaskExecutionDictDict containing the following possible keys:
  • Task item_id: task id
  • Task object_type: ScheduleTask object type (optional, only needed if a customer specific one is used)
  • Task work_complete: Work complete time in minutes
  • Task work_remaining: Work remaining time in minutes
  • Task percent_complete: Work completed in percent
  • Task status: Task status string defined in the corresponding Lov definition (OOTB list: "not_started", "in_progress", "needs_attention", "late", "complete", "abandoned" and "aborted")
  • Task actual_start_date: New actual start date (format yyyymmddhhMMss)
  • Task actual_finish_date: New actual finish date (format yyyymmddhhMMss) Only those keys are used during the update that are specified all other informations will be untouched, any other key will be ignored.
Returns
OK or list of ERROR with Java stack trace

Sample code sequence

1 dict set UpdateScheduleTaskExecutionDict Task item_id $ScheduleId
2 dict set UpdateScheduleTaskExecutionDict Task object_type Schedule
3 dict set UpdateScheduleTaskExecutionDict Task work_complete "60"; # one hour completed
4 dict set UpdateScheduleTaskExecutionDict Task work_remaining "600"; # 10 hour still to do
5 dict set UpdateScheduleTaskExecutionDict Task status "In Work"
6 set Status [::TC11::SCHMGR::updateScheduleTaskExecution $UpdateScheduleTaskExecutionDict]
7 puts "::TC11::SCHMGR::updateScheduleTaskExecution $Status"