Oracle® On Track Communication

JavaScript Documentation

Release 1 (1.0)

E21744-01

March 2011

Class OnTrack

Defined in: ontrack.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	OnTrack() Class to simplify connecting to an On Track server and executing calls against it

Method Summary
Method Attributes	Method Name and Description
	execute(module, method, callback, Additional) Execute Remote Procedure Calls (RPC) against On Track.
	getDocumentUploadUrl(conversationId) Constructs an URL to be used when uploading items to On Track via form mulitpart POST.
	login(url, username, password, callback) Login into On Track.

Class Detail

OnTrack()

Class to simplify connecting to an On Track server and executing calls against it

Method Detail

execute(module, method, callback, Additional)

Execute Remote Procedure Calls (RPC) against On Track. The names of the modules, methods and necessary parameters can currently be found in the provided JavaDoc.

Parameters:
{String} module: Server module name
{String} method: Method to execute
{Function} callback: Function to call when the RPC completes. This callback should accept two parameters: + success {Boolean} - True indicates the call succeeded with False indicating either a network error or execution exception + result {Object} - The return of the call which varies depending on the module and method.
{Variable} Additional: parameters after callback will be passed as arguments to the method being called.

getDocumentUploadUrl(conversationId)

Constructs an URL to be used when uploading items to On Track via form mulitpart POST.

Parameters:
{String} conversationId: Id of the conversation where the uploads should go.

Returns:: Returns the URL of the upload endpoint

login(url, username, password, callback)

Parameters:
{String} url: The url of the On Track instance.
{String} username: Username to authenticate with, generally an email address
{String} password: Password associated with the given username
{Function} callback: Called when the login operation completes, the callback will be called in the same fashion as the callback for #execute.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/support/contact.html or visit http://www.oracle.com/accessibility/support.html if you are hearing impaired.

Oracle On Track Communication JavaScript Documentation, Volume 1, Release 1 (1.0)

E21744-01

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.