OpenAir Documentation Overview

OpenAir product documentation is available in the following resources:

The OpenAir product documentation is organized into sections corresponding to different aspects of OpenAir and add-on services. This help topic lists the different sections available with a brief description of their content. Sections are presented under the following categories:

Most of the product documentation content is also available in PDF format that you can view and print. These are available in the User Guides section in all the resources listed above. See User Guides.

Important:

Product documentation is updated regularly. You should always access OpenAir documentation from one of the above resources instead of previously downloaded versions of the PDF guides or PDF guides attached to resources other than those mentioned above.

For a summary of most important changes made to each recent updated version of the product documentation, see Help Center Updates.

OpenAir Basics

The following guides are useful references for all OpenAir users:

User Guide

The guide gives a quick introduction to the OpenAir product and describes how to use its interface and features.

View help topics under User Guide.

User Guide

Glossary

A glossary of terminology used in OpenAir.

View the Glossary.

Glossary

Account Administration

The following guides are intended primarily for administrators and users with the sufficient role permissions to configure some areas of OpenAir.

Administrator Guide

The guide describes OpenAir features and procedures as well as configuration settings. It is a reference guide for administrators and users with delegated role permissions responsible for setting up and maintaining an OpenAir account.

View help topics under Administrator Guide.

Administrator Guide

Database

This section provides a visual representation of the OpenAir database as viewed through the OpenAir API.

View help topics under Database.

Database Guide

Optional Features

This section lists and describes the optional features that can be enabled by OpenAir Customer Support for your account. The features described in this guide correspond to the lists of enabled feature account administrators by going to Administration > Global Settings > Reports > Enabled Features.

View help topics under Optional Features.

Optional Features

Performance Tuning

This section describes the steps a user can take to improve the responsiveness of OpenAir to their specific requests. The guide covers hardware and network-related issues, general performance issues, and application specific issues.

View help topics under Performance Tuning.

Performance Tuning

Security

This section outlines the security features currently available for OpenAir and describes security-related controls and configuration settings.

View help topics under Security.

Security

Integration

The following guides are intended primarily for administrators and describe the OpenAir integrations available either as optional features in OpenAir or as Windows Server desktop applications.

Business Intelligence Connector

This section documents the Business Intelligence Connector feature. The Business Intelligence (BI) Connector feature gives you point and click access to OpenAir from existing reporting, business intelligence, workflow, and integration applications.

View help topics under Business Intelligence Connector.

Business Intelligence Connector

NetSuite Integration

This section describes the NetSuite integration feature and how to configure, run and use the integration between OpenAir and NetSuite.

View help topics under NetSuite Integration.

NetSuite Integration

SAML Single Sign-On

This section provides information about how to enable Security Assertion Markup Language (SAML) Single Sign-On for the OpenAir web application and OpenAir Mobile apps.

View help topics under SAML Single Sign-On.

SAML Single Sign-On

Exchange Integration Manager

This section documents OpenAir Exchange Integration Manager. OpenAir Exchange Integration Manager provides the ability to exchange information between OpenAir and Microsoft Outlook calendar for all mapped users.

View help topics under Exchange Integration Manager.

Exchange Integration Manager

Integration Manager

This section documents the Integration Manager. OpenAir Integration Manager is an import, export, and data update application specifically designed for use with OpenAir.

View help topics under Integration Manager.

Integration Manager

Add-on Services

The following guides describe the add-on services — mobile and desktop applications — available to OpenAir users.

Mobile

This section describes how to install and use OpenAir Mobile for Android or iPhone for exchanging timesheets and expenses information between an OpenAir account and an Android device or iPhone.

View help topics under Mobile.

Mobile

OffLine

This section documents the OpenAir OffLine application. OpenAir OffLine extends the convenience of your OpenAir account to your personal computer. It supports entering charges, expenses, and time on all tasks to which you are assigned.

View help topics under OffLine.

OpenAir OffLine User Guide

Projects Connector

This section documents the Projects Connector application. OpenAir provides Projects Connector as a tool for exchanging project plan information between the Projects module and Microsoft Project.

View help topics under Projects Connector.

Projects Connector

Developer Reference Documentation

The following guides are references for developers and administrators wishing to leverage OpenAir platform features to extend the functionality of OpenAir or develop their own OpenAir integration. See also Developer Reference Documentation for a summary of the resources OpenAir provides for user scripting and API integration developers.

API > REST API

This section provides a reference for developers wanting to use OpenAir REST Web Services for the exchange of OpenAir data between the main site and peripheral programs. It describes the REST API and lists the supported methods and resource endpoints.

View help topics under REST API.

REST API

API > XML API and SOAP API

This section provides a reference for developers wanting to use the XML API or Web Services (SOAP API) for the exchange of OpenAir data between the main site and peripheral programs. It describes the API and lists the commands and data types available in the XML API and SOAP API.

View help topics under XML API and SOAP API.

XML API & SOAP API

User Scripting

This section describes User Scripting, a component of the OpenAir platform allowing you to customize OpenAir to better meet the unique needs of your business.

View help topics under User Scripting.

User Scripting | User Scripting Reference Card

New Release Resources

Several resources are available to help you become familiar with, and prepare for, new features introduced in each release. The following resources are grouped under the What's New section of the OpenAir Help Center and other online documentation resources.

Sneak Peek

A sneak peek at the main enhancements in the upcoming OpenAir release is available a few weeks before each major release. It provides a high-level description of the most important feature highlights OpenAir release and provide an overview of selected new features planned for the release.

View the 2024.2 Sneak Peek

Sneak Peek

Release Notes

Release notes are published with each major release and describe all enhancements included in the release.

Release notes for the upcoming release are available from the OpenAir Help Center for release preview and sandbox accounts during the release preview period.

Interim release notes are also available for changes delivered in between major releases.

The OpenAir Help Center also includes a release note archive going back to September 2000.

See Release Notes.

Release Preview Guide

The test plan describes the release preview process you should follow. The Release Preview environment enables you to become familiar with the new features in an upcoming release. You can verify that your existing business workflows function as expected before the upgrade to your production account.

View the help topics under Release Preview Guide.

Release Preview Guide.