Customising the Roundtrip

Owned by Adam Davis
Aug 04, 2023
2 min read

Plugging-in Existing Custom Process

If your current custom process uses parameters similar in function to the ones mentioned in the Roundtrip Compatible Parameters, it's strongly recommended to rename the parameters to match those on the list. This ensures that the Main Roundtrip Wrapper can accurately pass parameter values to the process. There's no need for your process to implement semaphore logic or messaging, because these features will be handled by the wrapper through which your process is called.

 To integrate your existing custom process into the roundtrip configuration, follow these steps:

Prerequistes

  • If you haven't yet updated the framework, do so now, or execute the process }APQ.Cub.ProcessParametersInfo.Update.0.Main. This ensures that your process parameters are correctly mapped by the framework.

Procedure

  1. Go to Administration > Data Integration > Data Processing, Automation.

  2. Click on the Roundtrip Configuration to which you want to add the process from the Configuration list.

  3. Click on the green '+' icon in the 'Steps for Test' section and input the following information:

    1. Sequence ID: Choose the sequence number for the process. This will determine at what step in the Roundtrip Configuration your process will execute.

    2. Step: Select 'CUST-01'.

    3. Process: Select the process you want to incorporate.

    4. Roundtrip Compatible Parameters:

  4. If your process uses Roundtrip compatible parameters, their entry fields will be enabled.

  5. pParamArray: Provide any other parameters necessary for the process to run. Parameters and parameter values should be separated by a colon, with multiple parameters separated by an '&' symbol. Example: pWaitSec:10&pMessage:Success. You may supply any roundtrip compatible parameter value to any of your parameters in pParamArray. To do this you just use parameter name enclosed in % (expand syntax) as a value placeholder. The placeholder will be replaced by actual value of the parameter. Note that certain parameter values might be changing during multi-year processing – for example pYear will contain currently processing year. Example: pProcessYear:%pYear%

  6. Close the Configuration window.

The process should now be integrated into the existing Roundtrip Configuration. You might need to adjust the Sequence IDs to ensure your process fits correctly into the existing chain. Please be aware that if two steps are assigned the same Sequence ID, the specific order in which the processes will execute cannot be guaranteed.