Integration Server 10.11 | Built-In Services Reference Guide | Flow Folder | Summary of Elements in this Folder | pub.flow:restorePipeline
 
pub.flow:restorePipeline
WmPublic. Restores a pipeline previously saved by pub.flow:savePipeline.
Input Parameters
$name
String Name of the saved pipeline. Because multiple pipelines can be saved, this parameter is necessary to identify the pipeline in memory. If this value is left null or the name is unknown, an exception will be thrown.
$merge
String. Optional. Flag that indicates whether or not to merge the values in the existing pipeline with the values in the saved pipeline. Set to:
*false to clear the existing pipeline before restoring the saved pipeline. This is the default.
*true to merge the existing pipeline with the saved pipeline. If a field exists in the saved pipeline and the existing pipeline, the saved field takes precedence.
$remove
String. Optional. Flag that indicates whether or not the saved pipeline will remain in memory after this service is executed. Set to:
*false to retain the saved pipeline in memory so that future calls to restorePipeline with the same $name will still return the saved pipeline. This is the default.
*true to remove the saved pipeline from memory after the service executes.
Output Parameters
The output is dynamic, based on the contents of the saved and existing pipelines.
Usage Notes
After a successful invocation of restorePipeline, the pipeline will contain all fields that were present immediately before pub.flow:savePipeline was invoked. restorePipeline clears existing pipeline values unless the optional $merge field is specified.
When using MTOM streaming for SOAP attachments, messageContext variables and/or XOPObject fields will not be available in the saved pipeline. A messageContext variable is used by many pub.soap services to hold the SOAP message on which the service acts. XOPObject fields are Objects that use the com.wm.util.XOPObject Java wrapper type. For more information about MTOM Streaming, see the Web Services Developer’s Guide.
This service is helpful in the interactive development or debugging of an application.
See Also
pub.flow:savePipeline
pub.flow:restorePipelineFromFile