Use the following syntax to add custom fields to your ADP Query:

  • <fieldname>(FieldPath)

You can enter multiple custom fields by separating with commas.

Configuration for custom fields is done in the ADP Configuration dialog (FILE | Configure | ADP).

How it works

The <fieldname> is the name of the field shown in OrgChart Now. The (fieldPath) is the path used to retrieve the field from the available ADP data. There are hundreds of fields available and also the customer can add as many customer fields as they desire.

To reference a standard field you have to provide the full path of the field starting with the object.

Objects in a standard query include:

  • workerID
  • person
  • workerDate
  • workerStatus
  • businessCommunication

For example, person.genderCode.shortName would return "Male" or "Female"

For workAssignments there can be multiple work assignments for a given employee (for example, if a person changes jobs within a organization).

Use the object reference "wa" to retrieve values for the active work assignment.

For example, wa.baseRemuneration.hourlyRateAmount.amountValue.

For custom fields use the following syntax (see example below)

  1. cf = CodeField from CustomFieldGroup
  2. sf = StringField from the CustomFieldGroup
  3. if = IndicatorField from the CustomFieldGroup
  4. nf = NumberField from the CustomFieldGroup

Note: ADP is case sensitive so make sure you take this into account when entering field paths.

Examples

Example 1: Retrieve a 'codeField' from the 'customFieldGroup'

  • Sub-Department(cf.sub-department)

Example 2: Retrieve a 'stringField' from the 'customFieldGroup'

  • EmployeeID(sf.Employee ID)

Example 3: Retrieve a 'stringField' from the 'customFieldGroup' (Special case to handle AuxSuperID)

  • AuxSuperID(sf.Supervisor 2)

Example 4: Retrieve home phone and mobile from person object

  • HomePhone(person.communication.landlines[0].formattedNumber)
  • MobilePhone(person.communication.mobiles[0].formattedNumber)

Example 5: Retrieve hourly rate from current workassignment

  • HourlyRate(wa.baseRemuneration.hourlyRateAmount.amountValue)

Example 6: Retrieve compensation information from current workassignment

  • PeriodRate(wa.baseRemuneration.payPeriodRateAmount.amountValue) - How much paid every pay cycle
  • PayCycle(wa.payCycleCode.shortName) - e.g. BiWeekly
  • HourlyRate(wa.baseRemuneration.hourlyRateAmount.amountValue) - How much paid every pay cycle

Example 7: Hire Date for current workassignment

  • HireDate(wa.hireDate)

Example: 8: WorkerType from current workassignment

  • WorkerType(wa.workerTypeCode.shortName)

Example 9: Work Location from current workassignment

  • Location(wa.homeWorkLocation.nameCode.codeValue)

Example 10: payRollGroupCode

payRollGroupCode(wa.payRollGroupCode)

Example 11: Custom Indicator named 'HPEL Hire'

HPEL(if.HPEL Hire)

Sample Data

A sample data file is attached (Sample Data). Use any JSON viewer to explore the data ([https://www.jsoneditoronline.org]).