What is Piping?
Piping uses special codes to insert a form user's answers into the text of your form. You can retrieve these codes by using the "Insert Pipe" dialog, or by looking in the bottom right corner of the source item's settings page.
Pipe codes can be inserted into almost any text on your form, including:
- Item question text and answer text
- Notification messages
- Success Page messages and redirect URLs
Pipe Code Format
Item Pipe codes use the format:
[pipe:x] or [pipe:x?default] or [pipe:x?]
- Use
[pipe:x]to pipe in the item's answer. x is the item's ID. If the form user didn't answer the source item, the pipe code will remain. - Use
[pipe:x?default]to pipe in a default value if the form user didn't answer the source item. x is the item's ID and default is the default value. - Use
[pipe:x?]to pipe in nothing (remove the pipe code) if the user didn't answer the source item. x is the item's ID.
Answers piped from text field item types will be inserted exactly as entered by the user. Multiple answers piped from multiple choice item types will be comma separated. "Other" answer choices piped from multiple choice item types will be inserted exactly as entered by the user.
Special Pipe Codes
In addition to item Pipe codes, there are special Pipe codes for additional information:
- Use
[pipe:reference_#]to pipe in the reference number of the form user's result. - Use
[pipe:repetition_#]to pipe in the number of times a repeating page has been repeated. - Use
[pipe:total_score]or[pipe:max_score]to pipe in the scoring total for Scoring. - Use
[pipe:order_total]to pipe in the order total for Order Forms. - Use
[pipe:save_return_user]to pipe in the logged in username for Save & Return. - Use
[pipe:save_return_email]to pipe in the logged in email address for Save & Return.
Pipe Locations
Pipes can only be used on pages after their source item. For example, any answers you collect on page 1 won't be available for Piping until page 2. You can split your form into multiple pages by adding Page Break items.
Pipes can be added freely to Notifications and Success Pages, since these always come after your form.