Types of Pages
A survey template automatically includes a first page (Initial Page) when created. As you add questions, sections, text, and images to your survey template, they will be added to a page. You can add pages to split up the content of your survey template, provide a review of what has been submitted, or mark completion of the survey and provide the customer with concluding information.
There are three types of pages
- Contents page - most common, used for collecting answers.
- Review page - used to present a view of a submitted request, can also have questions and other elements.
- Confirmation page - last page in the survey template, sets request to complete.
To add a page to your survey template use the following steps:
- Click the Add button on the right side of the Pages tab, then click Add Page in the add elements dialogue.
- Enter a Page Name - must be unique in the survey template.
- Select the Page Type - Contents, Confirmation, or Review.
- If needed, enter a Submit Button Value - will default to a configuration value (Submit).
- If needed, check the box Enable Previous Button and enter a name for the button - not available on the first page
- Check box option to Clear Answers on return to a previously submitted page
- Select the alignment of the buttons, Horizontal or Vertical
- Set Branching if needed - see section below.
- Set Styles for the page on the Styles tab - see Styles article.
- Set Events if needed - see Events article.
- If you need to run custom Remedy workflow, check the box on the Advanced tab.
Example of Initial Page:
A contents page is the default selection when a new page element is created. It will be created at the bottom of the list of elements of the page you are currently building. Contents pages have a submit button, and answers will be saved to the database on submit.
You must provide a name, but the rest of the values can be left to defaults.
If you would like a specific jsp page to be used, enter or select a value in the Display page (JSP) field.
Previous Button Options
Content and Review pages have the option to go back to the previous page in a request. Review pages build this automatically.
Once you check Enable Previous Button, you need to enter a name for the button, decide if you want to Clear Answers, and set an alignment.
Clear answers only works when you come back to a page that has been completed.
Choices for Button Alignment are Horizontal and Vertical.
If you select Review as the Page Type, workflow automatically populates some fields.
All of these settings are changeable.
Workflow also creates an event and a specific text element to display the answers and elements from all previous pages in the survey template.
Workflow created text element is an iFrame that depends on the event detailed above.
Creating Your Own Review Request URL
The Review Request functionality is also available through a URL, just like calling an Anonymous survey template. The sections below detail how to create the URL and what parameters are available.
Example Basic URL:
/kinetic/ReviewRequest? is required for all review request URLs. There are a variety of parameters that can be added after the ?
csrv - The instanceId of the KS_SRV_CustomerSurvey_base record to display.
Appended after the required parameter with the & character.
exclude - comma-separated list of page numbers to exclude from the review (index starts at 1).
excludeByName - comma-separated list of page names to exclude from the review.
- http://MyCompany/kinetic/ReviewReque...udeByName=Page 2
- http://MyCompany/kinetic/ReviewReque...udeByName=Page 2, Page 4
loadAllPages - if “true” all pages in the request are loaded at once. If “false” the contents of the first page will be displayed, and the other content pages will be displayed as tabs. If no value for this parameter is supplied, the value defaults to “true”.
reviewPage – the name of the jsp page that is used to render the submitted request. The “.jsp” extension should be omitted from the value. If no value for this parameter is supplied, the value defaults to the “reviewRequest.jsp” located in the web application root directory.
To open the review request using a the jsp page located at <webapp>/themes/company/reviewPage.jsp, the following URL could be used:
A confirmation is the last page in a survey, and sets the status to completed. No answers are submitted from a confirmation page. This type of page is normally used only to thank or redirect the customer.
When you select Confirmation from Page Type setting the Submit Button value is not available.
Page branching allows you to skip ahead to pages farther into your survey template, based upon data entered by the customer. They are only allowed to move ahead in the survey with page branching, to go back to previous pages, see the steps for ‘Previous Button’ above.
Example of Page Branching:
To create a branch for a survey template, follow the steps on the tab.
- Select the page you want to branch to.
- Enter a name/description for the branch.
- Select a Qualification - see below for qualification example.
- Save your branch.
Example of qualifications:
The fields drop-down gives you access to all the questions and attributes. You can then combine that with the logical operators and static values. There is a Remedy function that checks for a valid qualification when the OK button is clicked.
You can have multiple brances from a single page. The Options Order column shows the order they are evaluated. Once a branch passes the qualification no other branches are checked.
To modify a branch select the branch from the table on the bottom of the branches tab. This will set the values in the individual branch fields. Make your changes, and remeber to click Save.
The basics of the Style Tab is covered under the Question element style tab.
On a Page element there are the following differences:
You have the option to select from three possible elements, Page, Submit Button, or Back Button.
Example of Add Style dialog:
Selecting Add Page Style presents you with a nearly identical dialog to the question Add Style dialog. The only difference is the options presented on the Style Type drop-down.
Drop-down options for pages:
HTML Tag can be any tag, and comes with a drop-down list on the Style Selector of avaialable tags.
CSS Class will take any valid class name, and that class is added to the page.
Combined is normally a combination of existing classes and HTML tags.
HTML ID sets an element ID style that is a combination of the prefix PAGE_ and the instance ID of the page
Submit Button Style
If you select Add Submit Button Style, the dialog is very similar to a question element. The Style type is set to HTML ID, and your two options are:
Button - apples directly to the button - known as BUTTON_ combined with input HTML tag
Button Layer - applies to the div around the button - known as BUTTON_
Previous Button Style
Selecting the Add Previous Button Style is the same as the Submit Button, except for the button it applies to, and the fact that it is not avaiable on the inital page of a survey template.
Events are covered in its own article here.
The only item on the Advanced tab for a page is an option to Run Custom Logic. In previous versions of the application, the Remedy workflow would always check to see if there was any custom Remedy workflow that needed to be run when a page is submitted. Now, the application will only check if this box is checked. This saves time when submitting pages by eliminating unneeded Remedy workflow.
The filter guide that is checked for workflow is called KS_SRV_CustSurveyResultsJoin_RunCustomLogic.