extractEmployeePeriodShiftTransactionsByFilekey() 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

  • Extracts an employee’s punch transactions for a selected pay period

Syntax

  • AeShiftTransactionAry = AeXMLBridge.extractEmployeePeriodShiftTransactionsByFilekey(Filekey, PayPeriodEnum, PayLineStateEnum, CalcedDataTypeEnum, ShiftPosIndex);

Parameters

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
int filekey = 1234;                                               
// using employee# 1234
 
TPayPeriodEnum payPeriod = TPayPeriodEnum.ppeCurrent;                      
// lets use the current pay period

TPayLineStateEnum pl = TPayLineStateEnum.plsAsSaved;
TCalcedDataTypeEnum calced = TCalcedDataTypeENum.cdtNormal;
 
int shift = 1;                                                             
// 0 = in punches, 1= out punches, -1 = both
 
try
{
   TAeShiftTransaction[] trans = ws.extractEmployeePeriodShiftTransactionsByFilekey(filekey, payPeriod, pl, calced, shift);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Sample Code

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Dim filekey As Integer = 1234
' using employee# 1234
 
Dim payPeriod As TPayPeriodEnum = TPayPeriodEnum.ppeCurrent
' lets use the current pay period
 
Dim pl As TPayLineStateEnum = TPayLineStateEnum.plsAsSaved
Dim calced As TCalcedDataTypeEnum = TCalcedDataTypeENum.cdtNormal
 
Dim shift As Integer = 1
' 0 = in punches, 1= out punches, -1 = both
 
Try
    Dim trans As TAeShiftTransaction() = ws.extractEmployeePeriodShiftTransactionsByFilekey(filekey, payPeriod, pl, calced, shift)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • In the Parameters, ShiftPosInd represents the in or out punch of the shift. 0 = in punch, 1 = out punch
  • Setting ShiftPosInd to -1 will return both in and out punches

Possible Errors

  • Unable to locate employee with filekey

Preferred Method

extractEmployeePeriodShiftTransactionsByIDNum

extractAttendanceMultiFormActivityUsingHyperQuery
extractEmployeeDailySummsByIDNum
extractEmployeeDailySummsInPeriodByIDNum
extractEmployeeDurationTotalsByIDNum
extractEmployeeEditsByIDNum
extractEmployeePeriodFrameByIDNum
extractEmployeePeriodShiftDetailsByIDNum
extractEmployeePeriodShiftsByIDNum
extractEmployeePeriodSummsByIDNum
extractEmployeeSummsByIDNum
extractEmployeeTransactionsByIDNum
extractPayPeriodSummaries
extractRangedTransactionsUsingHyperQuery
getManuallySelectedCalculatedData

Back to Top