Getting Started
In This Topic
What Can I Do with the OnTime Extension SDK?
The OnTime Extension SDK provides a powerful application programming interface (API) that allows a developer to control many of the basic functions of an OnTime account. This makes it possible to control how data is read, created, and updated.
Using this approach, a programmer can easily extend the functionality of OnTime desktop applications such as OnTime Management Suite and OnTime Dispatch. These extensions become part of the OnTime application and can offer deep integration with other software systems.
What are OnTime Extensions?
OnTime Extensions behave as plug-ins or add-ins within the OnTime desktop applications. These extensions are a great way extend the functionality of OnTime. The most typical scenario for an extension is to connect OnTime with another software system. Here are some examples:
- Connecting OnTime’s invoice and payment data with a specific accounting system
- Transferring data to and from an EDI based system
- Uploading order data in a specific format to an FTP server
- Importing or exporting data to or from external sources
Once installed, an extension appears as part of the OnTime desktop application in the form of a button in the ribbon or in a context menu.
OnTime Extension displayed as a ribbon button
Multiple OnTime Extensions displayed within a context menu
How Can I Create an OnTime Extension?
OnTime Extensions are simple to design and create using the OnTime SDK tools. Extensions are built using the Microsoft .NET Framework for security and rapid development. Any version (including the free versions) of Visual Studio 2010 or greater is all that is required for a programmer to create an extension.
Referencing the OnTime SDK assembly within a Visual Studio project unlocks all of the functionality to interact with OnTime within your code. This includes IntelliSense for .NET languages such as Visual Basic and C#, making discoverability easier and more intuitive.
How long does it take to develop an extension? Depending on the complexity of the extension, developers with the tools and understanding can create a simple extension within 30 minutes.
Learn more under Build an Extension.
Samples
Sample projects have been included with the OnTime Extension SDK. These sample projects illustrate common scenarios for which extensions may be created.
Example Project 1
This example illustrates basic use of the OnTime Extension SDK. The example initializes an independent extension and demonstrates a simple create/update operation on the Customers table of an OnTime account.
Example Project 2
This example illustrates the use of the SDK example in the context of the billing view on OnTime Management Suite. The example initializes a billing extension and demonstrates a simple CSV (comma separated value) export operation from the Invoices table of an OnTime account.
Example Project 3
This example illustrates the use of the SDK example in the context of the tracking view on OnTime Management Suite or OnTime Dispatch. The example initializes a tracking extension and demonstrates a simple CSV (comma separated value) export operation from the Tracking table of an OnTime account.
See Also