ibm.HeadPipeAdded by IBM on July 25, 2013 | Version 1 (Original)
|This pipe initiates every pipeline and triggers the first pipe in the Action, View, and Error pipeline branches.
Table 1. Table listing the expressions and descriptions for the ibm.HeadPipe
|connection ||String||The string that specifies the ending of the URL for which this pipe should listen.
Note: You can only use forward slashes (/) and not backward slashes (\).
Important: Make sure your connection string names are different and unique. For example, if you have the following connection strings: /test and /test1, the URL pdm6/test might map to /test1.
|pidOutputs.action||Pipe||Specifies the first pipe in the pipeline's Action branch.
|pidOutputs.view||Pipe||Specifies the first pipe in the pipeline's View branch.
|pidOutputs.error ||Pipe||Specifies the first pipe in the pipeline's Error branch.
The following examples show how to configure a typical HeadPipe. In this sample, the HeadPipe listens for the "/samplePipeline3" URL string. If a matching request is detected, the HeadPipe triggers the Action branch to run the RepoLoadPipe, then triggers the View branch to run the RestoreMapPipe, and finally, triggers the Error branch to run the ReturnErrorPipe.
ibm.HeadPipe.samplePipeline3.connection = string:/samplePipeline3
- The URL string that the HeadPipe listens to is configured in several pieces. The domain and port is specified by the server, the context is supplied by the application.xml file, the servlet is defined in the web.xml file in the WAR file, and the pipeline listener is provided by this bundle.properties file. Furthermore, additional URL information may be specified by other files. However, the pipeline listener will always be the last sequence in the URL before the query string.
- When creating a connection string, you must use the following guidelines:
- The .properties files use the ISO 8859-1 character encoding. Characters that cannot be directly represented in this encoding can be written using Unicode escapes; only a single 'u' character is allowed in an escape sequence. See http://download.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html.
- Only use the forward slash ( / ) as a path delimiter. If a backslash ( \ ) is used, Forms Services Platform will not connect to any pipeline.
- Create unique connection strings for every pipeline's HeadPipe. Forms Services Platform always uses the first matching connection string. Unique names ensure that Forms Services Platform does not connect to the wrong pipeline.
- Ensure that no connections strings are a subset of another connection string. If any of the connection strings match a portion of another connection string, the Forms Services Platform might connect to the wrong pipeline, even if the names are unique. For example, consider the following connection strings:
pipeline 1 connection = string:ibm
pipeline 2 connection = string:ibm1
pipeline 3 connection = string:ibm11
pipeline 4 connection = string:ibm/submitForm
If you called domain.com/wfsp/sfsp/ibm, then pipeline 1 would run, as is expected.
If you called domain.com/wfsp/wfsp/ibm1, then pipeline 1 or 2 would run, which could result in an unexpected match.
If you called domain.com/wfsp/wfsp/ibm11, then pipeline 1, 2 or 3 would run, which could result in an unexpected match.
If you called domain.com/wfsp/wfsp/ibm/submitForm, then pipeline 1 or 4 would run, which could result in an unexpected match.
If you called domain.com/wfsp/wfsp/XXX.ibm/submitForm then no pipelines would run.