Updating or Inserting a Client Side Extension

This topic describes how to update a client side extension (if it exists) or insert a client side extension (if it does not exist) on your Oracle CRM On Demand environment (customer test environment or production).

About the Upsert Operation

The Upsert command inserts or updates a client side extension based on the user key: Name.

Oracle CRM On Demand attempts to locate the client side extension specified in the input file based on the user key. If a match is located, then the client side extension is updated. If Oracle CRM On Demand cannot locate a client side extension based on the user key, then a new client side extension is created.

For an upsert operation, the attachment to be uploaded must be saved in a subdirectory of the directory where the client side extension XML file is saved, and the subdirectory must have the same name as the client side extension. The subdirectory must also contain a metadata text file that has the same name as the client side extension and is saved with the .metadata file extension. In the metadata file, the information for the file must be specified in the following format:

FileName: filename.fileextension
Content-Id: content-id
Content-Type: MIMEtype

where:

filename must match the value in the <FileName> element in the XML file that contains the configuration data for the client side extension.
fileextension must match the value in the <Extension> element in the XML file that contains the configuration data for the client side extension.
content-id must match the content-id value in the <FileData> element in the XML file that contains the configuration data for the client side extension.
MIMEtype must match the value in the <MIMEType> element in the XML file that contains the configuration data for the client side extension.

For example:

FileName: logo.jpg
Content-Id: Logo2021
Content-Type: image/jpeg

Note: When you extract client side extensions, the metadata file is generated automatically and is saved together with the attachment file in the subdirectory for the client side extension.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to insert or update a client side extension:

migrationtool -u UserID -s ServerURL Upsert ClientSideExtension ClientSideExtensionXML

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.
ClientSideExtensionXML is the fully qualified path name of the client side extension XML file, for example:
```
C:\My Files\logo.xml
```
If the fully qualified path name contains any spaces, then it must be enclosed with quotation marks, for example:
```
migrationtool -u UserID -s ServerURL Upsert ClientSideExtension "C:\My Files\logo2021.xml"
```

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

Example of Updating or Inserting a Client Side Extension

The following is an example of updating a client side extension (if it exists) or inserting the client side extension (if it does not exist) in your Oracle CRM On Demand server:

migrationtool -u UserID -s ServerURL Upsert ClientSideExtension "C:\Oracle Migration Tool On Demand\windows\repository\Client Side Extension\logo2021.xml"

Note: Quotation marks are required only if the fully qualified path name contains spaces.