Database Guide Overview

The Database Guide provides a high-level description of the OpenAir database as viewed through the REST API, SOAP API, XML API, user scripting NSOA.wsapi functions and the Integration Manager.

Important:

This guide does not describe the physical database, and does not describe the features provided to protect the security, privacy, and integrity of your OpenAir data.

For more information about security features, see Security.

This guide provides entity relationship (ER) diagrams for most record types (database tables) in OpenAir. See Entity-Relationship Diagrams.

• For a list of ER diagrams categorized by business area, see Index of Entity-Relationship Diagrams by Data Area.

• For a list of tables described in the data dictionary and corresponding ER diagrams, see Index of Tables and Entity-Relationship Diagrams.

• The ER diagrams use Crow's foot notation. For information about ER models and Crow's foot notation, see Entity-relationship model.

• The ER diagrams provide an overview only. They do not show all the fields (columns) for each record type (database table) and do not show all relationships between tables. For detailed information, consult the OpenAir data dictionary. Each ER diagram is accompanied by a table with links to related ER diagrams in this guide and to table descriptions in the OpenAir data dictionary.

  Go to OpenAir Data Dictionary.

  Note:

  Unless you are viewing this help topic in the OpenAir Help Center, links to the data dictionary use the generic OpenAir domain for production accounts (app.openair.com). In some instances, you may need to replace the generic domain name with your account-specific domain name in the link URLs.

  • To view the OpenAir Data Dictionary, use the following URL:

    https://<account-domain>/database/single_user.html, where <account-domain> is the account-specific domain for your account.

  • To view the details of a specific table, append a hash symbol # followed by the table name to the end of the data dictionary URL.

    For example, use https://<account-domain>/database/single_user.html#project to view the details of the Project table.

  For more information about your account-specific domain name, see Your Account URLs.