# SailPoint Oracle NetSuite Connector Documentation > Oracle NetSuite Connector Documentation # Documentation # Connecting SailPoint and Oracle NetSuite To connect SailPoint with Oracle NetSuite, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, refer to [SailPoint Virtual Appliances](). 4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 6. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. Under **Connection Type**, select **Direct Connection** or **Flat File**. - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](). - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable. 5. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source. 6. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 7. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 8. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](). 4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 6. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 7. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 8. Select **Save**. ## Connection Settings The following information is required to connect and interact with Oracle NetSuite. Select one the following authentication types: ### Token Based Authentication > [!NOTE] > > **Screenshot** > > [![Token Based Authentication]()]() 1. Enter the **Account ID** assigned to your organization by the Oracle NetSuite system. 2. Select **Token Based Authentication** as the **Authentication Type**. 3. Enter the **Client ID** and **Client Secret** of an integration record generated by the Oracle NetSuite system during setup. 4. Enter the **Token ID** and **Token Secret** generated for the access token. 5. Enter the **Application ID** that is the unique identifier generated by Oracle NetSuite system during the setup process when an external application is required to be integrated. ### User Credentials (not supported for NetSuite version 2020.2 or later) > [!NOTE] > > **Screenshot** > > [![User Credentials]()]() 1. Enter the **Account ID** assigned to your organization by the Oracle NetSuite system. 2. Select **User Credentials** as the **Authentication Type** 3. Enter the **Administrator Email** ID and the corresponding **Password** of the administrator. 4. Enter the **Application ID** that is the unique identifier generated by Oracle NetSuite system during the setup process when an external application is required to be integrated. 5. Enter the **Role ID** assigned to your organization by the Oracle NetSuite system. ### Page Size > [!NOTE] > > **Screenshot** > > [![Page Size]()]() 1. In the **Page Size** field, enter the number of records to aggregate in a single page when iterating over large datasets. The default size is 50. 2. Select **Save**. ## Additional Settings This connector supports the read operation of additional attributes by configuring the attribute XPath in Attribute Mapping and adding the attribute to account schema. ### Attribute Mapping > [!NOTE] > > **Screenshot** > > [![Attribute Mapping]()]() To add an additional attribute: 1. Select **Add Another** and enter the attribute's name in **Schema Attribute**. 2. Enter the attribute's XPath in **XML XPath / CustomAttribute**. The XPath must be given by considering `/record` as the root element in the XML response. For example, this is the SOAP response for `employee`: > **Example** > > ```xml > xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> > > > WEBSERVICES_TSTDRV942460_0920202136479827402549852_32553d3a7 > > > > > > > > Testing XPath > Testing > XPath > false > 2021-09-20T00:46:59.000-07:00 > 2021-09-20T00:46:59.000-07:00 > TX > > Admin > > _softOptIn > _everyTwoWeeks > _wage > false > true > false > 2021-09-20T00:00:00.000-07:00 > _omitted > false > > USA > > false > false > _systemPreference > true > > > > USA > > > > > > false > > > false > > > > > > > > ``` The XPath entry will be as follows: | Schema Attributes | Navigation Path (XML XPath) / Custom Attribute | | --- | --- | | firstName | `listEmp:firstName` | | department | `listEmp:department/platformCore:name` | 3. Select **Add Another** to configure additional attributes. 4. Select **Save**. ## Custom Attributes This connector can be configured to read and write custom attributes. Add the custom attribute name to the account schema, then add the `customAttribute` using the REST API. > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. The following Oracle NetSuite Custom field types are supported: - Checkbox - Date - Free-Form Text - Email Address - Phone Number - Hyperlink To add the custom attribute label (case sensitive) in the schema, select the **Add New Attribute** button. You can find custom attribute labels by going to **Customization \> Lists, Records, & Fields \> Entity Fields** in the Oracle NetSuite managed system. | Schema Attributes | Navigation Path (XML XPath) / Custom Attribute | | --- | --- | | Custom\_Sales | `CustomAttribute` | | Custom\_InventoryId | `CustomAttribute` | ## Pass-through Authentication (Deprecated) The Oracle NetSuite source supports pass-through authentication. On the Oracle NetSuite managed system, enable the token based authentication. Go to **Setup \> Company \> Enable Features**. On the SuiteCloud panel go to **Manage Authentication** and select the **TOKEN-BASED AUTHENTICATION** checkbox. Select **User Credentials** to use pass-through authentication for token based application. On the Oracle NetSuite source in the Token Based Authentication panel, in the **Application ID** field, enter the application ID of an integration record generated by Oracle NetSuite system during setup. It is required only for the pass-through authentication. > [!NOTE] > > You must set the email ID as account name in the schema. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with Oracle NetSuite Oracle NetSuite is an enterprise resource planning system. Oracle NetSuite is a cloud-based Software-as-a-Service integrated business management software. Oracle NetSuite's cloud business management system includes ERP/accounting, order management/inventory, CRM, Professional Services Automation (PSA), and E-commerce. Enterprise Resource Planning (ERP) in Oracle NetSuite encompasses several areas of your business, including accounting, inventory, order management, project management, and employee management. This guide is designed to give specific information on the Oracle NetSuite connector in SailPoint that can manage the employee data in the Oracle NetSuite ERP system. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Oracle NetSuite connector supports the following features: - \*Access Certifications (certification of entitlements connected to accounts) - \*Password management - Pass-through Authentication For more information on SailPoint features, refer to [Source Features](). > [!NOTE] > > Before you can use any item above marked with an asterisk (\*), SailPoint must activate the feature for your site. Oracle NetSuite supports additional attributes that are natively present on the Oracle NetSuite managed system. The Oracle NetSuite managed system supports extending the schema through Attribute Mapping. ### Account Management - Manages Oracle NetSuite users as Accounts - Aggregation, Refresh Accounts, Pass Through Authentication (deprecated) - Create, Update - Enable, Disable, Change Password - Add/Remove Entitlements > [!NOTE] > > - The Oracle NetSuite connector only aggregates Employees. > - For Pass Through Authentication, the account should have at least one role assigned with the permissions required to perform the operation. This role must also be a Web Service enabled role. > - Pass Through Authentication is deprecated for the new NetSuite application, as Oracle NetSuite no longer supports it. ### Account - Group Management - Manage Oracle NetSuite Roles as Account-Groups - Aggregation > [!NOTE] > > The Oracle NetSuite connector only aggregates entitlements that have members assigned to them. ### Authentication Mechanism - User Credentials (not supported for NetSuite version 2020.2 or later) - Token Based Authentication - Load and \*provision Oracle NetSuite Accounts ### Password Management If Password Management is enabled for your organization, you can change the password for a user of the source. After enabling password management on the source, be aware of the following: - The password policy defined in SailPoint applies to accounts on this source. - If you change the password for an application connected to this source, the change will automatically be made to the source itself. For more information on configuring password management, refer to [Password Management Overview](). ## Privilege Classification SailPoint Privilege Classification helps organizations systematically categorize and manage the privilege levels of entitlements within their sources. By classifying entitlements as high, medium, or low, administrators can better understand the potential risk and impact associated with specific access rights. This allows automatic assignment of privilege levels based on system recommendations, custom-defined criteria, or a same level across all entitlements. | Privilege Level | Description | | --- | --- | | High | Administrative level access to accounts | | Medium | Administrative level access for a specific role or function | | Low | Only basic access of data | > [!NOTE] > > To manage Privilege Classification, users must have administrative roles such as Org Admin, Source Admin or Source Sub-Admin. For more information, refer to [Managing Privilege Classification](). > [!NOTE] > > **Example** > > [![Recommended Privilege Level - High]()]() > > [![Recommended Privilege Level - Medium]()]() > > [![Recommended Privilege Level - Low]()]() ## Supported WSDL Versions The Oracle NetSuite connector supports the following WSDL versions: - Oracle NetSuite that supports the WSDL\_v2019\_1\_0 (will be deprecated soon) - Oracle NetSuite that supports the WSDL\_v2023\_1\_0 ## Prerequisites - Configure the required permissions. For more information, refer to [Required Permissions](<#required-permissions>). - Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](). ### Create Users on the Oracle NetSuite Managed System You must create a user on the Oracle NetSuite managed system to manage User Credentials or Token Based Authentication. > [!IMPORTANT] > > For the following process, you must log in to the Oracle NetSuite managed system using the Oracle NetSuite account. This section is a reference for the Oracle NetSuite managed system and provided as a guideline only. 1. Go to **Lists \> Employees \> Employees \> New**. 2. Enter the appropriate values in the following fields: - Name - Email > **Note** > > After you create the employee, you must assign the roles based on the authentication types as mentioned below. After the role assignment, the employee is termed as the `user`. 3. Select **Save**. ### Authentication Type Configure an **Authentication Type**. You can select [Token Based Authentication](<#token-based-authentication>) or [User Credentials](<#user-credentials>). #### Token Based Authentication The following details are required to configure Oracle NetSuite using Token Based Authentication: - Consumer Key and Consumer Secret - Token ID and Token Secret ##### Enable Token Based Authentication 1. Log in to your Oracle NetSuite account. 2. Go to **Setup \> Company \> Enable \> SuiteCloud \> Manage Authentication**. 3. Check the **TOKEN-BASED AUTHENTICATION** checkbox. ##### Create an Integration Record and Generate a Consumer Key and a Consumer Secret 1. Go to **Setup \> Integrations \> Manage Integrations \> New**. 2. Provide the name of the application to integrate with Oracle NetSuite. 3. If required, add a **Description**. For example, **SailPoint Token Based Application**. > **Note** > > The **State** of the application is enabled by default. 4. If required, add a **Note**. 5. Check the **Token-based Authentication** checkbox in the **Authentication** sub tab. 6. Save the provided details. The **Consumer Key** and **Consumer Secret** are generated for the application. > **Important** > > Save the generated **Consumer Key** and **Consumer Secret** to use in the configuration as **Client ID** and **Client Secret** respectively. > > The only time the Consumer Key and Consumer Secret values are displayed is on the confirmation page. These values can't be retrieved from the system after you exit the confirmation page. If the Consumer Key and Consumer Secret values are lost, then repeat steps 1 through 3 in the **Create an Integration Record and Generate a Consumer Key and a Consumer Secret** process to generate new values. ##### Create a Role with Permission to Generate a Token > [!NOTE] > > This process is only applicable when you don't have a role which has token related permissions. 1. Go to **Setup \> User/Roles/ \> Manage Users \> New** and create a new Role. For example, **Token Based Role**. 2. Select **EDIT** and go to **Permissions \> Setup \> Add** and add the following roles: - SOAP Web Services - User Access Tokens - Log in using Access Tokens ##### Generate Token 1. Go to **Setup \> User/Roles/ \> Access Tokens \> New**. 2. Select the created APPLICATION NAME for Token Based Authentication and select **User**. 3. Select the created ROLE for Token Based Authentication and select **Save**. 4. If required, edit the TOKEN NAME. 5. Save the provided details. The **Token ID** and **Token Secret** are generated for the application. 6. Copy the **Token ID** and **Token Secret** for use in configuration. > [!IMPORTANT] > > The only time the Token ID and Token Secret values are displayed is on the confirmation page. These values can't be retrieved from the system after you exit the confirmation page. If the Token Id and Token Secret values are lost, then repeat the **Generate Token** process to generate new values. #### User Credentials Perform the following to obtain an Oracle NetSuite Application ID: 1. Log in to your Oracle NetSuite account. 2. Go to **Setup \> Integrations \> Manage Integrations \> New**. 3. Provide the name of the application that will integrate with Oracle NetSuite. > **Note** > > Ensure that **Token Based Authentication** is unchecked and that only **User Authentication** is selected. 4. Save the provided details. The **Application ID** is generated for the application. 5. Save the generated **Application ID** to use during the configuration. > **Note** > > User Credential Authentication is deprecated for the new NetSuite application, as Oracle NetSuite no longer supports it. Token Based Authentication is the default option. ## Required Permissions The Oracle NetSuite connector must be able to perform the following operations on Oracle NetSuite employee data: - Search - Create - Update - Access Custom Attributes Since a role is required that has the permissions to the necessary operations, you must create a role in Oracle NetSuite that has the following permissions for **User Credentials** and **Token Based Authentication**. The following table lists the minimum permissions for **User Credentials**: | Permission | Level | Sub-section of Permission Tab | | --- | --- | --- | | SOAP Web Services | Full | Setup | | Employees | Full | Lists | | Employee Record | Full | Lists | | Custom Record Entries | Full | Lists | | Custom Entity Fields | Full | Setup | The following table lists the minimum permissions for **Token Based Authentication**: | Permission | Level | Sub-section of Permission Tab | | --- | --- | --- | | User Access Tokens
Or
Log in using Access Tokens | Full | Setup | | SOAP Web Services | Full | Setup | | Employees | Full | Lists | | Employee Record | Full | Lists | | Custom Record Entries | Full | Lists | | Custom Entity Fields | Full | Setup | #### Permissions for Optimized Aggregation The following permissions must be set if the `optimisedAggregation` flag is set to `true` for both User Credentials and Token Based Authentication. | Permission | Level | Sub-section of Permission Tab | | --- | --- | --- | | Control Suite Script and Workflow Triggers in Web Service Request | Full | Setup | #### Permissions for Additional Attributes The following permissions must be added to provision the additional attributes for both User Credentials and Token Based Authentication. | Permission | Level | Sub-section of Permission Tab | | --- | --- | --- | | Departments | view | Lists | | Currency | view | Lists | | Classes | view | Lists | | Subsidiary | view | Lists | | Location | view | Lists | # Machine Account Attributes ## Machine Account Provisioning Attributes Machine account attributes are used in provisioning configurations for machine accounts. After you have [created the required machine account subtypes](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() for more information. # Provisioning The Oracle NetSuite connector supports provisioning, allowing you to create and manage accounts and entitlements in Oracle NetSuite directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes | Account Attribute | Generator | Description | | --- | --- | --- | | EmpID | Identity Attribute | The SailPoint User Name | | password | Generator | Create password | | Email | Identity Attribute | Email of the employee. Select the email type from the drop-down list as per your requirement. The email types are Work Email and Alternate Email. | | OfficePhoneNumber | Disable | Office phone number of the employee | | Fax | Disable | Fax number of the employee | For the Oracle NetSuite connector, `email` and `password` are required as provisioning attributes when a role is assigned to an existing NetSuite account without any pre-existing roles. The Oracle NetSuite connector supports the `EmpID` attribute as an identity attribute in the provisioning policy. Previously it was generated as `$(firstname)$(uniqueCounter)`. ### Additional Provisioning Policy Attributes | Account Attribute | Description | | --- | --- | | FirstName | The employee's first name | | LastName | The employee's last name | | Department | The Department of the user | | DefaultExpenseReportCurrency | Default Currency for Expense Reports | | Class | Class of the employee | | Requirepwdchange | Indicates if a password change is required | | giveAccess (supported only for update operation) | To disable giveAccess, make sure Password is not set in an update request | | Location | The Location of the user | | Subsidiary | The subsidiary associated with the employee | The following fields can be configured for provisioning: | Type | Attribute | | --- | --- | | String | accountNumber
initials
middleName
phone
salutation | | Boolean | usePerquest
isSalesRep
isSupportRep
sendEmail
eligibleForCommission | | Date | lastPaidDate
birthDate
hireDate
releaseDate
lastReviewDate
nextReviewDate | | Double | expenseLimit
purchaseOrderLimit
purchaseOrderApprovalLimit
approvalLimit
laborCost | # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The Oracle NetSuite connector uses the following default correlation and object configurations. ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | InternalID (Numeric) | Account | | GroupInternalID | Group | ### Default Account Attributes The Oracle NetSuite connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Description | | --- | --- | | EmpID | Employee ID. Display Attribute | | InternalID | Auto-generated Internal ID of the employee | | EmployeeStatus | The status of the employee | | Email | Email ID of the employee | | Initial | The initials of the employee's first name and last name | | Fax | Employee's fax number | | OfficePhoneNumber | Office phone number of the employee | | HomePhoneNumber | Home phone number of the employee | | MobilePhoneNumber | Mobile number of the employee | | Department | Department of the employee | | DepartmentID | The ID of the department. If the DepartmentID needs to be aggregated and provisioned it must be added manually. | | Class | Class of the employee | | BillingClass | Billing class of the employee | | Groups | Groups associated to the employee (Entitlements) | | GlobalSubscriptionStatus | Subscription status of the employee | | Supervisor | Supervisor of the employee | | DateOfHiring | Date that the employee was hired | | Type | The employee's work type | | JobTitle | The employee's job title | | jobDescription | Description of the employee's job title | | TimeApprover | Approver of time for the employee | | FirstName | The employee's first name | | LastName | The employee's last name | | Subsidiary | Subsidiary associated with the employee | | GiveAccess | The employee's access to NetSuite. | | DefaultExpenseReportCurrency | Default currency for expense reports | | Currency | The Currency for an the employee automatically defaults to the base currency of the associated subsidiary or company. | | ExternalId | External Id of the employee | | Location | Location of the employee | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The Oracle NetSuite connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. | Attribute Name | Description | | --- | --- | | GroupName | Name of the group. Display Attribute | | GroupInternalID | Auto generated Internal ID of the group. This is an Account ID which must not be changed. | # Migrate VA-based Source to a SaaS Source Some sources that are connected to virtual appliance (VA) clusters can be migrated to SaaS connections. This ensures data (users and entitlements) remain intact and can maintains your source configurations like access profiles, roles, password settings, and correlation configurations when switching from a VA cluster to a SaaS connection. To migrate a source from a VA-based source to a SaaS source, you will provide configuration details on a draft version of the source before publishing the source. > [!NOTE] > > - You must have an Admin or Source Admin user level to migrate a source. A draft version of the source is created. As your migration process is in progress the live source will continue to work as it is. For more information on the Oracle NetSuite SaaS connector, refer to the [Oracle NetSuite SaaS Supported Features](). ## Important Considerations Before Migrating - You do not need to edit additional configurations (other than connection credentials) to migrate the source. - If your source migration is in progress, please do not make any configuration changes to your live source as those can be overwritten once you apply the migration your draft version. - Once you've gone ahead with your migration, it can't be rolled back. Your source is permanently migrated to a SaaS source. - Any preview operations or configuration changes on the draft source will not impact the live source until you apply the migration. ## Migrating Sources To migrate your source, complete the following: 1. Go to **Admin \> Connections \> Sources**. 2. Select or edit the VA-based source you want to migrate. 3. Open the source configuration, and select **Migrate to SaaS**. 4. When prompted, select **Continue**. A draft version of the source is created. The live source will continue to work. 5. Select **Connection Settings**. 6. Re-enter encrypted configuration details. For example, you might need to re-enter the Client Secret, Password, Refresh Token, Personal Access Token (PAT), or Certificates to migrate from the VA cluster to the SaaS connection. > **Important** > > Avoid editing the other configuration options in the draft source. 7. Select **Review and Test**. 8. Select **Test Connection**. 9. (Optional) Select **Accounts**. If you successfully tested your connection in **Review and Test**, you can select **Preview** to display a subset of accounts from the application that will be mapped to SailPoint identities. This can help ensure you are accurately connecting identity data from the application with SailPoint identities. 10. (Optional) Select **Entitlements**. If you successfully tested your connection in **Review and Test** and your source type supports entitlement type configuration, you can select **Preview** to view a preview of entitlements using the current configuration settings. 11. When you've finished reviewing your changes and successfully tested your connection, select **Apply Migration**. Your changes will be applied to the live source and the draft source will be deleted. ## Viewing Source Migration Status You can view the status and creation date of draft sources. 1. Go to **Admin \> Connections \> Sources \> Source Migration Status**. 2. Select **Source Migration Status**. 3. To view or edit the draft source, select **Actions** ![]() **\> Preview** on the draft source. 4. To delete the draft source, select **Actions** ![]() **\> Delete** on the draft source. # Enable Connector Logging This topic provides the steps needed to enable logging on SailPoint using REST APIs. > [!NOTE] > > This topic only applies to VA-based integrations. > [!NOTE] > > The examples provided might not match your configuration. Use the logging levels and logging classes reference at the bottom of the topic to configure your API responses to match your connector. This process is broken up into four steps: 1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging. 2. Get the logging configuration for the existing VA cluster. 3. Update the VA cluster to enable logging levels. 4. Observe logging changes to the logging levels. ### Identify the Virtual Appliance Cluster Select the VA on which you need to enable logging using REST API. If you already know the VA application's `id`, proceed to [Get the Logging Configuration](<#get-the-logging-configuration>). 1. Make the following call to the REST API to return a list of available VA clusters: GET /v3/managed-clusters The REST API returns a response that looks similar to the following: ```json [ { "id": "2c9180866166b5b0016167c32ef31a66", "name": "Development Cluster", "description": "Development Cluster", "clientType": "CCG", "ccgVersion": "373_535_70.2.0", "pinnedConfig": true, "logConfiguration": null }, { "id": "2c9180846a93ce60016ab29f039944de", "name": "Cloud Cluster", "description": "Cloud Cluster", "clientType": "CCG", "ccgVersion": "373_535_70.2.0", "pinnedConfig": true, "logConfiguration": { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } } ] ``` > **Note** > > The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the `logConfiguration` value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster. 2. Identify the VA cluster that you want to enable logging on by its name or description and record its `id` attribute. ### Get the Logging Configuration Get your selected VA's cluster logging configuration and identify the values you need to update. 1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier. GET /v3/managed-clusters/{id}/log-config - If the VA doesn't have a logging configuration currently set, it returns `204 No Content` as a response. - If the VA has an existing logging configuration, it returns something similar to the following: ```json { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` You'll need to configure the following information in the response: - `durationMinutes` is the number of minutes logging should remain enabled. - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>). - `logLevels` is a map object with logging classes as keys and logging levels as values. - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes. - For a list of available values, refer to [Logging Levels](<#logging-levels>). ### Update Logging Configuration Update the VA cluster configuration returned by the REST API to update the logging settings as needed. 1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier. PUT /v3/managed-clusters/{id}/log-config 2. Submit your configuration changes to the REST API in a JSON body. - If the VA cluster did not already have a logging configuration and you received a `204 No Content` response, you can create a new one. - If the VA returned a configuration, you can edit it to include the changes. The JSON body should be as follows: ```json { "durationMinutes": 60, "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` Consider the following as you edit the JSON: - `durationMinutes` is the number of minutes logging should remain enabled. - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>). - `logLevels` is a map object with logging classes as keys and logging levels as values. - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes. - For a list of available values, refer to [Logging Levels](<#logging-levels>). If the update was successful, the REST API should return a response similar to the following: ```json { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` ### Observe Logging Changes Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in **ccg.log**. ### References The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file. #### Logging Levels | Logging Level | Description | | --- | --- | | ERROR | Designates error events that might still allow the connector to continue. | | WARN | Designates potentially harmful situations. | | INFO | Designates information messages that highlight process at a coarse-grain level. | | DEBUG | Very verbose. Fine grain logging levels used for development and debugging. | | TRACE | Most verbose. Finer grain logging levels than debugging. | #### Logging Classes | Connector | Logging Class | | --- | --- | | Active Directory | sailpoint.connector.ADLDAPConnector sailpoint.connector.LDAPConnector | | AIX | openconnector.connector.unix.AIXConnector openconnector.connector.unix.UnixConnector | | Amazon Web Services | logger.aws.name=openconnector.connector.aws logger.aws.level=trace logger.aws.additivity = false logger.aws.appenderRef.rolling.ref = STDOUT | | Atlassian Suite Cloud | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianConnector | | Atlassian Data Center | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianDataCenterConnector | | Microsoft Entra ID | sailpoint.connector.AzureADConnector | | Box | openconnector.connector.BoxNetConnector sailpoint.connector.OpenConnectorAdapter | | Cerner | openconnector.connector.CernerConnector sailpoint.connector.OpenConnectorAdapter | | Delimited File | logger.DelimitedFileConnector.name = sailpoint.connector.DelimitedFileConnector logger.DelimitedFileConnector.level = debug logger.DelimitedFileConnector.additivity = false logger.DelimitedFileConnector.appenderRef.rolling.ref = STDOUT | | Dropbox | openconnector.connector.DropBoxConnector sailpoint.connector.OpenConnectorAdapter | | Epic | openconnector.connector.EPICConnector sailpoint.connector.OpenConnectorAdapter | | GE Centricity | openconnector.connector.GECentricity sailpoint.connector.OpenConnectorAdapter | | Google Apps / G Suite | openconnector.connector.GoogleAppsDirect sailpoint.connector.OpenConnectorAdapter | | IBM i | openconnector.connector.IBMiConnector | | Lotus Domino | sailpoint.connector.LotusDomino | | JDBC | sailpoint.connector.JDBCConnector | | Sun One LDAP | sailpoint.connector.LDAPConnector | | Linux | openconnector.connector.unix.LinuxConnector sailpoint.connector.OpenConnectorAdapter sailpoint.connector.UnixConnector | | Microsoft Office365 | sailpoint.connector.Office365Connector | | Microsoft SQL Server | sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2 | | Okta | logger.openconnector.name = openconnector.connector.okta.OktaConnector logger.openconnector.level = debug logger.openconnector.additivity = false logger.openconnector.appenderRef.rolling.ref = STDOUT | | Oracle Database | sailpoint.connector.OracleDBConnector sailpoint.connector.JDBCConnector | | Oracle E-Business | sailpoint.connector.OracleEBSConnector sailpoint.connector.JDBCConnector | | Oracle Fusion HCM | openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector sailpoint.connector.OpenConnectorAdapter | | Oracle HCM Cloud | sailpoint.connector.oraclehcmcloud.OracleHCMCloudConnector | | Oracle HRMS | sailpoint.connector.OracleAppsHRMSConnector sailpoint.connector.JDBCConnector | | Oracle Netsuite | openconnector.connector.netsuite.NetsuiteConnector | | PeopleSoft ERP | openconnector.connector.PeopleSoftConnector sailpoint.connector.OpenConnectorAdapter | | PeopleSoft HRMS | sailpoint.connector.PeopleSoftHRMSConnector | | RemedyForce | sailpoint.connector.ForceConnector | | RSA Authentication Manager | openconnector.connector.RSAConnector openconnector.connector.rsa.RSAHTTPClient sailpoint.connector.OpenConnectorAdapter | | Salesforce | sailpoint.connector.ForceConnector | | SAP Concur | openconnector.connector.sapconcur.SAPConcurConnector | | SAP - Direct | sailpoint.connector.SAPConnector sailpoint.connector.SAPInternalConnector | | SAP GRC | logger.SAPGRCConnector.name = sailpoint.connector.sapgrc logger.SAPGRCConnector.level = debug logger.SAPGRCConnector.additivity = false logger.SAPGRCConnector.appenderRef.rolling.ref = STDOUT | | SAP HR/HCM | sailpoint.connector.SAPHRInternalConnector | | SCIM 1.1 | openconnector.connector.SCIMConnector sailpoint.connector.OpenConnectorAdapter | | SCIM 2.0 | openconnector.connector.scim2.SCIM2Connector sailpoint.connector.OpenConnectorAdapter | | ServiceNow | openconnector.connector.servicenow.ServiceNowConnector openconnector.connector.servicenow.ServiceNowRestClient sailpoint.connector.OpenConnectorAdapter | | ServiceNow Service Desk Integration | openconnector.connector.servicedesk.ServiceNowServiceDeskConnector sailpoint.connector.OpenConnectorAdapter | | Siebel | openconnector.connector.SiebelConnector sailpoint.connector.OpenConnectorAdapter | | Snowflake | openconnector.connector.snowflake.SnowflakeConnector sailpoint.connector.OpenConnectorAdapter | | Solaris | openconnector.connector.unix.SolarisConnector openconnector.connector.unix.UnixConnector sailpoint.connector.OpenConnectorAdapter | | SuccessFactors | sailpoint.connector.SuccessFactorsConnector | | Sybase | sailpoint.connector.SybaseDirectConnector sailpoint.connector.JDBCConnector | | Webex | openconnector.connector.Webex sailpoint.connector.OpenConnectorAdapter | | Workday | openconnector.connector.WorkDay sailpoint.connector.OpenConnectorAdapter | | Workday Accounts | openconnector.connector.workdayaccounts openconnector.connector.workdayaccounts.WorkdayAccountsConnector sailpoint.connector.OpenConnectorAdapter | | Web Services | sailpoint.connector.WebServices | | XML | openconnector.connector.XMLConnector sailpoint.connector.OpenConnectorAdapter | | Yammer | openconnector.connector.YammerConnector sailpoint.connector.OpenConnectorAdapter | | Zoom | openconnector.connector.zoom.ZoomConnector sailpoint.connector.OpenConnectorAdapter | # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Provisioning of account fails with subsidiary not found exception error. ```text Exception occurred in setEmployee USER_ERROR: Please enter value(s) for: Subsidiary was not found. ``` **Resolution**: Ensure the subsidiary is active and the service user has all the required permissions. ## Test connection fails with an error message Test connection fails with the following error message: ```text java.net.UnknownHostException: webservices.netsuite.com ``` This issue may occur if there is no Internet connection. **Resolution**: Ensure that there is Internet connection. ## Provisioning fails with a message The following message is displayed when no role is assigned to an employee: ```text The account dont have access permissions to netsuite server, so roles can not be added ``` **Resolution**: Perform the following: 1. Log in to Oracle NetSuite account. 2. Assign at least one role to Employee. 3. Run Account and Group aggregation. ## Account/ Group Aggregation fails with an error message Account/Group aggregation fails with the following error message: ```text The server encountered an unexpected error while contacting target system. Please check the logs.ExceededRequestLimitFault ``` **Resolution**: Perform either of the following: - Use **Token Based Authentication** to achieve concurrent execution. - Obtain the SuiteCloud plus license. ## Test connection fails with Two-Factor Authentication Roles Test Connection fails with the following error message when Two-Factor Authentication Roles is enabled (2FA authentication required) on the Managed System: ```text Enter valid Application ID, Email, Password, Role ID or verify user has valid permissions. [Error details] Error occurred before establishing the connection with NetSuite Server.InvalidCredentialsFault ``` **Resolution**: Use **Token Based Authentication** or disable the Two-Factor Authentication Roles (2FA) flag by setting it to **not required** on the Managed System (Oracle NetSuite). ## Aggregation fails with an error message after an hour Aggregation takes more than an hour and fails with the following error message: ```text Error received: openconnector.ConnectorException: InvalidSessionFault ``` **Resolution**: The NetSuite managed system has the default absolute session timeout value set to 60 minutes even if the session is active for **User Credentials** and **Authentication**. So Oracle recommends to use **Token Based Authentication** (TBA). ## Group aggregation fails due to timeout issue When token-based authentication is used, group aggregation fails after 60 minutes due to timeout issue. The Oracle NetSuite connector can be configured to use REST Web Services with SuiteQL in order to prevent group aggregation timeout. **Resolution**: Perform the following: 1. Log in to your Oracle NetSuite account. 2. Enable Rest Web Service on the Oracle NetSuite tenant. 1. Go to **Setup \> Company \> Enable features**. 2. Select the **SuiteCloud** sub-tab. 3. Check the **REST WEB SERVICES** in the SuiteTalk (Web Services) section. 3. Add the following additional permission to the role associated with the service account credentials: | Permissions | Level | Sub-section of Permission Tab | | --- | --- | --- | | SuiteAnalytics Workbook | Edit | Report | | Bulk Manage Roles | Full | Setup | | REST Web Services | Full | Setup | 4. Add following entry key to source XML file. Refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)](). ```text ``` 5. Perform entitlement aggregation. # Timeout Errors and Settings Timeout errors might occur when SailPoint is waiting for a response from the Virtual Appliance (VA). These errors are applicable to all connectors and tend to occur during the setup of sources or when sources are down. This document is designed to give specific information that can be used to resolve these errors. Each timeout attribute has a default time value that is listed in seconds or minutes. Increasing the time value may resolve the error as it will allow for longer communication time between the two systems, thus avoiding the timeout error. > [!IMPORTANT] > > Add the necessary attributes or values before performing the "replace" operation, as missing attributes will cause the operation to fail. To increase the communication time, increase the value of the appropriate timeout attribute. Then submit the change to the VA using the SailPoint REST API. > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. ### aggregateTimeout **Description:** This parameter is set for the aggregation timeout, measured in seconds. **Resolution:** Increase the `aggregateTimeout` value gradually to optimize aggregation. Start with 180, then increase to 600, 900, and finally 1800. The maximum value is 3600 seconds. For example: If your current time value is 180 seconds, update the `aggregateTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/aggregateTimeout", "value": 600 } ] ``` ### healthCheckTimeout **Description:** This parameter is set for the test connection and health check timeout. **Resolution:** The default value is 30 seconds. If the timeout error continues, increase the value in 15 second increments and try again. For example: If your current time value is 30 seconds, update the `healthCheckTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/healthCheckTimeout", "value": 45 } ] ``` ### provisioningTimeout **Description:** This parameter is set for provisioning timeout. **Resolution:** Increase the `provisioningTimeout` value gradually to optimize provisioning. Start with 180, then increase to 360, and finally 600. The maximum value is 600 seconds. For example: If your current time value is 180 seconds, update the `provisioningTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/provisioningTimeout", "value": 360 } ] ``` ### timeout **Description:** This parameter is set for pass-through authentication timeout. **Resolution:** The default value is 15 seconds. If the timeout error continues, increase this value in 15 second increments and try again. For example: If your current time value is 15 seconds, update the `timeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/timeout", "value": 30 } ] ``` ### apiTimeout **Description:** This parameter is set for API time tracking; customers can check it using an external tool. **Resolution:** The default value is 60 seconds. If the error continues, increase the value by 15 second increments and try again. For example: If your current time value is 60 seconds, update the `apiTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/apiTimeout", "value": "75" } ] ``` ### timeoutInSeconds **Description:** This parameter helps prevent the VA from waiting indefinitely for an API response, ensuring efficient handling of API requests. For example: If your current time value is 30 seconds, update the `timeoutInSeconds` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/timeoutInSeconds", "value": "15" } ] ```