extractRangedTransactionsUsingHyperQuery 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

  • Extracts a list of transactions(punches) in a selected date range for a list of employees defined by the HyperQuery used

Syntax

  • AeEmpTransactionAry = AeXMLBridge.extractRangedTransactionsUsingHyperQuery(HyperQueryName, DateRangeEnum, MinDate, MaxDate);

Parameters

  • String - HyperQuery name
  • Enumeration - TDateRangeEnum
  • 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
18
string[] queries = ws.getHyperQueriesSimple();                             
// retrieves a list of hyper query names
 
TDateRangeEnum dateRange = TDateRangeEnum.drLastWeek;                      
// we want transactions from last week
 
string beginDate = string.Empty;                                          
string endDate = string.Empty;                                             
// since we are not using the TDateRangeEnum value of drCustom, we set the dates to empty
 
try
{
   TAeEmpTransaction[] transactions = ws.extractRangedTransactionsUsingHyperQuery(queries[0], dateRange, beginDate, endDate);
}
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
Dim queries As String() = ws.getHyperQueriesSimple()
' retrieves a list of hyper query names
 
Dim dateRange As TDateRangeEnum = TDateRangeEnum.drLastWeek
' we want transactions from last week
 
Dim beginDate As String = String.Empty
' since we are not using the TDateRangeEnum value of drCustom, we set the begin and end date parameters to empty
Dim endDate As String = String.Empty
 
Try
    Dim transactions As TAeEmpTransaction() = ws.extractRangedTransactionsUsingHyperQuery(queries(0), dateRange, beginDate, endDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • Use the getHyperQueriesSimple method to retrieve a list of accpeted HyperQueryName values
  • When using the drCustom value of TDateRangeEnum, you must select the date parameter values. Otherwise, set to empty/null
  • Only transactions in the Current and Previous periods are eligible to be returned.

Possible Errors

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

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

Back to Top