1. Oracle Migration Tool On Demand Guide
  2. Elements and Sections in the Client Side Extensions XML Output File

Elements and Sections in the Client Side Extensions XML Output File

The following table describes the elements and sections in the client side extensions XML output file.

Table Elements and Sections in the Client Side Extensions XML File

Description Element or Section

The <ClientSideExtension> section contains all of the information for a single client side extension.

 
<data:ClientSideExtension>
. . .
</data:ClientSideExtension>

<Name> is the name of the client side extension.

 
<data:ClientSideExtension>
  <data:Name>Corporate<data:Name>
. . .
</data:ClientSideExtension>

<UrlName> is a meaningful name for the URL that points to the client side extension.

The following characters are accepted in the UrlName element: A-Z, a-z, 0-9, underscore (_), and period (.). Double periods (..) are not permitted, and a period (.) must not be the last character in the string. Examples of URL names are: Logo_Image and Map376. It is recommended that you keep this name as short as possible.

Note: If you change the URL name on an existing client side extension, then the relative URL and full URL will be changed. If the client side extension has already been deployed, then you must update custom Web tabs, custom Web applets, global Web tabs, or custom HTML head additions that reference this client side extension to use the newly generated URL.
 
<data:ClientSideExtension>
. . .
  <data:UrlName>Company_Logo</data:UrlName>
. . .
</data:ClientSideExtension>

<RelativeURL> is the relative URL that navigates to the client side extension from within Oracle CRM On Demand. The value in this element is generated by Oracle CRM On Demand, and the element is read-only.

 
<data:ClientSideExtension>
. . .
  <data:RelativeURL>/user/content/Company_Logo</data:RelativeURL>
. . .
</data:ClientSideExtension>

<FullURL> is the full URL that points to the URL in the Oracle CRM On Demand application. The value in this element is generated by Oracle CRM On Demand, and the element is read-only.

 
<data:ClientSideExtension>
. . .
  <data:FullURL>https://example.com/user/content/Company_Logo</data:FullURL>
. . .
</data:ClientSideExtension>

<Description> is the description of the client side extension.

 
<data:ClientSideExtension>
. . .
  <data:Description>Company logo</data:Description>
. . .
</data:ClientSideExtension>

<FileName> is the name of the file, including the file extension.

 
<data:ClientSideExtension>
. . .
  <data:FileName>logo.jpg</data:FileName>
. . .
</data:ClientSideExtension>

<MIMEType> is the Internet media (MIME) type of the file.

The following are some examples of MIME types:

  • text/html

  • image/jpeg

  • image/gif

  • application/x-shockwave-flash

  • text/css

 
<data:ClientSideExtension>
. . .
  <data:MIMEType>image/jpeg</data:MIMEType>
</data:ClientSideExtension>

<Extension> is the file extension of the file. The value in this element is generated by Oracle CRM On Demand, and the element is read-only.

 
<data:ClientSideExtension>
. . .
  <data:Extension>.jpg</data:Extension>
. . .
</data:ClientSideExtension>

<FileSize> is the size of the file in bytes. The value in this element is generated by Oracle CRM On Demand, and the element is read-only.

 
<data:ClientSideExtension>
. . .
  <data:FileSize>106590</data:FileSize>
. . .
</data:ClientSideExtension>

<FileData> contains the reference to the identifier (the Content-ID) for the attachment file.

The Oracle Migration Tool On Demand client uses the Message Transmission Optimized Mechanism (MTOM) specification with the XML-binary Optimized Packaging (XOP) convention and the Multipurpose Internet Mail Extensions (MIME) standard to extract and return the client side extension configuration data and the file attached to the client side extension. Therefore, the content of the <FileData> element in the SOAP request is packaged as an MTOM/XOP request.

 
<data:ClientSideExtension>
. . .
  <data:FileData><xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'href='cid:Logo2021'/></data:FileData>
</data:ClientSideExtension>