Skip to main content

The curious case of the custom redirection on Salesforce Console



Every developer worth their salt knows that the easiest way of redirection from a page to another is by using everyone's favorite function

  public PageReference redirect() {
       PageReference pageRef = page.peskyProblemRedirection; 
       pageRef.setRedirect(true); 
       return pageRef; 
    }

And the method is called by adding it to the Action attribute of the CommandButton or link, which works like charm and the user is redirected to the page after completion of the action.
So why am I going back to the basics? Because this way of redirection causes a pesky little problem in using the Service Cloud or Sales Cloud console.

Let's illustrate the problem, let's say you have a visualforce page as follows:

<apex:page sidebar="false" showHeader="false" controller="myExampleController">
<apex:form >
<apex:pageBlock >    
  
         <apex:pageBlockButtons >
             <apex:commandButton action="{!Redirect}" value="Next Page"/>
          </apex:pageBlockButtons>
     
  </apex:pageBlock>
  </apex:form>
</apex:page>

The controller to this class is as follows:

public with sharing class myExampleController {
  public PageReference redirect() {
       PageReference pageRef = page.peskyProblemRedirection; 
       pageRef.setRedirect(true); 
       return pageRef; 
    }
}

This does what it says, you click a button and it takes you to the next page seamlessly.

The Problem

But now let's see when this page is added to the Salesforce Console.
Let's run the same code inside the console.

1. This is our first page
2. If we take a peek under the hood, we open the link of the tab inside the console and it shows our first page. PeskyProblemPage


3. Do the thing, click on next page and voila, we are redirected to the next page- as expected.

4. But here is where the problem starts- if we take a peek under the hood of the second page, we see things are not as they seem. If we click on the link of our second page as shown in annotation number 2 in the figure below, we notice that the link has not changed as shown in annotation number 3


Why is this a problem? That is because Salesforce does not auto refresh its pages every time and let's say the user refreshes the second page- it reopens the first one because the link still points to the first page. So what works here? The console toolkit, that can be referenced here, tells us that most of the console can be accessed navigated by using a Javascript library.


Solution

One solution for this issue is the use of Native OpenPrimaryTab method of the Console toolkit API. So we rewrite the page again using the Console Toolkit API, this time, however, we will set the redirection on the page itself.

So our new Page becomes as follows:

<apex:page>
    <apex:includeScript value="/support/console/28.0/integration.js" />
    <script type="text/javascript">
        //Get the enclosing primary tab, if you want to open a new tab, ignore this method
        var openPrimaryTab = function openPrimaryTab() {
            sforce.console.getEnclosingPrimaryTabId(callOpentab);
        }

        //Whatever the result, open it in the same tab
        var callOpentab = function callOpenSubtab(result) {
            sforce.console.openPrimaryTab(result.id,
                '/apex/peskyProblemRedirection', true, 'Page two');
        };

    </script>

    <apex:form>
        <apex:pageBlock>
            <apex:sectionHeader title="Page one" />
            <apex:pageBlockButtons>
                <apex:commandButton onclick="openPrimaryTab()" value="Next Page" />
            </apex:pageBlockButtons>
        </apex:pageBlock>
    </apex:form>

</apex:page>
As you can see, the magic happens using the onclick function that sets the page redirection on a console. If there is an action to perform before redirection, the same function can be used in oncomplete attribute of the button.

Taking this further,

This example above gives us the basic idea of how the redirection works on the console. Let's say you need to generate a dynamic page URL based on the data manipulation in the action method. E.g., send accountID to the new page from the tab. This can be achieved by using javascript remoting and calling the apex method in javascript. Take a look at the UNTESTED code below, that can get you started on exploration:


<script type="text/javascript">
    function getRemoteAccount() {
        Visualforce.remoting.Manager.invokeAction(
            '{!$RemoteAction.AccountRemoter.getAccount}',
            accountName,
            function(result, event) {
                if (event.status) {
                    sforce.console.openPrimaryTab(null,
                        '/apex/peskyProblemRedirection?id=' + result.id,
                        true, 'Page two');

                 }
            }, {
                escape: true
            }
        );
    }

 </script>

The possibilities are only limited by your imagination. Working with the Console in the past couple of years has given a greater sense of many things Salesforce developers usually take for granted. But once you get hang of it, Console is the best product ever made by Salesforce (Yes better than Lightning too!!!)

Have you encountered this problem before? Do you have any other solution? Share your experience in the comments below
Labels:

Comments

Post a Comment

Popular Post

The unofficial guide to become a Certified Salesforce Administrator (ADM 201)

In my attempt at maximum certifications in 60 days, I completed Salesforce Certified Administrator exam on February 11th 2013 So you have decided to ramp up your career and take certifications in your hand. Good choice. It is also likely that this is the first time you have heard of Salesforce, certification and since your company has a vision of you completing the certification you have decided to do it. At this stage it is likely that, You have done extensive googling. You have received countless brain-dumps. And you have received plenty of advise from different types of users which ranges from Admin certification is easier than making coffee to Admin certification is tougher than building a rocket-ship to fly off to the moon. The purpose of this guide is to give you a clear understanding of what to expect when you are expected to become Certified Salesforce Administrator. To bring sense to all the things you have seen so far and to clearly explain what to do and what
72 comments
Read more

Some PDF tricks on Visualforce: Landscape, A4, page number and more

The beauty of Visualforce is simplicity. Remember the shock you received when you were told the entire page renders as PDF if you just add renderAs=PDF to the Page tag. For those who thought I spoke alien language right now, here is the trick, to render a page as PDF, we add a simple attribute to the <apex: page> tag <apex: page renderAs='pdf'> This will render the entire page as PDF. Now, say we need to add some extra features to the PDF. Like a page number in the footer or we need to render the page in landscape mode. Faced with this problem, I put on my Indiana Jones hat and went hunting for it in the vast hay-sack of the internet (read: googled extensively). Imagine my happiness when i found a big big page with many big big examples to solve the problem. The document I am referring to is from W3C, paged Box media . Long story short, I now possess the ultimate secret of rendering the page in any format I want. So here are few tricks I learned from the p
17 comments
Read more

The Basics of writing a Apex Trigger

One of the most important and common asked question on Forums and everywhere is how do I write a trigger. Coding in Apex Trigger is like going to a dentist for a root canal, you keep dreading the moment until you realize it is actually not going to hurt you. If you plan to write an Apex Trigger this quick guide will help you doing so. The first and foremost rule in writing a trigger is to remember the oldest suggestion given to the most comprehensive Hitchhikers Guide to Galaxy, ' Don't Panic. ' Writing a trigger is not a rocket science, in-fact we should thank the team at Salesforce and ForceDotCom for making everything so simple, that anyone can do it. Enough of talk, lets code. So you want to write a trigger. Let us have a glimpse of what we are going to build. The problem statement is as follows Problem:  When the User is entering the Opportunity, check for the Opportunity Amount. If the Opportunity Amount is greater than 50,000. Mark the Parent Account as
21 comments
Read more