appendEmployeeScheduleByFilekey() 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. Alternate Method
10. Related Methods

Function

• Add a schedule for a specific employee

Syntax

• AeXMLBridge.appendEmployeeScheduleByFilekey(Filekey, AeSchedule);

Parameters

• Integer - employee filekey
• Structure - TAeSchedule

Return Value

• None

Sample Code

C#

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

sched.SchEndTime = "22:30";
sched.SchHours = 210;                                                      
// 3 1/2 hours = 210 minutes

sched.SchHoursHund = 3.5;                                                 
// numerical representation of hours

sched.PattID = 0;
sched.SchRate = 15.00;                                                    
// set rate for this schedule to $15

sched.SchStartTime = "19:00";
sched.SchStyle = 0;
sched.SchType = TSchTypeEnum.steNormal;
  
TAeEmployeeBasic emp = ws.getEmployeeBasicByFilekey(filekey);              
// retrieve employee basic information so we can use their workgroups

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

VB.Net

Dim filekey As Integer = 1234
' we will append to employee# 1234
  
Dim sched As New TAeSchedule()
 sched.BenefitID = 0
' set BenefitID = 0 since we are appending a Pay Designation schedule
  
Dim payDes As TAeBasicDataItem() = ws.getPayDesignationsSimple()
' retrieve a list of Pay Designation Codes
 sched.PayDesID = payDes(0).Num
  
 sched.SchDate = DateTime.Now.AddDays(7).ToString("yyyy-MM-dd")
' set schedule date to 7 days from now
  
 sched.SchEndTime = "22:30"
 sched.SchHours = 210
' 3 1/2 hours = 210 minutes
  
 sched.SchHoursHund = 3.5
' numerical representation of hours
  
 sched.PattID = 0
 sched.SchRate = 15.0
' set rate for this schedule to $15
  
 sched.SchStartTime = "19:00"
 sched.SchStyle = 0
 sched.SchType = TSchTypeEnum.steNormal
  
Dim emp As TAeEmployeeBasic = ws.getEmployeeBasicByFilekey(filekey)
' retrieve employee basic information so we can use their workgroups
  
 sched.SchWG1 = emp.WG1
 sched.SchWG2 = emp.WG2
 sched.SchWG3 = emp.WG3
  
Try
     ws.appendEmployeeScheduleByFilekey(filekey, sched)
Catch
     MessageBox.Show(ex.Message)
End Try

Remarks

• Use getBenefitsSimple to retrieve a list of Benefit ID’s if needed
• Use getPayDesignationsSimple to retrieve a list of Pay Designation ID’s if needed
• Use getSchedulePatternsSimple to retrieve a list of Schedule Pattern ID’s if needed
• Use getScheduleStylesSimple to retrieve a list of Schedule Styles if needed
• SchHours field contains the number of hours in minutes (hours * 60)

Possible Errors

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

Preferred Method

appendEmployeeSchedule2ByIDNum

Alternate Method

appendEmployeeScheduleByIDNum

Related Methods

extractEmployeePeriodShiftSchedulesByIDNum
extractEmployeeSchedules2ByIDNum
extractRangedSchedules2UsingHyperQuery
removeEmployeeScheduleByUniqueID
removeEmployeeSchedulesInRangeByIDNum

Back to Top