Salesforce Console Integration Toolkit Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

openSubtab()

Usage

Opens a new subtab (within a primary tab) that displays the content of a specified URL, which can be relative or absolute. You can also override an existing subtab. Use to open a new subtab on a primary tab via the primary tab's ID. This method is only available in API version 20.0 or later.

If there's an error opening the tab, the error code is reported in the JavaScript console.

Syntax

Arguments

Name Type Description
primaryTabId string ID of the primary tab in which the subtab opened.
url URL URL of the opened subtab.

If the URL is to a Salesforce object, that object displays as specified in the Salesforce console app settings. For example, if cases are set to open as a primary tab, and openSubtab() is called on a case, the case opens as a primary tab.

Note that users can open an external URL if it has been added to the console’s whitelist. For more information, see “Whitelist Domains for a Salesforce Console” in the online help.
active boolean If true, the opened subtab displays immediately. If false, the opened subtab displays in the background and the current tab maintains focus.
tabLabel string Optional label of the opened subtab. If a label isn't specified, External Page displays.

Add labels as text; HTML isn't supported.
id string ID of the subtab to override.

Use null to create a new subtab.
callback function JavaScript method called upon completion of the method.
name string Optional name of the opened subtab.

This argument is only available in API version 22.0 and later.

Sample Code–Visualforce

This example is set to run by clicking a custom link on a case. For more information, see “Defining Custom Buttons and Links” in the Salesforce online help.

Note

Response

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following fields:

Name Type Description
success boolean true if the subtab successfully opened; false if the subtab didn't open.
id string ID of the subtab. IDs are only valid during a user session; IDs become invalid when the user leaves the Salesforce console.