Elements and Sections in the Custom Web Links XML Output File

The following table describes the elements and sections in the custom Web links XML output file.

Table Elements and Sections in the Custom Web Links XML File

Description	Element or Section
<ObjectName> contains the system name of the record type (object), which never changes.	`<data:ObjectName>Account</data:ObjectName>`
The <ListOfWebLinks> section contains details of the custom Web links.	`<data:ListOfWebLinks> . . . </data:ListOfWebLinks>`
The <WebLink> section contains details of one custom Web link.	`<data:WebLink> . . . </data:WebLink>`
<Name> contains the system name of the custom Web link.	`<data:WebLink> <data:Name>MyWebLink</data:Name> . . . </data:WebLink>`
<IntegrationTag> contains the custom language-independent integration tag for the custom Web link.	`<data:WebLink> . . . <data:IntegrationTag>My_Web_Link </data:IntegrationTag> . . . </data:WebLink>`
<DisplayText> contains the display text that appears in the custom Web link field.	`<data:WebLink> . . . <data:DisplayText>MyDisplayText</data:DisplayText> . . . </data:WebLink>`
<WebLinkTarget> specifies the behavior when a user clicks the link. This element can have the following values: Open in Current window. If this value is specified, then in the UI, the linked page opens in the current window. Open in New window. If this value is specified, then in the UI, the linked page opens in a new window. Open in Custom Tab. If this value is specified, then in the UI, the linked page opens in a custom tab.	`<data:WebLink> . . . <data:WebLinkTarget>Open in Custom Tab </data:WebLinkTarget> . . . </data:WebLink>`
<TargetCustomWebTab> specifies the custom Web tab, if Open in Custom Tab is specified in <WebLinkTarget>.	`<data:WebLink> . . . <data:TargetCustomWebTab>MyCustomWebTab </data:TargetCustomWebTab> . . . </data:WebLink>`
<RefreshParentWindow> specifies whether the parent window is refreshed after the user closes the new window in which the linked page opened (true). This element is applicable only if Open in New window is specified in <WebLinKTarget>.	`<data:WebLink> . . . <data:RefreshParentWindow>false </data:RefreshParentWindow> . . . </data:WebLink>`
<DisplayOptions> specifies the type of page in which the custom Web link can be displayed. This element can have the following values: D. Detail pages only. E. Edit pages only. B. Both detail pages and edit pages.	`<data:WebLink> . . . <data:DisplayOptions>B</data:DisplayOptions> . . . </data:WebLink>`
<ActiveLinkCondition> specifies the condition that controls whether the link is active on the detail and edit pages.	`<data:WebLink> . . . <data:ActiveLinkCondition>TRUE </data:ActiveLinkCondition> . . . </data:WebLink>`
<DisplayLinkCondition> specifies the condition that controls whether the link is displayed on the detail and edit pages.	`<data:WebLink> . . . <data:DisplayLinkCondition>TRUE </data:DisplayLinkCondition> . . . </data:WebLink>`
<Type> defines the type of the custom Web link, which is one of the following: Dashboard Report URL	`<data:Type></data:Type>`
If the custom Web link type is Dashboard, then the details appear in the <DashboardType> section, as follows: <DashboardPath> contains the path to the dashboard. The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level. <DashboardParameters> specifies any parameters that are to be applied at runtime. If any filter parameters are present, then the syntax of those parameters is validated when you insert or update a custom Web link of the Dashboard type. For information about specifying parameters for embedded dashboards, see Oracle CRM On Demand Online Help.	`<data:DashboardType> <data:DashboardPath> Company Wide Shared Folder : Dashboards : Accounts Dashboard </data:DashboardPath> <data:DashboardParameters> P0=1&P1=eq&P2="Account"."Account ID"&P3=%%%Row_Id%%% </data:DashboardParameters> </data:DashboardType>`
If the custom Web link type is Report, then the details appear in the <ReportType> section, as follows: <ReportPath> contains the path to the analysis. The analysis must be located under Shared Folders. <ReportParameters> specifies any parameters that are to be applied at runtime. If any filter parameters are present, then the syntax of those parameters is validated when you insert or update a custom Web link of the Report type. For information about specifying parameters for embedded analyses, see Oracle CRM On Demand Online Help. Note: If the <ReportPrompts> element is set to true, then any filters that are specified in the <ReportParameters> element are ignored at runtime, even if no prompts are defined for the analysis. <ReportPrompts> corresponds to the Display Report Prompts check box in the UI. It determines whether any prompts that are defined for the analysis are displayed at runtime (true) or are not displayed (false). <RefreshLink> determines whether the Refresh link that allows users to refresh the data in the analysis is displayed at runtime (true) or is not displayed (false). <PrintLink> determines whether the Print link that allows users to print the analysis is displayed at runtime (true) or is not displayed (false). <ExportLink> determines whether the Export link that allows users to download the analysis is displayed at runtime (true) or is not displayed (false).	`<data:ReportType> <data:ReportPath> Company Wide Shared Folder : My Company Account Custom Analyses : Account Custom Analysis </data:ReportPath> <data:ReportParameters> P0=1&P1=eq&P2="Account"."Account ID"&P3=%%%Row_Id%%% </data:ReportParameters> <data:ReportPrompts>false</data:ReportPrompts> <data:RefreshLink>true</data:RefreshLink> <data:PrintLink>true</data:PrintLink> <data:ExportLink>true</data:ExportLink> </data:ReportType>`
<URL> specifies the URL that is invoked when the user clicks the custom Web link (for custom Web links of the URL type only). Note: Although it is possible to update or insert a custom Web link that contains a URL for an analysis or dashboard, this functionality is not fully supported, and the URL might not work after an upgrade.	`<data:WebLink> . . . <data:URL>http://www.someURL.com</data:URL> . . . </data:WebLink>`
The <ListOfWebLinkTranslations> section contains the translation values for the custom Web link.	`<data:WebLink> . . . <data:ListOfWebLinkTranslations> . . . </data:ListOfWebLinkTranslations> . . . </data:WebLink>`
The <WebLinkTranslation> section contains the translation values for one language: <DisplayName> contains the display name for the Web link field in the language identified by the language code. <DisplayText> contains the display text for the Web link field in the language identified by the language code. <LangCode> contains the three-letter code for a language. For the list of language codes, see Language Codes and Their Corresponding Language and Country.	`<data:WebLink> . . . <data:ListOfWebLinkTranslations> <data:WebLinkTranslation> <data:DisplayName>MyWebLink</data:DisplayName> <data:DisplayText>Click here</data:DisplayText> <data:LangCode>ENU</data:LangCode> </data:WebLinkTranslation> . . . </data:ListOfWebLinkTranslations> . . . </data:WebLink>`