Auto-Installation of Integration Records
Auto-installation is the automatic addition of an existing integration record to your NetSuite account through the sending of a SOAP web services request. Users and administrators in your organization can use this method to add partners’ integration records to your account.
Auto-installation can be used with integration records that are configured to authenticate through user credentials, token-based authentication or OAuth 2.0.
Whether using The Three-Step TBA Authorization Flow, calling The IssueToken Endpoint, or using OAuth 2.0, an Integration record is automatically installed in your account. The Require Approval during Auto-Installation of Integration preference affects whether this record is automatically enabled. You can manage the preference at Setup > Integration > Integration Management > SOAP Web Services Preferences. If the box for the Require Approval during Auto-Installation of Integration preference is not checked (set to false) the State field on the application is automatically set to Enabled, and all requests are permitted. However, if the box is checked (set to true) the State field on the integration record is set to Waiting for Approval. In the latter case, you must manually edit the record and set the State to Enabled. Until you set the state to Enabled, all requests sent by that application are blocked.
For more details about auto-installation, see the following sections:
When a record is installed through auto-installation (or through bundling), the values of many fields on the record are determined by the NetSuite account that owns the record. These fields are read-only in the account where the record is installed. For details, see Ownership of Integration Records.
Understanding Auto-Installation
Be aware that auto-installation can be triggered by any user with access to your NetSuite account, not exclusively account administrators.
The most common use of auto-installation occurs when users download and run applications provided by partners. For example, a partner may have begun distributing a newly created application that includes the application ID of a new integration record. Alternatively, a partner may have upgraded an existing application to use the 2015.2 or a later WSDL and include a new application ID.
It is also possible to auto-install an integration record from your sandbox to your production account. Or, if an integration record was removed from a sandbox account during a sandbox refresh, you can restore it by auto-installing it.
In all of these cases, after a request is sent that includes the application ID, the integration record is automatically installed. However, SOAP web services requests from the application may or may not be automatically permitted. This behavior varies depending on the configuration of a preference, as described in Configuring the Require-Approval Preference.
Configuring the Require-Approval Preference
The configuration of the Require Approval during Auto-Installation of Integration preference determines whether automatically installed integration records are enabled at the time they are installed.
This preference can be configured in either of the following ways:
-
False (default) – The State field on each newly installed record is automatically set to Enabled, and all requests are permitted.
-
True – The State field is set to Waiting for Approval. In this case, all requests sent by that application are blocked until you edit the record and set the State field to Enabled.
In other words, if you as an administrator want to review and manually approve each newly installed integration, you should set this preference to true. By contrast, if you are confident that all newly installed applications should be granted access, set this preference to false.
You can manage this preference at Setup > Integration > SOAP Web Services Preferences.
For more details about using the State field, see Blocking SOAP Web Services Requests.