Description

Depending on the errorFormat string, this pipe creates an XML or an HTML file (for viewing the errors).

Parameters

key:BooleanChoice

jxpath:$data/response='yes'

By default, this pipe replaces the identified instance (the id denoted by #.name). If it cannot find the instance named, it will append the instance as the final instance in the first data model.

Parameters

key:incomingform

ibm.EncloseInstancePipe.samplePipeline3.
   instances.1.name=string:news

ibm.EncloseInstancePipe.samplePipeline3.
   instances.1.load=key:myXMLinstance

Technical details

• form (resolved type = Form) – The form in which to enclose the instances.
• instances (resolved type = List) – A List of Map objects which contain two key/value pairs: load and name. The load value should resolve to a string, array of bytes, InputStream, or DOM Document, that is the instance. The name value should resolve to a string that is the instance name. If an item in the list is invalid, an error will be logged and the instance containing the error will not be enclosed but the remaining List items will continue to be processed.

Usage note

• Data instances in your form must have an id attribute (#.name). If the data instance in your form does not contain an id attribute, the EncloseInstancePipe will not be able to manipulate the data. To avoid this problem, ensure that you added an explicit id attribute to your XForms instance.

Parameters

key:incomingform

ibm.ExtractEnclosurePipe.testPipeline5.
   enclosures.1.name = string:PAGE1.DATA1

ibm.ExtractEnclosurePipe.testPipeline5.
   enclosures.1.store = key:DATA1

ibm.ExtractEnclosurePipe.testPipeline5.
   datagroups.1.name = string:PAGE1.datagroup

ibm.ExtractEnclosurePipe.testPipeline5.
   datagroups.1.store = key:jxpath:concat
   ('data', $count)

ibm.ExtractEnclosurePipe.extractEnclosure1.
storeAll = key:jxpath:concat('enclosure',
$count, '-enclosed)

Usage notes

1. The storeAll parameter cannot be used with the datagroups or enclosure parameters in the same pipe. Doing so will result in an error.
2. The datagroups and enclosures parameters are mutually exclusive. You cannot use them in the same pipe. If you have both parameters, only the enclosures parameter will be used.
3. To avoid conflicts with data group extractions, you should use one ExtractEnclosurePipe for each data group you want to extract; do not try to process them all using a single pipe. If the pipeline has been configured to process all data group extractions using a single ExtractEnclosurePipe, conflicts can occur if users do not add enclosures to the form in the order that is expected.
4. To explicitly call the correct data group and avoid extracting the wrong one, ensure all data groups in the form have unique names.

Parameters

key:incomingform

ibm.ExtractInstancePipe.testPipeline4.
   instances.1.name = string:PurchaseOrder

ibm.ExtractInstancePipe.testPipeline4.
   instances.1.store = key:formdata

string:dom

key:jxpath:concat('instance', $count, '-data') 

Usage notes

1. Forms Services Platform requires data instances have an id attribute. If the data instance in the form does not contain an id attribute, ibm.ExtractInstancePipe will not be able to manipulate the data instance.
2. If instances is set, ExtractInstancePipe goes through the instances list, gets instance of given instanceID (name), storing it in the databucket as store.

Parameters

string:/samplePipeline3

pipe:ibm.RepoLoadPipe.samplePipeline3

pipe:ibm.RestoreMapPipe.samplePipeline3

pipe:ibm.ReturnErrorPipe.samplePipeline3

Example

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 

   ibm.HeadPipe.samplePipeline3.pidOutputs.action= pipe:ibm.RepoLoadPipe.
      samplePipeline3 

   ibm.HeadPipe.samplePipeline3.pidOutputs.view= pipe:ibm.RestoreMapPipe.
      samplePipeline3 

   ibm.HeadPipe.samplePipeline3.pidOutputs.error= pipe:ibm.ReturnErrorPipe.
      samplePipeline3

Usage notes

1. 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.
2. 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.

Using a registered FormService, this pipe builds a Form object from an array of bytes (byte[]), a String, or the current Request's input stream and stores the built form in the data bucket for other pipes to use.

Parameters

ibm.LoadFormPipe.myForm.flags.flag1 = 
   string:SERVER_SPEED_FLAGS
ibm.LoadFormPipe.myForm.flags.flag2 = 
   string:AUTOCOMPUTE_OFF
ibm.LoadFormPipe.myForm.flags.flag3 = 
   string:XFORMS_OFF

Example

The following example shows how to configure a typical LoadFormPipe. In this sample, the LoadFormPipe stores the submitted form as an Object in the data bucket, under the key newsForm. Once this is done, the next pipe in the sequence is triggered.

   ibm.LoadFormPipe.samplePipeline2.form=key:newsForm

   ibm.LoadFormPipe.samplePipeline2.input=key:formAsByte

   ibm.LoadFormPipe.samplePipeline2.pidOutputs.main=pipe:ibm.RepoLoadPipe.
      samplePipeline2

Usage notes

For detailed information on flags, see Java API 사용자 매뉴얼.

Parameters

key:formAsString

key:stringRequest

ibm.MapPipe retrieves mapinputdata and mapoutputdata from the data bucket, calling the Mapper Service to map the input source to the output source. It then stores the mapped output source back into the data bucket.

Parameters

service:mapping.impl.tx

TX Mapper Configuration

ibm.MapPipe.simpletx.mapinputdata.File1.
   data = key:txmap
ibm.MapPipe.simpletx.mapinputdata.File1.
   name = string:FormDataMap.mmc

ibm.MapPipe.simpletx.mapinputdata.TXMap 
   = string:FormDataMap.mmc

ibm.MapPipe.simpletx.mapinputdata.
   InputCard1.data = key:formdata

ibm.MapPipe.simpletx.mapoutputdata.
   OutputCard1.data = key:outputdata

For example, you might collect form data using the Action branch and then preserve that data using PreserveMapPipe so that it is available to the View branch for displaying to the user.

Parameters

string:formAsBytes,otherObject

Example

The following example show how to configure a typical PreserveMapPipe. In this case, only values with the key "newsForm" are preserved.

   ibm.PreserveMapPipe.samplePipeline3.keys = string:newsForm

Usage notes

• ibm.PreserveMapPipe is typically the last pipe in the Action branch of the pipeline. It must be used in conjunction with ibm.RestoreMapPipe, which is typically the first pipe in the View branch of the pipeline. ibm.PreserveMapPipe preserves objects from the data bucket while ibm.RestoreMapPipe returns them for use in the data bucket.

Parameters

string:http://<Translator server>:
   8085/translator

string:Pdf

pipe:ibm.CallPipelinePipe.ReturnDataPipe

Usage notes

ibm.PrintXFDLPipe uses the Webform Server Translator component's built in Print Service servlet. Most of the configuration parameters are passed in on the request to the Print Service servlet. If any changes occur to the parameters that the Print Service servlet accepts, then similar changes will need to be made to this pipe.

Parameters

string:SDK-repository0

string:sample/newsForm.xfdl

key:formAsByte

pipe:ibm.LoadFormPipe.samplePipeline3

Example

The following example shows how to configure a typical RepoLoadPipe. In this sample, the RepoLoadPipe loads the newsForm.xfdl file from the local File System Repository and stores it to the data bucket using the inputStream key. Once complete, LoadFormPipe is called.

   ibm.RepoLoadPipe.samplePipeline3.repo=string:SDK-repository0 

   ibm.RepoLoadPipe.samplePipeline3.path=string:sample/newsForm.xfdl

   ibm.RepoLoadPipe.samplePipeline3.storeAs=key:formAsBytes 

   ibm.RepoLoadPipe.samplePipeline3.storeAsFormat=string:inputStream 

   ibm.RepoLoadPipe.samplePipeline3.pidOutputs.main=
      pipe:ibm.LoadFormPipe.samplePipeline3

Usage notes

• string:SDK-repository0 represents the name of a running repository. The repository it represents will be different depending on which solutions you installed and which is running.
• If you use the RepoLoadPipe to load from the File System Repository and you specify that you want to store the item as an inputstream, you can only read the item from the data bucket once. If you want to use that item again, you need to reload the item again.

  An example that will not work:

   RepoLoadPipe a form, store as inputstream -> RepoStorePipe the same form -> 
       ReturnDataPipe the same form  

  An example that will work:

   RepoLoadPipe a form, store as inputstream -> RepoStorePipe the same form -> 
      RepoLoadPipe the same form -> ReturnDataPipe the same form

Description

RepoRESTPipe reads everything after path in the URL and then maps it to a particular REST call. If a match is found, RepoRESTPipe invokes the appropriate pipeline. For example, if filter = "/myPipeline/" and the inbound URL is http://server/wfsp/myPipeline/libraries/feed then this pipe will strip everything up to and including "/myPipeline/". The resultant string—libraries/feed—will then be matched against a supported set of REST API calls.

See IBM Forms Server – Forms Services Platform Repository REST API calls for details.

Parameters

Example

In the following example, the RepoRESTPipe configuration assumes that headPipe.sample.connection = string:/myPipeline/

   ibm.RepoRESTPipe.sample.filter= string:/myPipeline/

   ibm.RepoRESTPipe.sample.repos.1.key = string:library1 

   ibm.RepoRESTPipe.sample.repos.1.value = string:FSRepository1

   ibm.RepoRESTPipe.sample.repos.2.key = string:library2

   ibm.RepoRESTPipe.sample.repos.2.value = string:FSRepository2

   ibm.RepoRESTPipe.sample.repos.3.key = string:library3

   ibm.RepoRESTPipe.sample.repos.3.value = string:FSRepository3

   ibm.RepoRESTPipe.sample.storeContextAs = key:ibm.RepoRESTPipe.
      content

   ibm.RepoRESTPipe.sample.storeMimetypeAs = key:ibm.RepoRESTPipe.
      mimetype

   ibm.RepoRESTPipe.sample.pidOutputs.main = pipe:ibm.ReturnDataPipe.
      sample

   ibm.FSRepository.FSRepository1.name        = FSRepository1

   ibm.FSRepository.FSRepository1.description = Library Repository

   ibm.FSRepository.FSRepository1.root        = D:/Repositories/
      Libraries/FSRepository1

Usage notes

• Each supported REST operation is implemented in its own pipeline. For example, if the inbound URL is http://server/wfsp/myPipeline/libraries/feed, "libraries/feed" corresponds to a call that retrieves the list of all available libraries. In other words, this pipe will call the pipeline responsible for listing all available libraries.

Parameters

For example, use ibm.RestoreMapPipe to retrieve data from the Action branch of the pipeline for use in the View branch.

Parameters

string:locationdata,mappingdata

Example

The following example show how to configure a typical RestoreMapPipe. In this sample, the RestoreMapPipe specifies which preserved key-value pairs should be retrieved for use inside the pipeline's View branch. Once this is done, the next pipe is triggered.

   ibm.RestoreMapPipe.MySolutionSaveForm.keys = string:locationdata

   ibm.RestoreMapPipe.MySolutionSaveForm.pidOutputs.main = pipe:ibm.pdm6.ReturnPipe.
      MySolutionSaveForm

Usage notes

• The RestoreMap pipe is typically the first pipe in the View branch of the pipeline. It must be used in conjunction with the PreserveMap pipe, which is typically the last pipe in the Action branch of the pipeline. The PreserveMap pipe preserves Objects from the data bucket and the RestoreMap pipe retrieves them for use.

Description

Parameters

ibm.ReturnDataPipe.mypipeline.content = 
   key:form

string:application/vnd.xfdl

Additional parameters for XFDL form content

ibm.ReturnDataPipe.myPipeline.jsEnableViewer
    = string:true

Additional parameters for XFDL forms translated to HTML using Webform Server

Configuration - Using Webform Templates

• Map key instance (required) – This should resolve to a String, byte[] or InputStream that represents the XML instance.
• Map key ref (required) – This should resolve to a String that represents the XPath to the instance to be modified.
• Map key flag (optional) – This should resolve to a String that equals one of the following:
  • UFL_XFORMS_UPDATE_APPEND
  • UFL_XFORMS_UPDATE_INSERT_BEFORE
  • UFL_XFORMS_UPDATE_REPLACE
  If the flag is not provided or is invalid, UFL_XFORMS_UPDATE_REPLACE will be used.
• Map key model (optional) – This should resolve to a String that matches the model to be modified. If not provided, the default model will be used.

See ibm.WebformTemplatePipe for details.

Usage notes

• If the content data is a String it is converted to a byte[] using UTF-8 encoding.
• ReturnDataPipe can be used to collect a form object preserved by another pipe (such as LoadFormPipe) and return it to the user.
  To do this:

  1. Identify the form object you want to return to the user. This object is specified by the key it was stored under.
     For example:

      ibm.ReturnDataPipe.SamplePipeline.content = key:sampleForm

  2. To display a form, you must use the application/vnd.xfdl mimetype.
     For example:

     ibm.ReturnDataPipe.SamplePipeline.mimetype = string:application/vnd.xfdl

• autoDetect mode assumes that the current request originated from a standalone Viewer 3.0 or newer, or from a Web browser with the response being returned to that Web browser. autoDetect mode cannot be used when accessing the Forms Services Platform with requests created via the PlatformJavaAccess.createRequest(String pipelineURI) method or when handling a submission from a standalone Viewer older than version 3.0
• You cannot use ReturnDataPipe when the xfdlHandlingMode parameter is set to autoDetect or html to submit a form from a standalone Viewer to a pipeline that will return any form back to the user. You can use ReturnDataPipe if you submit and return the form using a browser-embedded Viewer.
• Under certain circumstances, using html or autoDetect with cancelURL and xformsReplaceAllSubmitURL will not work when forms are rendered with Webform Server.

  The following scenario will not work: Form A with URL http://server:port/wfsp/wfsp/samplePipe is rendered with Webform Server. Form A has a Cancel button or a button that performs an XForms replace all submission. When one of these buttons is clicked, form B is rendered in Webform Server. In the same browser session, if you load form A again with the same URL, form A will load but neither the Cancel button nor the XForms Replace All button will work.

Description

Depending on the errorFormat string, this pipe creates an XML or an HTML file (for viewing the errors).

Parameters

string::html

Description

Parameters

Usage notes

• This pipe can only be executed from the View branch.
• The ViewerDetectionPipe assumes that the current request originated from a standalone Viewer 3.0 or newer, or from a Web browser with the response being returned to that Web browser. The ViewerDetectionPipe cannot be used when accessing the Forms Services Platform with requests created via the PlatformJavaAccess.createRequest(String pipelineURI) method or when handling a submission from a standalone Viewer older than version 3.0
• If you are using the standalone Java Access API, then you cannot use the ViewerDetectionPipe.