How do I configure guided journeys and enable them on Redwood compensation pages?

Here's an example of what to do for a guided journey with an External URL task type defined

  1. Go to My Client Groups > Journeys Setup > Guided Journey.
  2. Create the guided journey by completing the required and relevant optional fields.
  3. In the Tasks section, add an External URL task type with the URL https://host?name={value}:
    • name is based on your URL.
    • value can be the relevant parameter from these table, for example:

      https://host?ActionDate={Action Date}&ActionCode={Action Code}&PersonId={Person ID}&AssignmentId={Assignment ID}&ReasonCode={Action Reason Code}&JobId={Job ID}&LegalEntityId={Legal Entity ID}&BusinessUnitId={Business Unit ID}&PositionId={Position ID}

      Pages: Personal Contributions, Individual Compensation, and Administer Compensation

      Section Attribute Parameter Name Comments
      When
      • ActionId
      • LegalEntityId
      • BusinessUnitId
      • LegislationCode
      • AssignmentNumber
      • ActionDate
      • Action ID
      • Legal Entity ID
      • Business Unit ID
      • Legislation Code
      • Assignment Number
      • Action Date
      NA
      Additional Compensation

      Individual Compensation:

      • ActionDate
      • ActionId
      • PlanId_0
      • OptionId_0
      • ProcessingType_0
      • PrimaryInputValue_0
      • StartDate_0
      • EndDate_0
      • ElementEntryId_0
      • ElementTypeId_0

      Assignment:

      • LegalEntityId
      • BusinessUnitId
      • LegislationCode
      • AssignmentNumber

      Individual Compensation:

      • When Date
      • Action ID
      • Plan ID
      • Option ID
      • Processing Type
      • Primary Input Value
      • Start Date
      • End Date
      • Element Entry ID
      • Element Type ID

      Assignment:

      • Legal Entity ID
      • Business Unit ID
      • Legislation Code
      • Assignment Number

      There can be multiple individual compensation allocations available. So attributes are suffixed with 0, 1, 2 and so on.

      These attributes are also available in Global HR and Offer actions that include this section.

      Pages: Change Salary and Admin Change Salary

      Section Attribute Parameter Name Comments
      When and Why
      • ActionDate
      • ActionId
      • ReasonId
      • BusinessUnitId
      • LegislationCode
      • When Date
      • Action ID
      • Reason ID
      • Business Unit ID
      • Legislation Code
      NA
      Salary

      Salary:

      • WhenDate
      • ActionId
      • ActionReasonId
      • SalaryBasisId
      • SalaryAmount
      • NextSalReviewDate
      • SalaryRangeMinimum
      • SalaryRangeMaximum
      • RangePosition
      • Quartile
      • Quintile
      • CompaRatio
      • WorkAtHome
      • FTE
      • LegislativeDataGroupId
      • GeographyName
      • GeographyTypeName

      Assignment:

      • GradeId
      • LegalEntityId
      • BusinessUnitId
      • LegislationCode
      • GradeLadderName
      • GradeStepName

      Salary:

      • When Date
      • Action ID
      • Action Reason ID
      • Salary Basis ID
      • Salary Amount
      • Next Salary Review Date
      • Salary Range Minimum
      • Salary Range Maximum
      • Range Position
      • Quartile
      • Quintile
      • Compa-ratio
      • Work From Home
      • FTE
      • Legislative Data Group ID
      • Compensation Zone Name
      • Compensation Zone Type Name

      Assignment:

      • Grade ID
      • Legal Entity ID
      • Business Unit ID
      • Legislation Code
      • Grade Ladder Name
      • Grade Step Name
      These attributes are also available in Global HR and Offer actions that include the salary section.

      Page: Salary History

      Section Attribute Parameter Name Comments
      Landing Page

      Salary:

      • WhenDate_0
      • ActionId_0
      • ActionReasonId_0
      • SalaryBasisId_0
      • SalaryAmount_0
      • NextSalReviewDate_0
      • SalaryRangeMinimum_0
      • SalaryRangeMaximum_0
      • RangePosition_0
      • Quartile_0
      • Quintile_0
      • CompaRatio_0
      • WorkAtHome_0
      • FTE_0
      • LegislativeDataGroupId_0
      • GeographyName_0
      • GeographyTypeName_0

      Assignment:

      • GradeId
      • LegalEntityId
      • BusinessUnitId
      • LegislationCode
      • GradeLadderName
      • GradeStepName

      Salary:

      • When Date
      • Action ID
      • Action Reason ID
      • Salary Basis ID
      • Salary Amount
      • Next Salary Review Date
      • Salary Range Minimum
      • Salary Range Maximum
      • Range Position
      • Quartile
      • Quintile
      • Compa-Ratio
      • Work From Home
      • FTE
      • Legislative Data Group ID
      • Compensation Zone Name
      • Compensation Zone Type Name

      Assignment:

      • Grade ID
      • Legal Entity ID
      • Business Unit ID
      • Legislation Code
      • Grade Ladder Name
      • Grade Step Name
      There can be multiple salaries available. So attributes are suffixed with 0, 1, 2 and so on.
      Create and Edit Page

      Salary:

      • WhenDate
      • ActionId
      • ActionReasonId
      • SalaryBasisId
      • SalaryAmount
      • NextSalReviewDate
      • SalaryRangeMinimum
      • SalaryRangeMaximum
      • RangePosition
      • Quartile
      • Quintile
      • CompaRatio
      • WorkAtHome
      • FTE
      • LegislativeDataGroupId
      • GeographyName
      • GeographyTypeName

      Assignment:

      • GradeId
      • LegalEntityId
      • BusinessUnitId
      • LegislationCode
      • GradeLadderName
      • GradeStepName

      Salary:

      • When Date
      • Action ID
      • Action Reason ID
      • Salary Basis ID
      • Salary Amount
      • Next Salary Review Date
      • Salary Range Minimum
      • Salary Range Maximum
      • Range Position
      • Quartile
      • Quintile
      • Compa-Ratio
      • Work From Home
      • FTE
      • Legislative Data Group ID
      • Compensation Zone Name
      • Compensation Zone Type Name

      Assignment:

      • Grade ID
      • Legal Entity ID
      • Business Unit ID
      • Legislation Code
      • Grade Ladder Name
      • Grade Step Name
      NA

      Pages: My Compensation and Salary Details, Compensation Info and Salary Details

      Section Attribute Parameter Name Comments
      Salary

      Current Salary:

      • WhenDate
      • ActionId
      • ActionReasonId
      • SalaryBasisId
      • SalaryAmount
      • GradeId
      • SalaryRangeMinimum
      • SalaryRangeMaximum
      • RangePosition
      • Quartile
      • Quintile
      • FTE
      • CompaRatio
      • LegislativeDataGroupId
      • NextSalReviewDate
      • GeographyTypeName
      • GeographyName

      Assignment:

      • GradeId
      • LegalEntityId
      • BusinessUnitId
      • LegislationCode
      • GradeLadderName
      • GradeStepName

      Current Salary:

      • When Date
      • Action ID
      • Action Reason ID
      • Salary Basis ID
      • Salary Amount
      • Grade ID
      • Salary Range Minimum
      • Salary Range Maximum
      • Range Position
      • Quartile
      • Quintile
      • FTE
      • Compa-ratio
      • Legislative Data Group ID
      • Next Salary Review Date
      • Compensation Zone Type Name
      • Compensation Zone Name

      Assignment:

      • Grade ID
      • Legal Entity ID
      • Business Unit ID
      • Legislation Code
      • Grade Ladder Name
      • Grade Step Name

      On the landing page, the current salary is passed as context.

      On the details page, the selected salary record is passed as context.

      Personal Contribution

      Additional Compensation

      • PlanId_0
      • OptionId_0
      • ProcessingType_0
      • PrimaryInputValue_0
      • StartDate_0
      • EndDate_0
      • ElementEntryId_0
      • ElementTypeId_0

      Assignment:

      • BusinessUnitId
      • LegalEntityId
      • LegislationCode
      • Plan ID
      • Option ID
      • Processing Type
      • Primary Input Value
      • Start Date
      • End Date
      • Element Entry ID
      • Element Type ID

      Assignment:

      • Business Unit ID
      • Legal Entity ID
      • Legislation Code
      There can be multiple individual compensation allocations available. So attributes are suffixed with 0, 1, 2 and so on.
      Recurring and One-Time Payments
      • ElementTypeId_0
      • ElementEntryId_0
      • StartDate_0
      • EndDate_0
      • ProcessingType_0
      • PrimaryInputValue_0

      Assignment:

      • BusinessUnitId
      • LegalEntityId
      • LegislationCode
      • Element Type ID
      • Element Entry ID
      • Start Date
      • End Date
      • Processing Type
      • Primary Input Value

      Assignment:

      • Business Unit ID
      • Legal Entity ID
      • Legislation Code
      There can be multiple payments available. So attributes are suffixed with 0, 1, 2 and so on.

      Pages: Employment Info, View Job Offer, Journeys

      In addition to the attributes available on the page, respective sections also have these attributes available.

      Section Attribute Parameter Name Comments
      Salary
      • WhenDate
      • ActionId
      • ActionReasonId
      • SalaryBasisId
      • SalaryAmount
      • GradeId
      • FTE
      • LegislativeDataGroupId
      When Date Action ID Action Reason ID Salary Basis ID Salary Amount Grade ID FTE Legislative Data Group ID NA
      Additional Compensation
      • PlanId_0
      • OptionId_0
      • ProcessingType_0
      • PrimaryInputValue_0
      • StartDate_0
      • EndDate_0
      • ElementEntryId_0
      • ElementTypeId_0
      • Plan ID
      • Option ID
      • Processing Type
      • Primary Input Value
      • Start Date
      • End Date
      • Element Entry ID
      • Element Type ID
      There can be multiple individual compensation allocations available. So attributes are suffixed with 0, 1, 2 and so on.
      Recurring and One-Time Payments
      • ElementTypeId_0
      • ElementEntryId_0
      • StartDate_0
      • EndDate_0
      • ProcessingType_0
      • PrimaryInputValue_0
      • Element Type ID
      • Element Entry ID
      • Start Date
      • End Date
      • Processing Type
      • Primary Input Value
      There can be multiple payments available. So attributes are suffixed with 0, 1, 2 and so on.

      Page: View Compensation History

      Section Attribute Parameter Name Comments
      Landing Page

      SalaryBasisId

      Assignment:

      • BusinessUnitId
      • LegalEntityId

      Salary Basis ID

      Assignment:

      • Business Unit ID
      • Legal Entity ID
      Most recent salary is passed as context.
      Overall Salary Page LegislationCode Legislation Code NA
      Recurring Payments Page
      • ElementTypeId
      • ProcessingType

      Assignment:

      • BusinessUnitId
      • LegalEntityId
      • LegislationCode
      • Element Type ID
      • Processing Type

      Assignment:

      • Business Unit ID
      • Legal Entity ID
      • Legislation Code
      NA

      Use these queries to identify the IDs:

      Purpose Query
      Action Details Select * from per_actions_vl where action_id = <ActionId>
      Action Reason Details Select * from per_action_reasons_vl where action_reason_id= <ActionReasonId>
      Salary Basis Select * from cmp_salary_bases where salary_basis_id = <SalaryBasisId>
      Individual Compensation Plans Select * from cmp_plans_vl where plan_id=<PlanId>
      Individual Compensation Options Select * from cmp_components_vl where component_id=<OptionId>
      Individual Compensation Element Select * from pay_element_types_f where element_type_id=<ElementTypeId>
  4. Go to the Redwood Change Salary page.
  5. Go to Settings and Actions > Edit Page in Visual Builder Studio.
  6. Enable the guided journey in the When and why and Assignment sections. Use the guided journey code you specified in step 2 and the URL task code.
  7. Set and change details in the fields of each section and check the values in the URL.