A SuiteQL Lookup can run a flexible lookup based on source columns using SQL syntax.

Create a SuiteQL Lookup

1. On the Integration tab, click on Additional Columns tab
2. Click the Add Additional Column button

3. Name – Enter a name for the column
4. Type – Select SuiteQL Lookup from the Type dropdown list
5. Query – In the Query editor create a SuiteQL query
   • Drag any source columns or Global Variables into your script
6. Format SuiteQL – Reformat query for better readability

6. Return Fields – Select the field(s) that will be returned from the lookup
7. If No Data – Select the required option if no data is found

8. Process Unmapped Column – If the lookup should be ran even when it is not mapped on the line
   • Use this if the result is only used in another additional column
9. Late Bound Lookup – If the lookup should run after the calculations and restrictions
10. Include lookup result in scripting – If the result of the lookup should be available to use in Calculated Columns

10. Click Save to save the column settings

Using SuiteQL Schema

By default, a SuiteQL Lookup will only return fields that contain data. So it may be necessary to define your fields in the data source schema to ensure they are always available for mapping.

Load initial Schema

1. Build your lookup query
2. Click the Schema tab
3. Click Load Schema – this will run a sample query and add all returned columns
4. Optionally – edit the data type of fields to ensure correct data interpretation

5. Click Save

Modify Schema

If small changes are made to the query, it may be required to edit the schema using these steps.

1. Open an existing SuiteQL Lookup
2. Click Validate
3. Click the Schema tab
4. Click Refresh Schema to add any new fields – this will not remove existing fields
5. Add Column allows you to manually add a column if it is not being returned in the sample query
6. Click Validate
7. Click Save

Recreate Schema

If large changes are made to the query, it may be required to rebuild the schema using these steps.

1. Open an existing SuiteQL Lookup
2. Click Validate
3. Click the Schema tab
4. Click Clear Schema -will remove all schema columns from the source
5. Click Load Schema – this will run a sample query and add all returned columns
6. Click Validate
7. Click Save