Create a data collector for a policy version

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 2 min. de leitura

    • Create a data collector for a policy version in the Define Variables section of the Policy Builder.

    Antes de Iniciar

    Role required: maintsn_pace.code_editor

    Procedimento

    1. Navigate to All > Variable Definition > Data Collectors.
    2. Select New.Create new data collector page.
    3. On the form, fill in the fields as needed.
      Tabela 1. Create New Data Collector
      Field Description
      Name Name of the data collector.
      Category Category of the data collector. See Managing categories in PaCE for details.
      Description Additional details of the data collector.
      Created Date and time when the data collector was created.
      Created by Name of the user who created the data collector.
      Updated Date and time when the data collector was updated.
      Updated by Name of the user who updated the data collector.
    4. Click Save.

    O que Fazer Depois

    Activate and build your data collector to add it in the policy builder.
    1. Select the Versions tab, then the data collector draft name.
    2. Select the Build tab.
    3. In the Data sourcesDefine Variables section, select the variable tab you want to define.
      1. Click Add.
        Add new input/output
      2. On the Add new input form, fill in the fields.
        Tabela 2. Add new input
        Field Description
        Label (Optional) Label of the input or output.
        Name Enter a name of the input or output.
        Type Select the type of the input or output.
        Mandatory Select this check box if the input is mandatory.
        Description Description of the input or output.
        Default value Specify a default value.
        Nota:
        Inputs are used as parameters that help collect the correct data to be used in the policy. Outputs are used to specify output variables that can be used in the policy logic.
      3. Click Save.
      4. Repeat the steps to create the inputs and outputs as needed.
    4. Enter your inputs or outputs and write your code in the Data collector script, as needed.
    5. Add an exception error in your data collector by entering the following script: throw new PaCEExecutionError.

      When you execute the policy with the data collector exception, the error message will appear under the Output tab in the Execution errors section.

    6. Click Save.
    7. When you're finished, select Publish.
    8. In the Publish draft window, select the Activate this data collector check box, then Publish.
    Add your data collectors in the Policy Builderinto the Policy Builder from the Data Collectors tab.
    1. In the Policy Builder tab, select the version of the policy you want to add the new data collector to, then the Data sources icon Data source icon.
    2. Navigate to the policy you want to add the data collector to, then under the Define Variables section, click New.
    3. Select the data collector from the list of possible data collectors in the system, then click Next.Add data collector list.
    4. In the Add data collector page in the Details tab, give the data collector a label and variable name.
      Nota:
      If you're using the same data collector multiple times, it should have a different variable name.Add data collector details
    5. In the Inputs tab, provide inputs to complete the configuration of the data collector. The input can be user-specified or selected from the data picker icon.
    6. When you're finished, click Save. After the data collector is added and configured, you can access the data collector in the script editor using the data picker in low-code.
    Additionally, you can delete a data collector by selecting it and selecting the Delete button.