1. Security
  2. Security Features
  3. Enabling and Controlling Access to OpenAir Platform Tools

Enabling and Controlling Access to OpenAir Platform Tools

APIs

OpenAir provides the XML API, SOAP API (Web Services), REST API as layers for the exchange of OpenAir data between the main site and peripheral programs. These programs include partnered websites, OpenAir add-on applications that do not need direct database access, and third party applications indirectly supported through OpenAir. Before you begin using these services, review the best practice guidelines in Security Considerations for Developers. See also API Best Practice Guidelines.

Contact the OpenAir Customer Support or your OpenAir account manager to request API access. See Troubleshooting for instructions. When access is granted, you will receive an API namespace and an API key. These are the two pieces of information required for API access in addition to your regular OpenAir sign-in credentials. The namespace and key attributes are used to verify that the request is coming from a valid partner that has permission to use our API. You will not be able to access an account with just the namespace and the key. You will also need to know the Company ID, User ID, and Password of the account.

Request the Web Services log detail report feature to record and report on all web service requests and responses. When this feature is enabled, you will be able to go to Reports > Detail > Web services and select Web services logs to configure and run the reports. These reports can be used for auditing purposes or to help troubleshooting API requests.

You can also use web services reports to audit and revoke authorizations granted by OpenAir users to integration applications. For more information, see Auditing and Managing OAuth 2.0 Authorizations.

Note:

This feature includes an optional component, which may be enabled to help troubleshoot any issues with the add-on services provided by OpenAir.

If you are using Web services log reports to track your API usage limits, note that API requests made by OpenAir Mobile apps, OpenAir Integration Manager and other OpenAir add-on services do not count toward your usage limits.

Important:

The Web services log report feature has the following limitations:

  • If you do not use this feature for more than 30 days, the feature is disabled and the log entries are deleted.

  • Log entries are retained for 7 days only, then they are purged from the database.

User Scripting

User scripting features allow you to customize OpenAir to better meet the unique needs of your business. Scripts are stored in a dedicated workspace used exclusively for scripting and can only be altered through the Scripting Center. Before you begin using these features, review the best practice guidelines in Security Considerations for Developers as well as the User Scripting.

Contact OpenAir Customer Support to enable the following User Scripting features:

  • Form Scripts — allows the creation of scripts triggered by events on specific entity forms.

  • Scheduled Scripts — allows the creation of scripts executed according to a schedule.

The Scripting Center and the built-in script editor — or Scripting Studio — are automatically enabled if either Form Scripts or Scheduled Scripts are enabled. Enabling these features also enable Script deployment reports allowing you to review deployment logs for form and scheduled scripts respectively.

The following optional features are also available for User Scripting.

  • Script support for HTTPS methods— enables outbound calls using built-in functions in your scripts.

  • Script support for Web Service API methods — enables access to the SOAP API using built-in functions in your scripts.

  • Unapprove Event — enables to create scripts that are triggered when items are unapproved. This applies to Timesheets, Schedule requests, Booking requests, Bookings, Purchase requests, Purchase orders, Envelopes and Invoices.

Once user scripting features are enabled, account administrators can access the Scripting Center by going to Administration > Scripting Center and use it to develop, test, deploy and manage scripts for your OpenAir account.

Platform Role Permissions

Administrators can assign Platform Roles to users to control access to critical features of the Scripting Center and Scripting Studio. You can create Platform Roles by navigating to Administration > Roles. Use platform role permissions to control access to critical features of the Scripting Center and Scripting Studio.

OpenAir recommends creating the following roles:

  • Script Administrator

  • Script Developer

  • Script QA

  • Script Deploy

Roles can be assigned a number of role permissions:

  • View Scripting Center — allows users to access and view the Scripting Center by navigating to Administration > Scripting Center.

  • Create script — allows users to create a new script.

  • Change script log level — allows users to set what types of information to log.

  • View script in Scripting Studio — allows users to view a script in the Scripting Studio.

  • View and modify script in Scripting Studio — allows users to view a script and make changes to it in the Scripting Studio.

  • Enable script testing — allows users to move a script to “In testing” status.

  • Upload script revision code — allows users to upload new code revisions after a script has been deployed.

  • Disable script testing — allows users to move an “In testing” script to “Inactive” status.

  • Discard script changes — allows users to discard any script changes made since the last save.

  • Deploy new script — allows users to save a new script and move it to “Active” status.

  • Deploy script changes — allows users to save changes to an “In testing” script and move it to “Active” status.

  • Undeploy script — allows users to move an “Active” script to “In testing” status.

  • Delete script — allows users to delete a script.

  • Set form script “Execute As Employee” — set an employee for script deployment when running a script under another user.

  • Run schedule script test code — allows users to run schedule script test code in either “In testing” or “Active: revising” states.

  • Run schedule script code — allows users to run currently deployed script code.

  • Cancel schedule script queued runs — allows users to cancel any previously-scheduled runs waiting for processing in the queue.

  • View script parameters — allows users to view, create, and modify script parameters.

  • View and modify script parameters — allows users to view, create, and modify script parameters.

  • Set script parameter value — allows users to use the “Set” link for the script parameter value.

  • View solutions — allows users to view solutions, but not edit them.

  • View and modify solutions — allows users to view, create, and modify solutions.

  • Export solution — allows users to export a solution based on a particular script deployment.

  • Upload solution — allows users to upload a solution XML file.

  • Apply solution — allows users to create all objects specified in a solution and create a log file.

  • Delete solution — allows users to delete a solution, all of its history, and logs.

The table below shows the permissions OpenAir suggest should be assigned to each role:

Permissions

Script Administrator

Script Developer

Script QA

Script Deploy

View Scripting Center

*

 

 

 

Create script

*

*

 

 

Change script log level

*

*

*

 

View script in Scripting Studio

*

*

*

 

View and modify script in Scripting Studio

*

*

 

 

Enable script testing

*

*

*

 

Upload script revision code

*

*

 

 

Disable script testing

*

*

*

 

Discard script changes

*

*

 

 

Deploy new script

*

 

 

*

Deploy script changes

*

 

 

*

Undeploy script

*

 

 

*

Delete script

*

*

 

 

Set form script Execute As User

*

 

 

 

Run schedule script test code

*

*

 

 

Run schedule script code

*

 

 

 

Cancel schedule script queued runs

*

*

 

 

View script parameters

*

*

*

 

View and modify script parameters

*

*

 

 

Set script parameter value

*

*

 

*

View solutions

*

*

*

 

Create solution

*

*

*

 

Upload solution

*

*

*

*

Download solution

*

*

*

*

Apply solution

*

*

*

*

Delete solution

*

 

 

 

Script deployment log reports

Administrators have access to deployment logs for form scripts and scheduled scripts in Reports > Detail > Script deployment. These reports allow to view all log messages recorded for all form script deployments and scheduled scripts deployment, respectively. Assign the View the script deployment log report role permission to enable other users to view these reports.