Writing and Plugging-in Custom Roundtrip Compatible Process

Owned by Adam Davis
Aug 04, 2023
2 min read

Before developing a custom Roundtrip-compatible process, you need to determine if your requirements can be satisfied with a simple single-threaded processing, or if you will require the complexity and power of parallel processing. The choice you make here will influence the process template you will utilize in the subsequent development steps.

Parallel Enabled Process

For parallel enabled processes, follow these steps:

  1. Use parallel enabled template, save a copy under target process name.

  2. Parameters - Delete parameters you will not use, remove references from all code tabs.

  3. Prolog

    1. Update section that handles minimal and maximal values of pMonthFrom and pMonthTo parameters – adjust cnMinMonth and cnMaxMonth accordingly.

    2. Decide on default parallel dimension to be used – default preset is FIN Company – adjust cDimPar if necessary.

    3. Adjust parameter values validation logic if necessary. You may need to decide scope of pDimPar allowed values as not all dimensions might be able to be parallelized on. Decide if there is a mapping needed for construction of source and target parallel slices. If not, you may discard sections of code that are checking if BSEG Plan dimensions are used or not. If yes, keep the sections intact.

    4. Adjust section that creates source view.

    5. Adjust section that creates target view

  4. Metadata/Data - Add calculation logic to Metadata/Data. Keep in mind none of the parallelly executed threads should write to another threads space – in such cases the calculation results will be incorrect. Always respect mappings between source and target if they are necessary. The mappings must in all cases be unique for each thread.

  5. Epilog - Customize any messages that the process generates if necessary.

 Single Thread Process

For one thread processing follow these steps:

  1. Use simple one thread template, save a copy under target process name.

  2. Parameters - Delete parameters you will not use, remove references from all code tabs.

  3. Prolog

    1. Update section that handles minimal and maximal values of pMonthFrom and pMonthTo parameters – adjust cnMinMonth and cnMaxMonth accordingly.

    2. Adjust parameter values validation logic if necessary.

    3. Adjust section that creates source view.

    4. Adjust section that creates target view.

  4. Metadata/Data - Add calculation logic to Metadata/Data.

  5. Epilog - Customize any messages that the process generates if necessary.

Related

Roundtrip Implementation