Wrapper Override Profiles

You can add wrapper override profiles to modify wrapper executions. When you run a wrapper associated with an enabled override profile, the wrapper runs with the changes specified in the profile. For example, if a pipeline is failing, select an override profile configured to run the wrapper without the failing pipeline until the problem that caused the failure is resolved, at which time you can remove the override profile from the wrapper.

Wrapper override profiles include one or more of the following configurations:

  • Disable one or more pipelines from running during wrapper execution.
  • Add additional pipelines not already in the wrapper, including custom pipelines. Specify the order and sequence of when additional pipelines run in relation to other additional pipelines added to the wrapper.
  • Overrides to the original pipeline setting values. For example, if you have a pipeline that normally extracts and delivers UKG Pro Workforce Management data changes going back 60 days and you need a more historical insight into the dataset, you could add an override setting for that pipeline that will deliver data changes going back 365 days.

Guidelines

Note the following:

  • Wrappers can have one or more override profiles, although only one wrapper override profile at a time can be assigned to a job.
  • These override profile changes are enforced when the profile is applied to a scheduled or on-demand wrapper execution job.
  • Any custom pipelines added to the tenant by Services are included as additional pipelines available to include in a profile. Adding custom pipelines to the wrapper ensures they run when the wrapper is executed. Custom pipelines can be used to combine data from multiple Data Hub datasets into one custom view and consume data from UKG Pro Workforce Management APIs that are not sources for existing product pipelines. Contact Services UKG Global Supportfor more information.
  • See Appendix A - Wrapper Pipelines and Sequences for a list of all default pipelines and the order they run during wrapper execution.

Add and edit wrapper override profiles

From the Wrapper Override Profile page, you add new wrapper override profiles and make edits to existing profiles.

Add a wrapper override profile

  1. Go to the Setup > Wrapper Override Profiles page and click Add. The Add Wrapper Override Profile page opens.
  2. Specify the following:
    • Name. Enter a unique name using letters, numbers, underscores, and spaces only. No special characters are supported.
    • Base Wrapper. Select the wrapper to which you want to add the profile.
    • Enabled. Click the drop-down list and select either Yes or No.
  3. Click Submit to save the profile and retrieve information specific to the wrapper. The Disabled Pipeline(s), Additional Pipeline(s), and Override Setting(s) sections display. Set these properties as shown in the following steps to customize the profile.
    Note: You can set these properties now or edit the profile later from the Wrapper Override Profiles page.
  4. For Disabled Pipeline(s), click Add and do the following:
    1. Select a pipeline in the base wrapper that you want to disable. This ensures the pipeline will not be included when the wrapper job is run.
    2. Click Add to disable more pipelines.
    3. To remove a disabled pipeline, click its minus icon.
  5. For Additional Pipeline(s), click Add and specify the following:
    1. Base Pipeline. Select a pipeline to use as a reference point for determining the order of execution of one or more additional pipelines.
    2. Additional Pipeline. Select a pipeline from the drop-down list of any pipelines on the current tenant, including custom pipelines, not already in the selected wrapper.
    3. Order. Select Before or After to determine in what order the additional pipeline runs relative to the base pipeline. To see the order base pipelines run, see Appendix A - Wrapper Pipelines and Sequences.
    4. Sequence. Select the value to indicate when the additional pipeline runs relative to other additional pipelines added. For example, when you add multiple additional pipelines to run after the base pipeline, the order in which they run is determined by their sequence value. You can select the same sequence for multiple pipelines if you want them to run in parallel.
    5. Enabled. Select either Yes or No.
    6. Click Add to configure more additional pipelines.
    7. To remove an additional pipeline, click its minus icon.
  6. For Override Setting(s), click Add and specify the following:
    1. Pipeline. Select a pipeline whose standard pipeline setting you want to override. This populates the Type and Original Value fields.
    2. Settings. Select the pipeline setting to override.
    3. Type. Indicates the type of setting value, for example String or INT for integer (number). This field is read-only for reference and cannot be changed.
    4. Original Value. Indicates the value to be overridden. This field is read-only for reference and cannot be changed.
    5. Override Value. Enter the value to override the original value. For example, if the original value is True, enter False.
    6. Click Add to override more settings.
    7. To remove an override setting, click its minus icon.
  7. Do one of the following:
    • Click Submit to save your changes and return to the Wrapper Override Profiles page. When enabled, the profile can be used when you schedule the wrapper to run or run the wrapper immediately (on-demand).
    • Click Cancel to discard your changes and return to the Wrapper Override Profiles page.

Edit a wrapper override profile

  1. From the Setup > Wrapper Override Profilespage, click Edit for the profile. The Edit Wrapper Override Profile page opens.
  2. Make your changes and click Submit.

Delete a wrapper profile override

You can delete one or more profile overrides at a time. A profile cannot be deleted when used in a wrapper job that is running or scheduled to run.

  1. From the Setup > Wrapper Override Profilespage, select the check box for one or more profiles not currently used in a scheduled wrapper job.
  2. Click Delete. A Confirmation message opens. Click Yes. The profiles no longer display. If a profile has an active wrapper job associated with it, it cannot be deleted, and you will be alerted to the schedule wrapper jobs with which it is associated.