TAeClientVendorOp Structure

Field Data Type Description Notes
ApplyOverrides Boolean Enable to apply date range overrides 8, 9
BiWeekBegins String Date a biweekly period begins 1, 6, 7
DateRange TDateRangeEnum 10, 11
DestinationOptionsEnum TDestinationOptionsEnum
eMailBodyText String Text of the email 3, 4
eMailRecipients String List of email addresses separated by semicolons 4
eMailSender String Email sender 3, 4
eMailSubjectLine String Subject line of the email 3, 4
MaxDate String End date of DateRange 1, 5, 6
MinDate String Start date of DateRange 1, 5, 6
PayPerClass Integer Pay period class numeric value 6
VendorOpGroup String Group the VendorOp belongs to 2
VendorOpHint String Reminder hint assigned to the VendorOp 2
VendorOpName String Name of VendorOp to run
WeekBegins TDayOfWeekEnum Day of the week the week begins on 6

Notes

  1. yyyy-mm-dd format
  2. Read only
  3. Optional
  4. Used only when TDestinationOptionsEnum value is doEmail
  5. Used only when TDateRangeEnum value is drCustom
  6. Applied only when ApplyOverrides field is set to true
  7. Must be a biWeek value type of TDateRangeEnum
  8. Setting to true allows overrides on BiWeekBegins, MaxDate, MinDate, PayPerClass and WeekBegins
  9. ApplyOverrides is not expected/supported in the context of certain Vendor Operations
  10. For the PBJ Vendor Operation, the field is monitored for the value of drCustom. Any other value causes the system to assume an automatic date period calculation of the previous CMS Reporting Quarter
  11. For the PBJ Vendor Operation, should the system detect drCustom with a MinDate equal to the MaxDate the system will revert to automatic CMS period determination

Methods Referencing Structure

executeVendorOperation
getEmptyClientVendorOp
getSystemVendorOpsBasic
setManuallySelectedSetupData