Skip to main content

GetPipelineConfigByWellKnownName@1

Node GetPipelineConfigByWellKnownName@1 is used to retrieve a pipeline configuration from the global configuration by its well-known name.

Pipeline configurations stored in the global configuration can be accessed using their well-known names. This node retrieves the raw JSON configuration and writes it to the specified target path in the data context.

Adapter Prerequisites​

Node Configuration​

For fields targetPath, targetValueWriteMode, and targetValueKind, see Overview. Field path is not used in this node.

Either wellKnownName or wellKnownNamePath must be specified:

  • Use wellKnownName when the well-known name is a static value known at design time
  • Use wellKnownNamePath when the well-known name should be read dynamically from the data context
transformations:
  - type: GetPipelineConfigByWellKnownName@1 # Get the pipeline configuration by well-known name
    targetPath: $.config          # Path where the pipeline configuration should be stored in the payload
    wellKnownName: myPipelineConfig # The well-known name of the pipeline configuration (static value)
    # OR
    wellKnownNamePath: $.configName # JSON path to get the well-known name from the input data (dynamic value)

Usage Example​

Here's an example of how you might use the GetPipelineConfigByWellKnownName@1 node in a transformation pipeline. In this example, the node retrieves a pipeline configuration by its well-known name and uses it for further processing.

triggers:
  - type: FromExecutePipelineCommand@1
transformations:
  # Set the configuration name to retrieve
  - type: SetPrimitiveValue@1
    value: "myDataMappingConfig"
    targetPath: $.configName
  # Retrieve the pipeline configuration by well-known name
  - type: GetPipelineConfigByWellKnownName@1
    wellKnownNamePath: $.configName
    targetPath: $.pipelineConfig
  # Use the retrieved configuration for data mapping
  - type: DataMapping@1
    path: $.inputData
    targetPath: $.mappedData
    mappingConfigPath: $.pipelineConfig.mappings

Example with Static Well-Known Name​

triggers:
  - type: FromHttpRequest@1
transformations:
  # Retrieve a specific pipeline configuration
  - type: GetPipelineConfigByWellKnownName@1
    wellKnownName: customerDataTransform
    targetPath: $.transformConfig
  # Process data using the configuration
  - type: Map@1
    path: $.data
    targetPath: $.result