Name

ml:invoke-module — Invoke a module on MarkLogic Server.

Synopsis

<p:declare-step type="ml:invoke-module" xmlns:ml="http://xmlcalabash.com/ns/extensions/marklogic">
     <p:input port="parameters" kind="parameter"/>
     <p:output port="result" sequence="true"/>
     <p:option name="module" required="true"/>                     <!-- string -->
     <p:option name="host"/>                                       <!-- string -->
     <p:option name="port"/>                                       <!-- integer -->
     <p:option name="user"/>                                       <!-- string -->
     <p:option name="password"/>                                   <!-- string -->
     <p:option name="content-base"/>                               <!-- string -->
     <p:option name="wrapper"/>                                    <!-- QName -->
</p:declare-step>

Description

The ml:invoke-module step invokes a module on a Mark Logic Server, as its name implies.

Because the results of a module invocation may not be a single, well formed XML document (for example, it could be a single atomic value), the results are wrapped in the specified wrapper element.

Implementation

To use this step you must have MarkLogic Server and the xmlcalabash1-xcc module. The jar file from that project must be in the class path in order to use this step.