extractEmployeePeriodShiftDetailsByFilekey() 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 shift details for a selected pay period

Syntax

• AeShiftLineDetailAry = AeXMLBridge.extractEmployeePeriodShiftDetailsByFilekey(Filekey, PayPeriodEnum, PayLineStateEnum, CalcedDataTypeEnum);

Parameters

• Integer - employee filekey
• Enumeration - TPayPeriodEnum
• Enumeration - TPayLineStateEnum
• Enumeration - TCalcedDataTypeEnum

Return Value

• Returns an array of TAeShiftLineDetail structures.

Sample Code

C#

int filekey = 1234;                                                    
// using employee# 1234
 
TPayPeriodEnum period = TPayPeriodEnum.ppeCurrent;                         
// selecting current pay period
 
TPayLineStateEnum plState = TPayLineStateEnum.plsCalculated;             
TCalcedDataTypeEnum calced = TCalcedDataTypeEnum.cdtNormal;
 
try
{
   TAeShiftLineDetail[] details = ws.extractEmployeePeriodShiftDetailsByFilekey(filekey, period, plState, calced);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Sample Code VB.Net

Dim filekey As Integer = 1234
' using employee# 1234
 
Dim period As TPayPeriodEnum = TPayPeriodEnum.ppeCurrent
' selecting current pay period
 
Dim plState As TPayLineStateEnum = TPayLineStateEnum.plsCalculated
' default settings
Dim calced As TCalcedDataTypeEnum = TCalcedDataTypeEnum.cdtNormal
 
Try
    Dim details As TAeShiftLineDetail() = ws.extractEmployeePeriodShiftDetailsByFilekey(filekey, period, plState, calced)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

• When using plsAsSaved for TPayLineStateEnum, cdtNormal for TCalcedDataTypeEnum is always assumed.

Possible Errors

• Unable to locate employee with filekey

Preferred Method

extractEmployeePeriodShiftDetailsByIDNum

Related Methods

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

Back to Top