pub.flow:restorePipelineFromFile
WmPublic. Restores a pipeline that was previously saved to a file.
Input Parameters
fileName | String Relative or absolute path and file name of a file containing a saved pipeline on the Integration Server. If the file is not found at run time, an exception is thrown. For a filename that does not include an absolute path, Integration Server calculates the relative path from the default pipeline directory which is located here: Integration Server_directory /instances/instance_name/pipeline When you specify a path for the fileName input parameter and the path is outside of the default pipeline directory, Integration Server verifies whether it is specified in the allowedReadPaths parameter of the file access control configuration file (fileAccessControl.cnf). If the file path is not specified in the allowedReadPaths parameter, Integration Server issues an exception. |
merge | String. Optional. Flag that determines whether or not to merge the saved values into the existing pipeline. Set to:  false to replace the existing pipeline with the saved values. This is the default. true to merge the saved values into the existing pipeline. |
Output Parameters
The output is dynamic, based on the contents of the saved and existing pipelines.
Usage Notes
This service is helpful in the interactive development or debugging of an application. In some cases, however, using the Pipeline debug property for the debugging of an application is more efficient. For more information about the Pipeline debug property, see webMethods Service Development Help.
Be aware that variables that exist in the saved pipeline but are not defined in the flow will not appear on the Pipeline tab and, therefore, will not be available for explicit mapping.
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.
The watt.server.checkPath.restorePipelineFromFile server configuration parameter determines whether Integration Server verifies that the provided filename is in the allowedReadPaths parameter of the file access control configuration file (fileAccessControl.cnf). When this parameter is set to true, the default, Integration Server verifies that the path or directory specified in filename is in the default pipeline directory or is included in the allowedReadPaths parameter. If the file is outside of the default pipeline directory and it is not in the allowed list, the service ends with a ServiceException. When the watt.server.checkPath.restorePipelineFromFile parameter is set to false Integration Server does not verify that the specified filename is in the default pipeline directory or the allowedReadPaths parameter.
The pub.flow:restorePipelineFromFile can always read from files in the default pipeline directory which is located here: Integration Server_directory /instances/instance_name/pipeline. You do not need to include the default pipeline directory in the allowedReadPaths parameter.
The fileAccessControl.cnf file is located in the following directory: Integration Server_directory /instances/instance_name/packages/WmPublic/config
See Also