Difference between revisions of "TrackAbout API and Integration Points"

Latest revision as of 15:06, 13 October 2020

Overview

TrackAbout has an open and flexible approach to integration. We want to help our clients find the best ways to integrate with whatever other systems they are using today and in the future. About half of TrackAbout's customers do some kind of integration with their business system.

Pricing

Use of our suite of API endpoints is included in your TrackAbout subscription. Should you need assistance with the endpoints, using the documentation, any development to change endpoints, or custom reporting, a Professional Services project will be required. Talk to your TrackAbout Support team for details.

Pre-Built Integrations

The following business systems have a pre-built integration that can be used by new clients

Epicor's Prophet 21 integration built and maintained by Epicor
Oracle's NetSuite integration built and maintained by Solution Source
Infor SX.e integration built and maintained by DSA
TECSYS Elite Series integration built and maintained by TECSYS

There is also an integration to the following system for bill presentation and delivery (used for mailing rental bills for customers)

SourceHOV integration built and maintained by SourceHOV

Custom Integrations

Most of our clients who do integration have set it up themselves or with the help of their ERP system consultants. Our clients have configured integrations to many systems over the years and we have a lot of experience helping new clients with integration projects.

Should you need assistance with the endpoints, using the documentation, any development to change endpoints, or custom reporting, a Professional Services project will be required. Talk to your TrackAbout Support team for details.

Some of the systems our clients have integrated with include these more common systems:

SAP, Oracle, JD Edwards, Microsoft Dynamics and Sage

Though not a formal integration, here are some notes on integrating with Computers Unlimited

There are many more systems that our clients have used in specific industries or geographies. Please contact us for more information on any specific system

Preferred Integration Methods

Standard REST API

TrackAbout preference for integration is to use our standard API (Application Programming Interface). This API is well documented and we continue to support it going forward.

RESTFUL APIs

Push Integration (Webhooks)

This integration method is used to have TrackAbout trigger pushing information to your systems when an action takes place in the TrackAbout system.

Action-Based Integration

Public Redirect URLs

These are URLs used to create links to pages inside the TrackAbout application website. These are standardized and shortened URL formats that TrackAbout will continue to support even if our normal URLs were ever to change.

Public Redirect URLs

Read-Only Database Access

TrackAbout allows direct read-only access to a simplified view of your TrackAbout database.

OpenData

Other Integration Methods

Bulk Loading Data by TrackAbout Support

When getting started there is often a need to load some data one-time at the start of the project. TrackAbout's support and implementation team has tools to help with this.

TrackAbout Support Tools

File-Based Import/Export

Clients unable to call the Standard REST API can fall back on exchanging text files.

File-Based Import/Export

Web Services using SOAP

These SOAP webservices still work, but are not being maintained going forward. Please contact us for more information if you are interested in using these integration methods.

Web Services

@@ Line 1: / Line 1: @@
+[[Welcome_to_the_TrackAbout_Wiki|<< Back to Wiki Home Page]]
 == Overview ==
-TrackAbout integrates with numerous business accounting systems including Infonetics, Mind Your Own Business, [[Integration with Computers Unlimited 3.0 clients|Computers Unlimited]] (TIMS, TIMS 3.0, WISDOM), and Oracle.
+TrackAbout has an open and flexible approach to integration. We want to help our clients find the best ways to integrate with whatever other systems they are using today and in the future. About half of TrackAbout's customers do some kind of integration with their business system.
-TrackAbout integrates with storeroom management systems by eRPortal.
-TrackAbout integrates with third-party bill presentment and procurement systems from SourceCorp.
-TrackAbout supports several ways of getting data in and out of the system.
-* Manual user-uploading of CSV, fixed-width, tab-delimited or XML files
-* Automatic pickup and processing of files transferred via FTP or other means
-* Exported text and XML reports made available for automated pickup
-* Fully integrated Web Services
-TrackAbout also provides a set of published URL Redirects for getting quick access to such things as customers, invoices, assets and more via the web site.
-==Integration Files==
-TrackAbout's small-to-medium sized customers in the gas distribution industry typically use one of the four incumbent accounting system providers in that industry: Computers Unlimited, Dataweld, Infonetics and Barry Weir.  These systems provide varying degrees of "openness" ranging from "none" to "just barely enough."
-From these industry-specific accounting systems, it is usually only possible to export data, not import.  This provides for a one-way integration: exporting data from the accounting system into TrackAbout.  The exporting of data usually takes the form of tab-delimited, fixed-width columnar or comma-separated values (CSV) files (if we're lucky) or paged text reports (if we're not-so-lucky).
-For the tab-delimited, fixed-width columnar or CSV files, TrackAbout can create a relatively simple mapping configuration file which models the structure of the file.  Once configured, these kinds of files can be posted or uploaded.
-The paged text reports usually require custom development work to convert them a file format TrackAbout can understand.
-===Importing Integration Files===
-Importing integration files to TrackAbout is done in one of the following ways:
-==== Uploading Manually To Page ====
-* User logs in and navigates to a page in the Integration section of the web site.
-* User uploads the file manually and specifies some settings to use while processing the file.
-* User waits for processing to finish.
-* Page displays warnings or errors upon completion.
-==== Automated Processing of Uploaded Files ====
-* User or automated process transfers the file to the TrackAbout server (usually via FTP).
-* Periodically the files are picked up and processed using preconfigured settings.
-* Any warnings or errors are sent to a list of preconfigured email addresses.
-=== Initial Setup Imports ===
-To get a new client started with TrackAbout, there are a few one-time setup steps that our support personnel have to work through.  Generally this amounts to exporting a list of customers and a list of product codes (a.k.a. part numbers) and importing them into TrackAbout using private tools.
-=== Invoice Imports ===
-Beyond initial setup and configuration, the most common integration linkage to establish is the regular and automated exporting of invoice data from the accounting/order entry system into TrackAbout.  This enables TrackAbout to compare the invoice/order info to the actual records collected in the field by workers doing deliveries.  This is a huge value-add for TrackAbout, as we help our customers catch mistakes in the field quite frequently.
-=== Balance Imports for Comparison ===
-Another integration point is the balance import.  The client's accounting system maintains its own record of each customer's balance, independent from TrackAbout.  Because of the lack of strong two-way integration, it is possible, over time, for balances in the accounting system to drift away from those of TrackAbout, the system of record.  We have created a process by which a user can export customer balance reports from their accounting system, then import these reports into TrackAbout for comparison.  The user can then see where the differences lie.  If they so wish, they can perform a "right-sizing" and force TrackAbout to agree with the accounting system.  This is achieved by adding Not-Scanned Assets to the customer balances.  Generally, we prefer that customers do not right-size TrackAbout to match the accounting system, because we feel TrackAbout is the more accurate system.  However, clients will sometimes have an established history with a given customer and an agreed-upon balance for which the customer is being billed rent.
-== Web Services ==
+== Pricing ==
-For our customers who run their businesses on more modern back-end systems (such as those who have adopted the TECSYS/TrackAbout combined platform, or those on Oracle Financials or other similar systems), integration can be made much tighter.  We have integrations in place where completed and verified order data from TrackAbout is pushed back to the client's system in order to release invoicing, and where monthly calculated rental bills are exported to the back-end systems for clients who wish to print their own rental bills.
+Use of our suite of API endpoints is included in your TrackAbout subscription.  Should you need assistance with the endpoints, using the documentation, any development to change endpoints, or custom reporting, a Professional Services project will be required.  Talk to your TrackAbout Support team for details.
-== Public Redirect URLs ==
+== Pre-Built Integrations ==
-The following published URLs will not change over time and will be supported indefinitely.
+The following business systems have a pre-built integration that can be used by new clients
-Note that these URLs do not provide for authentication.  That is, you cannot specify username/password as part of the request. Instead, upon the first request to a URL, the user will be redirected to the standard login screen. Upon successful login, the user will then be automatically redirected to the requested page.
+* [https://www.epicor.com/products/prophet-21.aspx Epicor's Prophet 21] integration built and maintained by Epicor
+* Oracle's [http://www.netsuite.com NetSuite] integration built and maintained by [http://www.solution-source.net/ Solution Source]
+* [http://www.infor.com/product-summary/distribution/sxenterprise/ Infor SX.e] integration built and maintained by [http://www.dsa.us/ DSA]
+* [http://www.tecsys.com TECSYS Elite Series] integration built and maintained by TECSYS
-All URLs must begin with the path to the server (i.e. "https://www.trackabout.com"), so this is omitted below.
+There is also an integration to the following system for bill presentation and delivery (used for mailing rental bills for customers)
+* [http://www.sourcehov.com/ SourceHOV] integration built and maintained by SourceHOV
-Any special characters or spaces in the querystring portion of the URL must be properly url-encoded. For reference, see http://www.w3schools.com/TAGS/ref_urlencode.asp.  For example, the correct URL-encoding for a single space character is the plus sign: +
+== Custom Integrations ==
+Most of our clients who do integration have set it up themselves or with the help of their ERP system consultants.
+Our clients have configured integrations to many systems over the years and we have a lot of experience helping new clients with integration projects.
-These URLs are implemented as regular-expression-based URL redirects, so there are no ?, & or = characters.
+*Should you need assistance with the endpoints, using the documentation, any development to change endpoints, or custom reporting, a Professional Services project will be required.  Talk to your TrackAbout Support team for details.
-===Asset URLs===
+Some of the systems our clients have integrated with include these more common systems:
-:URL: /barcode/(a barcode)
-;Redirects To: The Asset Search results page, or directly to Asset History page if only one match is found.
-:URL: /sn/(a serial number)
+SAP, Oracle, JD Edwards, Microsoft Dynamics and Sage
-;Redirects To: The Asset Search results page, or directly to Asset History page if only one match is found.
-===Customer URLs===
+Though not a formal integration, here are some notes on integrating with [[Integration_with_Computers_Unlimited_3.0|Computers Unlimited]]
-These all work with either /cust or /customer. We will show /customer in all examples below.
-:URL: /customer/'''Customer ID'''
+There are many more systems that our clients have used in specific industries or geographies. Please contact us for more information on any specific system
-;Redirects To: Customer Detail page. If more than one match, then redirects to the Customer Search results page.
-:URL: /customer/(a customer ID)/assetlist
+== Preferred Integration Methods ==
-;Redirects To: Asset List page. If more than one match, then redirects to the Customer Search results page.
-:URL: /customer/(a customer ID)/assetbalance
+=== Standard REST API ===
-;Redirects To: Asset Balance page. If more than one match, then redirects to the Customer Search results page.
+TrackAbout preference for integration is to use our standard API (Application Programming Interface). This API is well documented and we continue to support it going forward.
+* [[RESTFUL APIs]]
-:URL: /customer/(a customer ID)/rentalbalance
+=== Push Integration (Webhooks) ===
-;Redirects To: Rental Balance page. If more than one match, then redirects to the Customer Search results page.
+This integration method is used to have TrackAbout trigger pushing information to your systems when an action takes place in the TrackAbout system.
+* [[Action-Based Integration]]
-===Lot URLs===
+=== Public Redirect URLs ===
-:URL: /lot/(lot #)
+These are URLs used to create links to pages inside the TrackAbout application website. These are standardized and shortened URL formats that TrackAbout will continue to support even if our normal URLs were ever to change.
-;Redirects To: Lot Search results page.
+* [[Public Redirect URLs]]
-===Order/Invoice/Delivery Ticket/Packing Slip/PPS URLs===
+=== Read-Only Database Access ===
-Some of our customers use the term "invoices", others call them "orders", "packing slips", "delivery tickets", or "PPS". This is the number used by drivers during deliveries.
+TrackAbout allows direct read-only access to a simplified view of your TrackAbout database.
+* [[OpenData]]
-:URL: /invoice/(an invoice #) or
+== Other Integration Methods ==
-:URL: /order/(an order #)
-;Redirects To: Invoice/Order Search results page, or directly to the invoice/order summary page if only one match is found.
-===Rental Invoice URLs===
+=== Bulk Loading Data by TrackAbout Support ===
-These are used to link to TrackAbout generated rental invoices.
+When getting started there is often a need to load some data one-time at the start of the project. TrackAbout's support and implementation team has tools to help with this.
+* [[TrackAbout Support Tools]]
-:URL: /rinvoice/(a rental invoice #) or
+=== File-Based Import/Export ===
-:URL: /rentalinvoice/(a rental invoice #)
+Clients unable to call the Standard REST API can fall back on exchanging text files.
-;Redirects To: Rental invoice search results page.
+* [[File-Based Import/Export]]
-'''If you require shortcut URLs to be added to our public API, let us know. '''
+=== Web Services using SOAP ===
+These SOAP webservices still work, but are not being maintained going forward. Please contact us for more information if you are interested in using these integration methods.
+* [[Web Services]]