marp UPoC interface

The input argument is a list with one element:

args := insertion_template_list

This procedure returns a value in the same form. The return value can contain multiple insertion_template_list keyed lists where each one is surrounded by curly braces.

retval := {insertion_template_list}[ {insertion_template_list}]*

insertion_template_list is a keyed list describing the default template.

These keys are expected to be in the keyed list:

  • TEMPLATE:
    • The insertion template name
    • Required: Yes
    • Default Value: N/A
    • Input Value: In the inbound args, TEMPLATE is populated with the templatename from the -I argument. If -I is not used, then it is populated with the default template.
  • *LIST keys:

    These keys are used to define the names, types, and values that are used to substitute fields in the template.

    For example, if MID is found in the template, hcimsgarchive uses the type and value corresponding to MID in the lists to insert the value.

  • NAMELIST:
    • Required: Yes
    • Default Value: N/A
    • Input Value: The names available by default when no procedure is specified.
  • TYPELIST:
    • Required: Yes
    • Default Value: N/A
    • Input Value: The type list corresponding to NAMELIST.
  • VALUELIST:
    • Required: Yes
    • Default Value: N/A
    • Input Value: The value list corresponding to NAMELIST.
  • FAILACTION:
    • Error handling for this inserting.
    • Required: No
    • Default Value: rollback
    • Input Value: Does not exist for input.

      This key describes how hcimsgarchive should behave if insert fails.

      {FAILACTION action}

    The value of FAILACTION should be one of:

    • skip

      If the insert fails and FAILACTION is skip, hcimsgarchive moves on to the next insert. For example, if there are three tables with data to be inserted and the second insertion fails, the second table insertion is skipped. The first and third insertions are committed.

    • rollback

      If the insert fails and FAILACTION is rollback, hcimsgarchive stops insertion and rolls back all insertions that are performed up to this point. For example, if there are three tables with data to be inserted, and the second insertion fails, the first insertion is rolled back. This is the default if no FAILACTION is specified.

    • template_name

      If the insert fails and FAILACTION is not skip or rollback, hcimsgarchive attempts to redo the insert with the template name that is provided. If necessary, then use an update template as the alternate if an insertion fails.