Updating or Inserting a Custom Web Applet Definition (Upsert)
This topic describes how to update a custom Web applet definition (if it exists) or insert the Web applet definition (if it does not exist) in your Oracle CRM On Demand environment; that is, a customer test environment or production environment.
The configuration data is updated when the Web applet name exists in the target company for the object or record for which the Upsert operation is being run; otherwise the Web applet is inserted.
The following table shows the result of an Upsert operation if the target company has a Web applet called My Custom Applet for the Account object on the detail page.
If the XML definition contains... | Then the result is ... |
---|---|
Name: My Custom Applet Object: Account Location: Detail Page |
The existing My Custom Web Applet is updated for the Account object, which is on the detail page. |
Name: MY Custom Applet Object: Account Location: Detail Page |
MY Custom Applet is inserted into the target company. The company now contains the following Account Web Applets:
|
Name: My Custom Applet Object: Opportunity Location: Detail Page |
My Custom Applet is inserted into the target company for the Opportunity object. The company now contains:
|
Name: My Custom Applet Object: Global Location: Action Bar |
My Custom Applet is inserted into the target company for the Global Web Applet section. The company now contains:
|
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to update a custom Web applet (if it exists) or inserting the custom Web applet (if it does not exist):
migrationtool -u UserID -s ServerURL Upsert WebAppletType MyWebAppletXML
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.
WebAppletType is one of the following:
HomepageCustomWebApplet
DetailPageCustomWebApplet
ActionBarCustomWebApplet
HomeTabCustomWebApplet
MyWebAppletXML is the fully qualified path name of the customized Web applet XML file, for example:
C:\My Files\MyWebApplet.xml
Examples of Updating or Inserting a Custom Web Applet
The following are examples of updating a custom Web applet (if it exists) or inserting the Web applet (if it does not exist) in your Oracle CRM On Demand server:
For homepage custom Web applets:
migrationtool -u UserID -s ServerURL Upsert HomepageCustomWebApplet "C:\My Files\MyHomepageCustomWebApplet.xml"
For Detail page custom Web applets:
migrationtool -u UserID -s ServerURL Upsert DetailPageCustomWebApplet "C:\My Files\MyDetailPageCustomWebApplet.xml"
For Action bar custom Web applets:
migrationtool -u UserID -s ServerURL Upsert ActionBarCustomWebApplet "C:\My Files\MyActionBarCustomWebApplet.xml"
For Home tab custom Web applets:
migrationtool -u UserID -s ServerURL Upsert HomeTabCustomWebApplet "C:\My Files\MyHomeTabCustomWebApplet.xml"
Note: Quotation marks are required if the file name or path contains spaces.