You are here:
Customize a Visualforce Component to Control the Flow's Finish Behavior
By default, users who click Finish start a new interview and see
the first screen of the flow. After you embed a flow in a Visualforce page, configure the
finishLocation attribute to route users to another
page in Salesforce.
Set finishLocation with the URLFOR
Function
- You can’t redirect flow users to a URL that’s external to your Salesforce org.
- Don’t call the
Auth.SessionManagement.finishLoginFlowmethod and thefinishLocationattribute in the same flow.Auth.SessionManagement.finishLoginFlowindicates the end of a Visualforce page login flow. IffinishLocationis in the same flow,finishLocation
To route users to a
relative URL or a specific record or detail page, using its ID, use the URLFOR function.
This example routes users to the Salesforce home page.
<apex:page>
<flow:interview name="MyUniqueFlow" finishLocation="{!URLFOR('/home/home.jsp')}"/>
</apex:page>This example routes users to a detail page with an ID of 001D000000IpE9X.
<apex:page>
<flow:interview name="MyUniqueFlow" finishLocation="{!URLFOR('/001D000000IpE9X')}"/>
</apex:page>For details about URLFOR, see Functions in the
Visualforce Developer’s Guide.
Set finishLocation with the $Page
Variable
To route users to another Visualforce page without using
URLFOR, set finishLocation to the name of the destination
page with the format {!$Page.pageName}.
<apex:page>
<flow:interview name="MyUniqueFlow" finishLocation="{!$Page.MyUniquePage}"/>
</apex:page>For details about $Page, see Global Variables in
the Visualforce Developer’s Guide.
Set finishLocation with a Controller
You can set finishLocation in a few ways with a custom controller.
This sample controller configures a flow's finish behavior in three different ways.
public class myFlowController {
public PageReference getPageA() {
return new PageReference('/300');
}
public String getPageB() {
return '/300';
}
public String getPageC() {
return '/apex/my_finish_page';
}
}
getPageAinstantiates a new page reference by passing a string to define the location.getPageBreturns a string that is treated like a PageReference.getPageCreturns a string that gets translated into a PageReference.
Here’s a sample Visualforce page that references the controller and sets the flow finish behavior to the first option.
<apex:page controller="myFlowController">
<h1>Congratulations!</h1> This is your new page.
<flow:interview name="flowname" finishLocation="{!pageA}"/>
</apex:page>
If you use a standard controller to display a
record on the same page as the flow, users who click Finish
start a new flow interview. They see the first screen of the flow, without the
record, because the id query string
parameter isn't preserved in the page URL. If needed, configure the finishLocation to route users back to the
record.
