getManuallySelectedCalculatedData 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

  • Returns a text string organized in a logical X-Y (spreadsheet) format containing lists of employees and their summary hours across a defined period

Syntax

  • AeExchangeStruct = AeXMLBridge.getManuallySelectedCalculatedData(AeExchangeStruct);

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
TAeExchangeStruct input = new TAeExchangeStruct();
 
input.FieldSep = "{fs}";
input.LineSep = "{ls}";
 
string rawData = string.Empty;
 
rawData = "hyperquery" + input.FieldSep + "All Employees" + input.LineSep;     // using "All Employees" hyperquery
rawData += "payperiod" + input.FieldSep + "current" + input.LineSep;           // using current payperiod
rawData += "calculation" + input.FieldSep + "assaved" + input.LineSep;         // using calculations as saved
rawData += "noactivity" + input.FieldSep + "include";                          // include those with no activity
 
input.RawData = rawData;
 
try {
   TAeExchangeStruct output = ws.getManuallySelectedCalculatedData(input);
}
catch (Exception ex) {
   MessageBox.Show(ex.Message);
}

Remarks

  • getManuallySelectedCalculatedData() is designed to accept a series of text commands, each identifying a set of parameters defining the range and type of summary employee data to extract from the system. One or more commands may be uploaded in a single call. These commands are passed using the structure defined in the TAeExchangeStruct definition. For visual clarity, they are rendered as field,field[cr,lf] within these pages. These commands are not case sensitive. Please see TAeExchangeStruct for packaging up this data and un-packaging return data.
  • Sample - Extracted Calculated Summaries for Employee “010015”
  • daterange,custom,11/5/2005,11/11/2005 NOTE: custom dates must be within the range of previous to next periods
  • calculation, assaved
  • noactivity,skip
  • dataset,duration
  • empID,010015
Field Command Description and Optional Values
Payperiod,[period designator] payperiod,previous or payperiod,current

If this line is absent, previous period is assumed
Daterange,[period designator] daterange,previous or daterange,current, or daterange,custom,01/01/0000,01/02/0000

If this line is absent, previous period is assumed
Calculation,[calculation state] calculation, assaved or calculation,recomputed

If this line is absent, assaved is assumed. Note: calculation,recomputed is only available when payroll is used below
Noactivity, [no activity option] noactivity,skip or noactivity,include

Determines if employees without any data should be included in output. Include = include employees with no data; Skip = skip employee with no data

If this line is absent, skip is assumed. Note: noactivity,include is only available when payroll is used below
Payperiodclass,[pay period class num] Payperiodclass,1

Defines the group within ToD that is usually associated with a pay group in P4W.
Dataset,[data set type] Dataset,payroll or dataset,daily or dataset,duration

Payroll is valid for only current and previous periods. Valid when using payroll command below. Does not permit custom date ranges.

Daily is valid for all types of periods. Returns a row of employee calculated data for each day. Returns only employees with results. Returns only last saved data.’

Duration is valid for all types of period. Returns summary rows of calculated employee data over defined period. Returns only employees with results. Returns only last saved data.
Detailset,[detail definition] Detailset, detail (default); detailset,paydes; detailset,pdwg; detailset,wg; detailset,pdrate

Note: This switch applies only when extracting employee duration totals (DATASET,DURATION)

Employee duration summaries will be consolidated to the level of resolution defined by this parameter.

Detail: This is the default value and the system will assume this value is implied when absent. Employee summary totals are supplied for all levels (Pay Designation, Rate of Pay, Worked Workgroup)

Paydes: Employee summary totals are supplied only for Pay Designation and Workgroup summaries (additional lines for changes in employee worked rates are ignored)

Pdwg: Employee summary totals are suplied only for Pay Designation and Workgroup summaries (additional lines for changes in employee worked rates are ignored)

WG: Employee summary totals are supplied only Workgroup summaries (additional lines for changes in employee pay designations and worked rates are ignored)

Pdrate: Employee summary totals are supplied by Pay Designation and Worked Rate (additional lines for changes in employee worked rates are included)

Please see Employee Pay Lines and Detailset Descriptions
Mappingset.[map set name or name of vendor operation],autodetailset mappingset,[name],autodetailset

[name] must be valid global mapping set or the name of a known Vendor Operation within ToD. If no mapping set name is provided, the system will attempt to extract a mapping set from the 1st available Vendor Operation.

When a mapping set is used, all returned calculated employee data is grouped and summarized by the pay designation mapping rules defined in the mapping set

The effect of using mapping sets are:
*Employee totals (hours and dollars) are consolidated into groups defined within the mapping set

Additional fields are returned within the results. These fields include:

Group Label

GroupTag1

GroupTag2

GroupTag3

GroupRateTag (currently unused)

GroupShiftTag (currently unused)

The GroupLabel field will return the group definition identifier defined in the mapping set

0) Regular Hours

1) Overtime Hours

2) Earnings 1

3) Earnings 2

4) Coded Hours

The Group Tag 1, Tag 2 and Tag 3 fields will contain the identifiers defined in the mapping set by the installation technician. Typically these contain the ‘S’, ‘V’, ‘P’ values (Sick, Vacation, Personal)

AUTODETAILSET

The third value, autodetailset is optional. If present, the system will use the properties located within the mapping set to automatically set the detailset value. Values within the selected Mapping Set will determine how the detailset value is configured.

Note: Passing a detailset command on a line after the mappingset command will override the effect of the autodetailset.
Firstrowinfo When present before any commands that begin to return employee pay lines, this command indicates to the system that for the 1st row of data returned, include a row containing information about the current request session.

The structure of the returned data (in the first row) is:

FIRSTROWINFO,DETAILSET:DEFAULT,DATASET:DAILY,MAPPINGSETSIZE:0

The DETAILSET value will indicate which DETAILSET mode was used. This is helpful when using the AUTODETAILSET switch that is part of the MAPPINGSET command when requesting a Pay Designation Mapping Set. See Detailset Descriptions

The DATASET will indicate the data set used

The MAPPINGSETSIZE will indicate the number of Pay Designation Mappings contained within the selected Pay Designation Mapping Set. If the value is zero, no mapping has been selected.
empid,[emp id] empid,A123

Select a single, or multiple single employees
Payroll Payroll

Select all employees within the scope defined above. Used to initiate dataset,payroll (as defined) above.
Hyperquery,[hyper query name] Hyperquery,My Employees

Select and return calculated data for all employees within the defined HyperQuery
HUNDPRECISION,[2, 4] For decimal precision of hours hundreths. Default is 2. This parameter is automatically supplied in a vendor operation is specified and the vendor operation already specifies this parameter.

NOTE: Working with time as represented in hundredeths of an hour is never as precise as working with time represented by minutes
EVENTLOG,[severity],[message] EVENTLOG, NORMAL, Log This Message For Me

Logs [message] into the Attendance on Demand Event Log. Severity options are:

NORMAL,WARNING,ERROR
SIMVENDOR,INCLUDE This switch can be used only under unique circumstances and only when using Paycor Vendor Operations

If MAPPINGSET is used (prior to this switch) with a valid Paycor Vendor Operation, Attendance on Demand Event will attach two additional rows to the output of this API call

SIMVENDOR,ASCIIFILE,[hex stream of simulated paycor payroll file]

SIMVENDOR,REPORT,[hex stream of simulated paycor payroll file report in PDF]
VENDOROPSEL,LEGACY This switch can be used only under unique circumstances and only when using Paycor Vendor Operations

If MAPPINGSET is used (prior to this switch) with a valid Paycor Vendor Operation, Attendance on Demand Event will use the properties of the Vendor Operation to determine the list of employees to return

This input value can be used instead of the other inout values offered to define a set of employees: (EMPID, PAYROLL, HYPERQUERY)

The Attendance on Demand Event Web Services will look into the properties of the Paycor Vendor Operation and determine if the Vendor Operation is using HyperQueries. If HyperQueries are used, the employees returned will be defined by the Vendor Operation HyperQuery. Otherwise, the normal employee eligibility list PAYROLL for the PAYPERIODCLASS defined in the Vendor Operation is used.

This is a convenience switch in that it switches the employee eligibility list automatically between PAYROLL and HYPERQUERY based upon the current settings within the Vendor Operation defined in the MAPPINGSET input parameter.
Examples Description
ayperiod,previous
calculation,assaved
noactivity,skip
payperiodclass,1
payroll,		 Extract all payroll employee summaries for previous pay period, use last saved data, skip employees with no hours/dollars for employee assigned to pay period class #1
payperiod,previous
calculation,recompute
noactivity,include
payperiodclass,1
payroll,		 Extract all employee summaries for previous pay period, recomputed all employees prior to returning data (lengthy operation), include employees even if employee has no hours/dollars to return for employees assigned to pay period class #1
payperiod,previous
calculation,assaved
noactivity,include
empid,A123
empid,B456
empid,C789		 Extract all payroll employee summaries for previous pay period, use last saved data, include employees with no hours/dollars for the three employees whose ID’s are A123, B456, C789
daterange,custom,11/5/2005,11/11/2005
calculation,assaved
dataset,duration
mappingset,Paycor Standard
empid,A123
empid,B456
empid,C789		 Extract all employee summaries for custom date range, use last saved data, use mapping set defined as “Paycor Standard” for the three employees whose ID’s are A123, B456, C789
DATERANGE,CUSTOM,07/29/2010,08/04/2010
FIRSTROWINFO
MAPPINGSET,Paycor,AUTODETAILSET
NOACTIVITY,SKIP
SIMVENDOR,INCLUDE
EVENTLOG,NORMAL,Extract Payroll
DATASET,duration
VNEDOROPSEL,LEGACY		 Extract all employee summaries for custom date range, use last saved data, use mapping set defined as “Paycor Standard” for the employees defined by the Vendor Operation called “Paycor Standard”. A message is appended to the Attendance on Demand Event Log (Extract Payroll).

Examples

Sample showing custom date ranges and request for employee data for employees that do not exist in the Attendance on Demand system:

  • daterange,custom,11/5/2005,11/11/2005
  • calculation,asasved
  • dataset,duration
  • mappingset,Paycor Extended
  • empid,000012
  • empid,000010
  • empid, 123

Output

  • ERROR,000012,Unable to locate employee with identifier 000012
  • ERROR,000010,Unable to locate employee with identifier 000010
  • PAYLINE,123,Castelberg John,000000000 ,113,13,0,1985-11-25 00:00:00.000,Nashville-TRANS-S1,1,11,1,0,0,0,0,16.3500,1899/12/30,1,Regular,2430,40.50,16.3500, 662.1750,Nashville-TRANS-S1,0,0,0,0,0,0,0,0,,,,0.0000,0

Sample showing custom date ranges and request for employee data for employees defined by HyperQuery list and a single selected employee:

  • daterange,custom,11/5/2005,11/11/2005
  • calculation,assaved
  • dataset,duration
  • mappingset,Paycor Extended
  • empid, 123
  • hyperquery,All employees

Output (trimmed)

  • PAYLINE,123,Castelberg John,000000000 ,113,13,0,1985-11-25 00:00:00.000,Nashville-TRANS-S1,1,11,1,0,0,0,0,16.3500,1899/12/30,1,Regular,2430,40.50,16.3500, 662.1750,Nashville-TRANS-S1,0,0,0,0,0,0,0,0,,,,0.0000,0
  • PAYLINE,010015,Adams Kathy,123123123 ,178,1,0,1989-10-05 00:00:00.000,Nashville-CASHIER-S2,1,17,2,0,0,0,0,18.2500,1899/12/30,1,Regular,1995,33.25,18.2500,606.8125,Nashville-CASHIER-S2,0,0,0,0,0,0,0,0,,,,0.0000,0
  • PAYLINE,010015,Adams Kathy,123123123 ,178,1,0,1989-10-05 00:00:00.000,Nashville-CASHIER-S2,1,17,2,0,0,0,0,18.2500,1899/12/30,11,Bonus,0,0.00,0.0000,23.0000, Nashville-CASHIER-S2,0,0,0,0,0,0,0,2,DOL,,,0.0000,0

Calculated Fields Returned

Field Comments
Entity Field describing the data returned. Currently only PAYLINE is returned
Employee ID
Employee Name
SSN/SIN
Badge
Filekey
ActiveStatus
Date of Hire
WG Descr Contains OrgUID of home workgroup if mapping is known to system
Home WG1
Home WG2
Home WG3
Home WG4
Home WG5
Home WG6
Home WG7
Base Rate
Date Valid only when requesting data using dataset,daily
Pay Des Num
Pay Des Name
Hours (in minutes) Summary Hours (represented in number of minutes); When using a mapping set, these hours are summaries by mapping set group definition
HoursHund Summary Hours (represented in hours decimal); When using a mapping set, these hours are summaries by mapping set group definition
Work Rate
Dollars Summary Dollars; When using a mapping set, these hours are summaries by mapping set group definition
Worked WG Descr Contains OrgUID of worked workgroup if mapping is known to system
Worked WG 1
Worked WG 2
Worked WG 3
Worked WG 4
Worked WG 5
Worked WG 6
Worked WG 7
Group Label Note: If mapping is defined, these remaining fields are populated
Group Tag 1
Group Tag 2
Group Tag 3
Group Rate Tag
Group Shift Tag
GroupWGDescr

getManuallySelectedSetupData
setManuallySelectedEmployeeData
setManuallySelectedSetupData

Back to Top