extractAttendanceMultiFormActivityUsingHyperQuery() Method

Table of Contents

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

Function

  • Retrieves an archive of timecard data for employees contained in the specified Hyperquery

Syntax

  • AeMultiFormAry := AeXMLBridge.extractAttendanceMultiFormActivityUsingHyperQuery(HyperQueryName, DateRangeEnum, MinDate, MaxDate);

Parameters

  • string – Hyperquery name
  • Enumeration – TRTOFilterEnum
  • string – begin date (yyyy-MM-dd format)
  • string – end date (yyyy-MM-dd format)

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
string startDate = DateTime.Now.AddDays(-30).ToString(“yyyy-MM-dd”);   
string endDate = DateTime.Now.ToString(“yyyy-MM-dd”);         
// looking at the past 30 days

TDateRangeEnum dre = TDateRangeEnum.drCustom;
// set to drCustom since we are using our own dates

string[] hyperQueries = ws.getHyperQueriesSimple();
 
try
{
   TAeMultiForm[] multiForms = ws.extractAttendanceMultiFormActivityUsingHyperQuery(hyperQueries[0], dre, startDate, endDate);
}
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

Dim startDate As String = DateTime.Now.AddDays(-30).ToString("yyyy-MM-dd")
Dim endDate As String = DateTime.Now.ToString("yyyy-MM-dd")
'  looking at the past 30 days
   
Dim dre As TDateRangeEnum = TDateRangeEnum.drCustom
' set to drCustom since we are using custom dates

Dim hyperQueries As String() = ws.getHyperQueriesSimple()
' look at list of hyper querys

Try
    Dim multiForms As TAeMultiForm() = ws.extractAttendanceMultiFormActivityUsingHyperQuery(hyperQueries(0), dre, startDate, endDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • you can use getHyperQueriesSimple method to retrieve a list of valid HyperQueryName values if needed
  • if TDateRangeEnum is set to drCustom you need to set the begin and end date range; otherwise set both to nothing

Possible Errors

  • Hyper Query does not exist
  • yyyy-MM-dd is required [Date supplied in invalid format]

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