9Migrating Custom Web Link Fields
Migrating Custom Web Link Fields
This chapter describes how to migrate custom Web link fields using the Oracle Migration Tool On Demand client. It contains the following topics:
Custom Web Link Fields
Custom Web link fields allow you to create context-sensitive hyperlinks in your page layouts.
The following table describes the Oracle Migration Tool On Demand client commands used with custom Web link fields. For more information about running these commands, see Migrating Custom Web Link Fields.
Table Commands Used with Custom Web Link Fields in Oracle Migration Tool On Demand
Command | Description |
---|---|
|
This command exports all custom Web link fields for a specific record type (object). SystemNameOfObject is the system name of the record type. The system names for the record types are listed in System Names for Record Types. |
|
This command exports all custom Web link fields for all objects. |
|
This command updates or inserts a custom Web link, as required. |
Privileges Required for Migrating Custom Web Link Fields
The following privileges are required for the user account running the Oracle Migration Tool On Demand client commands:
For the
Read
andReadAll
command: Enable Web Services Access and Customize Application.For the
Upsert
command: Enable Web Services Access, Customize Application, and Manage Object Access for custom objects that have been set up in the company tenant, for example, Customize Application - Manage Custom Object 01, and so on.
For information about setting and checking privileges, see Oracle CRM On Demand Online Help.
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:
|
<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:
|
<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:
|
<data:Type></data:Type> |
If the custom Web link type is Dashboard, then the details appear in the <DashboardType> section, as follows:
|
<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:
|
<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:
|
<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> |
Migrating Custom Web Link Fields
The following topics provide examples of how to use the Oracle Migration Tool On Demand client to migrate custom Web link fields:
Extracting Custom Web Link Fields for a Single Object
This topic describes how to extract the custom Web link fields for a single object (for example, the Account object) from your Oracle CRM On Demand server for your environment (customer test environment or production).
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to extract the custom Web link fields for a single object:
migrationtool -u UserID -s ServerURL Read CustomWebLink SystemNameOfObject
where:
UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.
ServerURL is the URL for the Oracle CRM On Demand server where your company resides.
SystemNameOfObject is the system name of the object (record type) for which you want to extract all custom Web links fields, for example, Account. The system names for the record types are listed in System Names for Record Types.
Example of Extracting Custom Web Link Fields for a Single Object
The following is an example of extracting the custom Web link fields for a single object:
migrationtool -u UserID -s ServerURL Read CustomWebLink Account
Extracting Custom Web Link Fields for All Objects
This topic describes how to extract all custom Web link fields for all objects from your Oracle CRM On Demand environment (customer test environment or production).
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to extract all custom Web link fields for all objects:
migrationtool -u UserID -s ServerURL ReadAll CustomWebLink
where:
UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.
ServerURL is the URL for the Oracle CRM On Demand server where your company resides.
Example of Extracting All Custom Web Link Fields
The following is an example of extracting all custom Web link fields for all objects from your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL ReadAll CustomWebLink
Updating or Inserting Custom Web Link Fields (Upsert)
This topic describes how to update custom Web link fields (if they exist) or insert custom Web link fields (if they do not exist) on your Oracle CRM On Demand environment (customer test environment or production).
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to update custom Web link fields (if they exist) or insert custom Web link fields (if they do not exist):
migrationtool -u UserID -s ServerURL Upsert CustomWebLink CustomWebLinkXML
where:
UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.
ServerURL is the URL for the Oracle CRM On Demand server where your company resides.
CustomWebLinkXML is the fully qualified path name of the custom Web link XML file, for example:
C:\My Files\MyCustomWebLink.xml
Example of Updating or Inserting Custom Web Link Fields
The following is an example of updating custom Web link fields (if they exist) or inserting custom Web link fields (if they do not exist) in your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL Upsert CustomWebLink "C:\My Files\MyCustomWebLink.xml"