Oracle Migration Tool On Demand Guide > Migrating Custom Web Applets > Migrating Custom Web Applets >

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.

NOTE:  The Enable Web Services Access and Customize Application privileges are required to run the Upsert operation.

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.

Table 29 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.

Table 29. Result of an Upsert Operation on a Target Company
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:

  • My Custom Applet
  • MY Custom Applet

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:

  • For the Account object: My Custom Applet
  • For the Opportunity object: My Custom Applet

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:

  • For the Account object: My Custom Applet
  • For the Global Web Applet section: My Custom Applet

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

NOTE:  The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (by using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

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.

Oracle Migration Tool On Demand Guide, Release 35 Copyright © 2017, Oracle and/or its affiliates. All rights reserved. Legal Notices.