Versions Compared

Old Version 9

changes.mady.by.user Seth Petry-Johnson

Saved on

compared with

New Version 10

changes.mady.by.user Justin Brown

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
"LbApiPayloadTemplate": {
  "{EventCategory1}": {
    "action": "import (default) | ignore",
    "label": "human readable note",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }, 

  // ... additional category mappings as needed ...

  "*_default": {
    "action": "import (default) | ignore",
    "label": "human readable note",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

Each key within the LbApiPayloadTemplate should match one of the Publisher’s PublisherEventCategory values, or the special marker “*_default” which indicates a default template.

...

Example / scenario

Sample LbApiPayloadTemplate

Subscribe to all publisher event categories, using the same template for everything

Code Block
languagejson
"LbApiPayloadTemplate": {
  "*_default": {
    "action": "import",
    "label": "Import everything",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

Subscribe to all publisher event data, with special handling for a specific category

Code Block
languagejson
"LbApiPayloadTemplate": {
  "COURSE": {
    "action": "import",
    "label": "ACME Course",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  },
  "*_default": {
    "action": "import",
    "label": "Import everything",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

Subscribe to a specific category only, ignoring everything else

Code Block
languagejson
"LbApiPayloadTemplate": {
  "COURSE": {
    "action": "import",
    "label": "ACME course",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  },
  "*_default": {
    "action": "ignore",
    "label": "Nothing else matters"
  }
}

Ignore a specific category, process everything else using a common template

Code Block
languagejson
"LbApiPayloadTemplate": {
  "SOME_CATEGORY": {
    "action": "ignore",
    "label": "ACME course"
  },
  "*_default": {
    "action": "import",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

Omitting the “*_default” mapping has the same result as setting it to "action": "ignore", but it is recommended to explicitly include the default mapping to make the configuration easier to understand.

...