XProc 3.1: dynamic pipeline execution

The p:run step runs a dynamically loaded pipeline.

<p:run
  name? = NCName>
    (p:with-input &
     p:run-input* &
     p:run-option* &
     p:output*)
</p:run>

The p:run step has a single, anonymous input that accepts the pipeline to be run. Otherwise, it functions similar to an atomic step in that you can define input connections and option values for it, albeit not with the usual p:with-input and p:with-option connections.

The p:run step expects a single pipeline document on its anonymous input port (“pipeline port”). Independent of how the pipeline is provided, it must have a version attribute on its root element. It is a dynamic error (err:XC0200) if the pipeline input to the p:run step is not a valid pipeline. The anonymous input port is not primary, although it is the only p:input port of p:run. Therefore it will not automatically connect to the default readable port (see Connections in XProc 3.0: An XML Pipeline Language); it needs to be connected to its pipeline input explicitly.

The pipeline that appears on the pipeline port is evaluated using the inputs and options specified on the p:run step by means of the p:run-input and p:run-option elements, respectively.

The p:run-input element is a special case of the p:with-input element for passing inputs to the pipeline being run.

<p:run-input
  port = NCName
  select? = XPathExpression
  href? = { anyURI }
  pipe? = string
  primary? = boolean
  exclude-inline-prefixes? = ExcludeInlinePrefixes>
    ((p:empty |
       (p:document |
        p:pipe |
        p:inline)*) |
     anyElement*)
</p:run-input>

Similarly, the p:run-option element is a special case of the p:with-option element for passing options to the pipeline being run.

<p:run-option
  name = EQName
  as? = XPathSequenceType
  select = XPathExpression
  collection? = boolean
  href? = { anyURI }
  pipe? = string
  static? = boolean
  exclude-inline-prefixes? = ExcludeInlinePrefixes>
    ((p:empty |
       (p:document |
        p:pipe |
        p:inline)*) |
     anyElement*)
</p:run-option>

In terms of binding inputs and options, these elements have the same syntax and semantics as p:with-input and p:with-option. In addition, the boolean attribute primary can be used on p:run-input to declare whether the respective port of the dynamically executed pipeline is expected to be the primary input port. If the attribute is omitted, it is assumed to be “false” if there are multiple p:run-input connections and “true” if there is exactly one p:run-input connection. It is a dynamic error (err:XC0206) if the dynamically executed pipeline implicitly or explicitly declares a primary input port with a different name than implicitly or explicitly specified in the p:run invocation. Input ports of the dynamically executed pipeline that are not declared with p:run-input on the p:run invocation will receive a p:empty connection. Input ports that are declared in p:run-input but not in the dynamically executed pipeline will be silently ignored.

The context item used to evaluate expressions on p:run-option comes from the default readable port of the p:run step. Additionally, if p:run-input implicitly or explicitly identifies a primary input port, the default readable port will be connected to it if no explicit connection is provided.

Other than p:with-option, p:run-option accepts a boolean attribute static that defaults to “false”. If it is “true”, the option value will be supplied to static analysis of the executed pipeline as a static option with the same name.

Options of the dynamically executed pipeline that are not provided by a p:run-option on the p:run invocation will be defaulted in the normal way (if the option is required, the invocation will fail, for example). Options that are provided by p:run-option but not declared in the dynamically executed pipeline are silently ignored.

Each output port of the pipeline can appear as a same-named output port of the p:run step. In order for this to happen, the port needs to be explicitly declared in the p:run step. In contrast to output declarations of compound steps or of p:declare-pipeline with a subpipeline, such an output declaration may not establish a connection to any port of another step or of the pipeline to be run.

If the pipeline has an output that is not declared on the p:run step, that output is discarded, and the corresponding port on the p:run step does not exist. If the p:run step declares an output port that is not provided by the pipeline, an empty sequence appears on that port.

It is a dynamic error (err:XC0207) if the dynamically executed pipeline implicitly or explicitly declares a primary output port with a different name than implicitly or explicitly specified in the p:run invocation.

<p:declare-step xmlns:p="http://www.w3.org/ns/xproc"
                xmlns:xs="http://www.w3.org/2001/XMLSchema"
                version="3.1" 
                name="sample-run-invocation">
  <p:variable name="xsl-params" select="map{'foo': 'bar'}" 
              as="map(xs:QName, item()*)"/>
  <p:variable name="assert-valid" select="false()" as="xs:boolean"/>
  <p:variable name="mode" as="xs:QName?" select="()"/>
  <p:variable name="template" as="xs:QName?" select="()"/>

  <p:run name="runme">
    <p:with-input href="transform-n-validate.xpl"/>
    <p:run-option name="mode" select="$mode"/>
    <p:run-option name="template" select="$template"/>
    <p:run-option name="xslt-parameters" select="$xsl-params"/>
    <p:run-option name="assert-valid" select="$assert-valid"/>
    <p:run-input port="source" href="my.xml" primary="true"/>
    <p:run-input port="stylesheet" href="my.xsl"/>
    <p:run-input port="xsd" href="my.xsd"/>
    <p:output port="result" primary="true"/>
    <p:output port="report"/>
  </p:run>
</p:declare-step>

<p:declare-step xmlns:p="http://www.w3.org/ns/xproc"
                xmlns:xs="http://www.w3.org/2001/XMLSchema"
                version="3.1" 
                name="transform-n-validate">
  <p:input port="source" primary="true" sequence="true"/>
  <p:input port="stylesheet"/>
  <p:input port="xsd"/>
  <p:option name="assert-valid" as="xs:boolean" select="false()"/>
  <p:option name="xslt-parameters" as="map(xs:QName, item()*)?"/>
  <p:option name="mode" as="xs:QName?"/>
  <p:option name="template" as="xs:QName?"/>
  <p:output port="result" primary="true"/>
  <p:output port="report" pipe="report@xsdval"/>

  <p:xslt>
    <p:with-option name="initial-mode" select="$mode"/>
    <p:with-option name="template-name" select="$template"/>
    <p:with-option name="parameters" select="$xslt-parameters"/>
    <p:with-input port="stylesheet" pipe="stylesheet"/>
  </p:xslt>

  <p:validate-with-xml-schema name="xsdval">
    <p:with-option name="assert-valid" select="$assert-valid"/>
    <p:with-input port="schema" pipe="xsd@transform-n-validate"/>
  </p:validate-with-xml-schema>
</p:declare-step>