appendEmployeeSchedule2ByFilekey() Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Possible Errors
  8. Preferred Method
  9. Related Methods

Function

  • Adds a schedule for a specific employee

Syntax

  • AeXMLBridge.appendEmployeeScheduleByFilekey(Filekey, AeSchedule2);

Parameters

Return Value

  • None

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

int filekey = 1234;                                                        
// we will append to employee# 1234
  
TAeSchedule2 sched2 = new TAeSchedule2();
  
sched2.BenefitID = 0;                                                      
// since we are appending a Pay Designation schedule we set BenefitID = 0
  
TAeBasicDataItem[] payDes = ws.getPayDesignationsSimple();                 
// retrieve a list of Pay Designation Codes
sched2.PayDesID = payDes[0].Num;
  
sched2.SchDate = DateTime.Now.AddDays(7).ToString("yyyy-MM-dd");           
// append to 7 days in advance

sched2.SchEndTime = "22:00";
sched2.SchHours = 180;                                                     
// 3 hours = 180 minutes
sched2.SchHoursHund = 3.0;                                                 
// convert SchHours to numeric hours representation
sched2.SchPattID = 0;
sched2.SchRate = 12.50;                                                    
// set rate to 12.50 for this schedule
sched2.SchStartTime = "19:00";
sched2.SchStyle = 0;
sched2.SchType = TSchTypeEnum.steNormal;                                   
// type of schedule we are following
  
TAeEmployeeBasic emp = ws.getEmployeeBasicByFilekey(filekey);              
// get Employee Basic information so we can use employee's workgroup

sched2.SchWG1 = emp.WG1;
sched2.SchWG2 = emp.WG2;
sched2.SchWG3 = emp.WG3;
  
try
{
    ws.appendEmployeeSchedule2ByFilekey(filekey, sched2);
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

Dim filekey As Integer = 1234
' we will append to employee# 1234
  
Dim sched2 As New TAeSchedule2()
 sched2.BenefitID = 0
' since we are appending a Pay Designation schedule we set BenefitID = 0
  
Dim payDes As TAeBasicDataItem() = ws.getPayDesignationsSimple()
' retrieve a list of Pay Designation Codes
 sched2.PayDesID = payDes(0).Num
  
 sched2.SchDate = DateTime.Now.AddDays(7).ToString("yyyy-MM-dd")
' append to 7 days in advance
  
 sched2.SchEndTime = "22:00"
 sched2.SchHours = 180
' 3 hours = 180 minutes
  
 sched2.SchHoursHund = 3.0
' convert SchHours to numeric hours representation
  
 sched2.SchPattID = 0
 sched2.SchRate = 12.5
' set rate to 12.50 for this schedule
  
 sched2.SchStartTime = "19:00"
 sched2.SchStyle = 0
 sched2.SchType = TSchTypeEnum.steNormal
' type of schedule we are following
  
Dim emp As TAeEmployeeBasic = ws.getEmployeeBasicByFilekey(filekey)
' get Employee Basic information so we can use employee's workgroup
  
 sched2.SchWG1 = emp.WG1
 sched2.SchWG2 = emp.WG2
 sched2.SchWG3 = emp.WG3
  
Try
     ws.appendEmployeeSchedule2ByFilekey(filekey, sched2)
Catch ex As Exception
     MessageBox.Show(ex.Message)
End Try

Remarks

Possible Errors

  • Duplicate transaction
  • yyyy-mm-dd is required [Date supplied in invalid format]
  • No such employee with Filekey

Preferred Method

appendEmployeeSchedule2ByIDNum

extractEmployeePeriodShiftSchedulesByIDNum
extractEmployeeSchedules2ByIDNum
extractRangedSchedules2UsingHyperQuery
removeEmployeeScheduleByUniqueID
removeEmployeeSchedulesInRangeByIDNum

Back to Top