getManuallySelectedSetupData() Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Available Upload Commands
  8. Additional Information
  9. Possible Errors
  10. Related Methods

Function

  • Returns configured setup data in a customized set of lists

Syntax

  • AeExchangeStruct = AeXMLBridge.getManuallySelectedSetupData(AeExchangeStruct)

Parameters

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
TAeExchangeStruct input = new TAeExchangeStruct();
 input.FieldSep = "{fs}";
 input.LineSep = "{ls}";
 input.RawData = "REASONCODES" + input.LineSep + "HYPERQUERIES" + input.LineSep;
// we want to look at all the Reason Codes and HyperQuery values
  
try
 {
     TAeExchangeStruct output = AeXMLBridge.getManuallySelectedSetupData(input);
 }
catch (Exception ex)
 {
     MessageBox.Show(ex.Message);
 }

VB.Net

1
2
3
4
5
6
7
8
9
10
11
Dim input As New TAeExchangeStruct()
input.FieldSep = "{fs}"
input.LineSep = "{ls}"
input.RawData = "REASONCODES" + input.LineSep + "HYPERQUERIES" + input.LineSep
' we want to look at all the Reason Codes and HyperQuery values
  
Try
     Dim output As TAeExchangeStruct = AeXMLBridge.getManuallySelectedSetupData(input)
Catch ex As Exception
     MessageBox.Show(ex.Message)
End Try

Remarks

  • Multiple upload commands can be used in the input parameter
  • Upload commands are not case sensitive
  • One output line per each command passed
  • Number of fields returned for each upload command passed can vary

Available Upload Commands

  • ActiveStatusConditions
  • AllWorkGroups
  • Benefits
  • BrowserProfiles
  • ClockGroups
  • Clusters
  • CorrectiveActions
  • Exports
  • HourlyStatusTypes
  • HyperQueries
  • InactiveStatusConditions
  • PayDesignations
  • PayPeriodClasses
  • PayTypes
  • ReasonCodes
  • Reports
  • ScheduleTypes
  • Stations
  • UserGroups
  • VendorOperations
  • WorkGroupLevels

Additional Information

  • The PayClasses command has been upgraded to return additional fields with the following descriptions:

    • Data Identifier
    • Pay Class Name
    • Pay Class ID
    • Pay Period Class ID
    • Lunch Class ID
    • Rounding Class ID
    • Overtime Class ID
    • Worked Holiday Class ID
    • Holiday Class ID
    • Exception Class ID
    • Schedule Class ID
    • Transfer Class ID
    • Premium Class ID
    • Restriction Class ID
    • Shift Class ID
    • Autopay Class ID

  • The PayPeriodClass command has been upgraded to return additional fields:

  • Description of Fields Returned:
    • Pay Period Class Name
    • Pay Period Class ID
    • Prev Period Start Date
    • Prev Period End Date
    • Curr Period Start Date
    • Curr Period End Date
    • Next Period Start Date
    • Next Period End Date

Possible Errors

  • Invalid data entered

ClientServerDateTime
extractNewDBElements
getActiveStatusConditions
getBaseClientData
getBrowserProfilesSimple
getClockGroupsSimple
getClockGroupStationsSimple
getClustersSimple
getClusterStationsSimple
getCompanyName
getCurrentBrowserProfileMenuItems
getHourlyStatusTypesSimple
getInactiveStatusConditions
getPayClassesSimple
getPayDesignationsSimple
getPayPeriodClassData
getPayPeriodClasses
getPayTypes
getReasonCodesSimple
getSiteEnvironment
ServerUTCDateTime
setBaseClientData
updateNewDBElement

Back to Top