1. Administering Payroll Flows
  2. Examples of Adding a New Parameter to a Payroll Flow

Examples of Adding a New Parameter to a Payroll Flow

This topic explains how you can add a new task parameter to a flow pattern.

For example, the delivered 'Run Mode' parameter helps you to manage the transient data generated by the HCM extract reports. Set the Run Mode parameter to 'Normal' to discard the transient data generated by the report and to ensure that the application storage isn't loaded unnecessarily. It also enhances the performance of the application.

If you have a flow that includes a report, you can add this new parameter to your flow.

  • Retain the original flow, delete the old report, and add back the report with the new parameter manually into the flow. Ensure the task sequence is similar to the original flow.

  • If you're using a copy of the delivered flow, make a new copy of the flow and add the new parameter to the flow.

Use these examples to understand how you can add a new task parameter to your flows.

Add the new parameter to an existing flow

Let's say that you have an existing flow pattern that includes the Run Payment Register Report task. Since the new task parameter was delivered after you created the flow pattern, the new parameter isn't automatically available for you to use. Perform these tasks to add the new task parameter to your existing flow:

  1. Delete the payroll report from the flow pattern, and save and submit the flow.

  2. Add back the report into the flow pattern so that the new task parameter is available for you to use.

  3. Add the new task parameter to the flow.

Let's look at the steps to add the new task parameter to an existing flow pattern.

  1. Navigate to Payroll in My Client Groups on the Home page and select the Payroll Flow Patterns task from the task pane.

  2. Search for the user-defined flow pattern that has the Payroll Register report.

  3. Open the Tasks tab of the Payroll Flow Pattern page, and view the tasks.

  4. Use the Tasks Sequence tab to view the task sequence. When you delete a task from the flow, the flow sequence changes. After you add the new report to the flow, you must recreate the same flow sequence, hence make a note of the sequence of tasks in this flow.

  5. Remove the Run Payroll Register Report task.

  6. Click Save and then Submit to submit the changed flow.

  7. Use the Checklist or Views Flows page to search for the same flow pattern.

  8. On the Tasks tab Payroll Flow Pattern page, search for and add the Run Payroll Register Report task.

  9. On the Tasks Sequence tab of the page, reorder the sequence of tasks to match the flow sequence you noted in step 4 above.

  10. On the Parameters tab of the page, click Select and Add to add the task parameters to the flow.

  11. On the Select and Add: Parameters dialog box, search for and select the Run Mode parameter for the Run Payroll Register Report task and click OK.

  12. Before you submit the flow, review and edit the Run Mode parameter. Select these parameter values.

    Field

    Value

    Display

    Yes

    Display Format

    Lookup Choice List

    Parameter Basis

    Constant Bind

    Basis Value

    CLOB

  13. Click Save and the Submit, to submit the flow.

Add the new parameter to the copy of a delivered flow

Let's say that you're using a copy of a delivered flow pattern that has the extract report that includes the new parameter. In this case, copy the delivered flow and add the new parameter to the flow.

Let's look at the steps to add the new task parameter to a copy of a delivered flow pattern.

  1. Navigate to Payroll in My Client Groups on the Home page and select the Payroll Flow Patterns task from the task pane.

  2. Search for the delivered flow pattern that has the report.

  3. Use the Copy action to make a copy of the delivered flow and rename the flow.

  4. Open the Tasks tab of the Payroll Flow Pattern page, and view the tasks. Ensure that the flow has the Run Payroll Register Report task.

  5. On the Parameters tab of the page, click Select and Add to add the task parameters to the flow.

  6. On the Select and Add: Parameters dialog box, search for and select the Run Mode parameter for the Run Payroll Register Report task and click OK.

  7. Before you submit the flow, review and edit the Run Mode parameter. Select these parameter values.

    Field

    Value

    Display

    Yes

    Display Format

    Lookup Choice List

    Parameter Basis

    Constant Bind

    Basis Value

    CLOB

  8. Click Save and the Submit, to submit the flow.