Sage Intacct Query

Sage Intacct Query



Sage Intacct Query

The Sage Intacct Query component integrates with the Sage Intacct API to retrieve data and then load it into a table.

Warning: This component is potentially destructive. If the target table undergoes a change in structure, it will be recreated. Otherwise, the target table is truncated. Setting the Load Option setting "Recreate Target Table" to Off will prevent both recreation and truncation. Do not modify the target table structure manually.


Redshift Properties

Property Setting Description
Name String Input the descriptive name for the component.
Basic/Advanced Mode Select Basic: This mode will build a query for you using settings from the Data Source, Data Selection, and Data Source Filter parameters. In most cases, this mode will be sufficient.
Advanced: This mode will require you to write an SQL-like query to call data from Sage Intacct. The available fields and their descriptions are documented in the Sage Intacct Data Model.
CompanyID String Please provide your Sage Intacct CompanyID.
User String Please provide your Sage Intacct username.
Password String/Password Manager Please provide the password that corresponds to your username. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
SenderID String Please provide your Sage Intacct SenderID.
Note: Users require a Sage Intacct Web Services Developer Licence to have a SenderID.
Sender Password String/Password Manager Please provide the password that corresponds to your SenderID. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
Connection Options Parameter A JDBC parameter supported by the Database Driver. The available parameters are explained in the Data Model.
Manual setup is not usually required, since sensible defaults are assumed.
Value A value for the given Parameter.
Data Source Select Select a data source.
Data Selection Multiple Select Choose one or more columns to return from the query. The columns available are dependent upon the data source selected.
Data Source Filter Input Column Select an input column. The available input columns vary depending upon the Data Source.
Qualifier Is: Compares the column to the value using the comparator.
Not: Reverses the effect of the comparison, so "equals" becomes "not equals", "less than" becomes "greater than or equal to", etc.
Comparator Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", and "Null".
"Equal to" can match exact strings and numeric values, while other comparators such as "Greater than" and "Less than" will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The "Null" operator matches only null values, ignoring whatever the value is set to.
Not all data sources support all comparators. Therefore, it is likely that only a subset of the above comparators will be available to choose from.
Value The value to be compared.
SQL Query Text This is an SQL-like SELECT query, written according to the Sage Intacct Data Model. This property is only available in Advanced Mode.
Combine Filters Select Select whether to use the defined filters in combination with one another according to either And or Or.
Limit Integer Set a numeric value to limit the number of rows that are loaded.
Type Select Choose between using a standard table or an external table.
Standard: The data will be staged on an S3 bucket before being loaded into a table.
External: The data will be put into an S3 bucket and referenced by an external table.
Location S3 Bucket Select an S3 bucket path that will be used to store the data. Once the data is on an S3 bucket, it can be referenced by an external table.
This property is only available when the Type property is set to "External".
Schema Select Select the table schema. The special value, [Environment Default], will use the schema defined in the environment. For more information on using multiple schemas, see this article.
Note: An external schema is required if the Type property is set to "External".
Target Table String Provide a new table name.
Warning: This table will be recreated and will drop any existing table of the same name.
S3 Staging Area Select The name of an S3 bucket for temporary storage. Ensure your access credentials have S3 access, as well as permission to write to the bucket. See this document for details on setting up access. The temporary objects created in this bucket will be removed again after the load completes, they are not kept.
Distribution Style Select All: Copy rows to all nodes in the Redshift cluster.
Auto: (Default) Allow Redshift to manage your distribution style.
Even: Distribute rows around the Redshift cluster evenly.
Key: Distribute rows around the Redshift cluster according to the value of a key column.
Table distribution is critical to good performance. See the Amazon Redshift documentation for more information.
Sort Key Multiple Select This is optional, and lets users specify one or more columns from the input that should be set as the table's sort key.
Sort keys are critical to good performance - see the Amazon Redshift documentation for more information.
Sort Key Options Select Decide whether the sort key is of a compound or interleaved variety - see the Amazon Redshift documentation for more information.
Primary Key Multiple Select Select one or more columns to be designated as the table's primary key.
Load Options Multiple Select Columns Comp Update: Apply automatic compression to the target table. Default is On.
Stat Update: Automatically update statistics when filling a table. Default is On. In this case, it is updating the statistics of the target table.
Clean S3 Objects: Automatically remove UUID-based objects on the S3 bucket. Default is On. Effectively, users decide here whether to keep the staged data in the S3 bucket or not.
String Null is Null: Converts any strings equal to "null" into a null value. This is case sensitive and only works with entirely lower-case strings. Default is On.
Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the component will use an existing table or create one if it does not exist. Default is On.
File Prefix: Give staged file names a prefix of your choice. When this Load Option is selected, users should set their preferred prefix in the text field.
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Encryption Select Decide on how the files are encrypted inside the S3 bucket.
None: No encryption.
SSE KMS: Encrypt the data according to a key stored on KMS.
SSE S3: Encrypt the data according to a key stored on an S3 bucket
KMS Key ID Select The ID of the KMS encryption key you have chosen to use in the Encryption property.
Auto Debug Select Choose whether to automatically log debug information about your load. These logs can be found in the Task History and should be included in support requests concerning the component. Turning this on will override any debugging Connection Options.
Debug Level Select The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution.
1: Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
3: Will additionally log the body of the request and the response.
4: Will additionally log transport-level communication with the data source. This includes SSL negotiation.
5: Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

Snowflake Properties

Property Setting Description
Name String Input the descriptive name for the component.
Basic/Advanced Mode Select Basic: This mode will build a query for you using settings from the Data Source, Data Selection, and Data Source Filter parameters. In most cases, this mode will be sufficient.
Advanced: This mode will require you to write an SQL-like query to call data from Sage Intacct. The available fields and their descriptions are documented in the Sage Intacct Data Model.
CompanyID String Please provide your Sage Intacct CompanyID.
User String Please provide your Sage Intacct username.
Password String/Password Manager Please provide the password that corresponds to your username. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
SenderID String Please provide your Sage Intacct SenderID.
Note: Users require a Sage Intacct Web Services Developer Licence to have a SenderID.
Sender Password String/Password Manager Please provide the password that corresponds to your SenderID. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
Connection Options Parameter A JDBC parameter supported by the Database Driver. The available parameters are explained in the Data Model.
Manual setup is not usually required, since sensible defaults are assumed.
Value A value for the given Parameter.
Data Source Select Select a data source.
Data Selection Multiple Select Choose one or more columns to return from the query. The columns available are dependent upon the data source selected.
Data Source Filter Input Column Select an input column. The available input columns vary depending upon the Data Source.
Qualifier Is: Compares the column to the value using the comparator.
Not: Reverses the effect of the comparison, so "equals" becomes "not equals", "less than" becomes "greater than or equal to", etc.
Comparator Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", and "Null".
"Equal to" can match exact strings and numeric values, while other comparators such as "Greater than" and "Less than" will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The "Null" operator matches only null values, ignoring whatever the value is set to.
Not all data sources support all comparators. Therefore, it is likely that only a subset of the above comparators will be available to choose from.
Value The value to be compared.
SQL Query Text This is an SQL-like SELECT query, written according to the Sage Intacct Data Model. This property is only available in Advanced Mode.
Combine Filters Select Select whether to use the defined filters in combination with one another according to either And or Or.
Limit Integer Set a numeric value to limit the number of rows that are loaded.
Primary Keys Select Select one or more columns to be designated as the table's primary key.
Warehouse Select Choose a Snowflake warehouse that will run the load.
Database Select Choose a database to create the new table in.
Schema Select Select the table schema. The special value, [Environment Default], will use the schema defined in the environment. For more information on using multiple schemas, see this article.
Target Table String Provide a new table name.
Warning: This table will be recreated and will drop any existing table of the same name.
Staging Select Select a staging setting.
Snowflake Managed: Allow Matillion ETL to create and use a temporary internal stage on Snowflake for staging the data. This stage, along with the staged data, will cease to exist after loading is complete.
(AWS only) Existing Amazon S3 Location: Selecting this will offer the S3 Staging Area property, allowing users to specify a custom staging area on Amazon S3.
(Azure only) Existing Azure Blob Storage Location: Selecting this will offer the Storage Account and Blob Container properties, allowing users to specify a custom staging location on Azure.
(GCP only) Existing Google Cloud Storage Location: Selecting this will offer the GCS Staging Area property, allowing users to specify a custom staging area within Google Cloud Storage.
GCS Staging Area Select (GCP only) The URL and path of the target Google Storage bucket to be used for staging the queried data.
Integration Select Choose your Google Cloud Storage Integration. Integrations are required to permit Snowflake to read data from and write to a Google Cloud Storage bucket. Integrations must be set up in advance of selecting them in Matillion ETL. To learn more about setting up a storage integration, read our Storage Integration Setup Guide.
S3 Staging Area Filepath (AWS only) The name of an S3 bucket for temporary storage. Ensure your access credentials have S3 access, as well as permission to write to the bucket. See this document for details on setting up access. The temporary objects created in this bucket will be removed again after the load completes, they are not kept.
Storage Account Select (Azure only) Select a Storage Account with to be used for staging the data.
Blob Container Select (Azure only) Select a Blob Container to be used for staging the data.
Encryption Select (AWS only) Decide on how the files are encrypted inside the S3 bucket.
None: No encryption.
SSE KMS: Encrypt the data according to a key stored on KMS.
SSE S3: Encrypt the data according to a key stored on an S3 bucket
KMS Key ID Select (AWS only) The ID of the KMS encryption key you have chosen to use in the Encryption property.
Load Options Multiple Select Clean Staged Files: Destroy staged files after loading data. Default is On.
String Null is Null: Converts any strings equal to "null" into a null value. This is case sensitive and only works with entirely lower-case strings. Default is Off.
Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the component will use an existing table or create one if it does not exist. Default is On.
File Prefix: Give staged file names a prefix of your choice. The default setting is an empty field.
Trim String Columns: Remove leading and trailing characters from a string column. Default is On
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Auto Debug Select Choose whether to automatically log debug information about your load. These logs can be found in the Task History and should be included in support requests concerning the component. Turning this on will override any debugging Connection Options.
Debug Level Select The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution.
1: Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
3: Will additionally log the body of the request and the response.
4: Will additionally log transport-level communication with the data source. This includes SSL negotiation.
5: Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

BigQuery Properties

Property Setting Description
Name String Input the descriptive name for the component.
Basic/Advanced Mode Select Basic: This mode will build a query for you using settings from the Data Source, Data Selection, and Data Source Filter parameters. In most cases, this mode will be sufficient.
Advanced: This mode will require you to write an SQL-like query to call data from Sage Intacct. The available fields and their descriptions are documented in the Sage Intacct Data Model.
CompanyID String Please provide your Sage Intacct CompanyID.
User String Please provide your Sage Intacct username.
Password String/Password Manager Please provide the password that corresponds to your username. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
SenderID String Please provide your Sage Intacct SenderID.
Note: Users require a Sage Intacct Web Services Developer Licence to have a SenderID.
Sender Password String/Password Manager Please provide the password that corresponds to your SenderID. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
Connection Options Parameter A JDBC parameter supported by the Database Driver. The available parameters are explained in the Data Model.
Manual setup is not usually required, since sensible defaults are assumed.
Value A value for the given Parameter.
Data Source Select Select a data source.
Data Selection Multiple Select Choose one or more columns to return from the query. The columns available are dependent upon the data source selected.
Data Source Filter Input Column Select an input column. The available input columns vary depending upon the Data Source.
Qualifier Is: Compares the column to the value using the comparator.
Not: Reverses the effect of the comparison, so "equals" becomes "not equals", "less than" becomes "greater than or equal to", etc.
Comparator Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", and "Null".
"Equal to" can match exact strings and numeric values, while other comparators such as "Greater than" and "Less than" will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The "Null" operator matches only null values, ignoring whatever the value is set to.
Not all data sources support all comparators. Therefore, it is likely that only a subset of the above comparators will be available to choose from.
Value The value to be compared.
SQL Query Text This is an SQL-like SELECT query, written according to the Sage Intacct Data Model. This property is only available in Advanced Mode.
Combine Filters Select Select whether to use the defined filters in combination with one another according to either And or Or.
Limit Integer Set a numeric value to limit the number of rows that are loaded.
Project Select The target BigQuery project to load data into.
Dataset Select The target BigQuery dataset to load data into.
Target Table String Provide a new table name.
Warning: This table will be recreated and will drop any existing table of the same name.
Cloud Storage Staging Area Filepath The URL and path of the target Google Storage bucket to be used for staging the queried data.
Load Options Multiple Select Clean Cloud Storage Files: Destroy staged files on Cloud Storage after loading data. Default is On.
Cloud Storage File Prefix: Give staged file names a prefix of your choice. The default setting is an empty field.
Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the component will use an existing table or create one if it does not exist. Default is On.
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Auto Debug Select Choose whether to automatically log debug information about your load. These logs can be found in the Task History and should be included in support requests concerning the component. Turning this on will override any debugging Connection Options.
Debug Level Select The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution.
1: Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
3: Will additionally log the body of the request and the response.
4: Will additionally log transport-level communication with the data source. This includes SSL negotiation.
5: Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

Synapse Properties

Property Setting Description
Name String Input the descriptive name for the component.
Basic/Advanced Mode Select Basic: This mode will build a query for you using settings from the Data Source, Data Selection, and Data Source Filter parameters. In most cases, this mode will be sufficient.
Advanced: This mode will require you to write an SQL-like query to call data from Sage Intacct. The available fields and their descriptions are documented in the Sage Intacct Data Model.
CompanyID String Please provide your Sage Intacct CompanyID.
User String Please provide your Sage Intacct username.
Password String/Password Manager Please provide the password that corresponds to your username. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
SenderID String Please provide your Sage Intacct SenderID.
Note: Users require a Sage Intacct Web Services Developer Licence to have a SenderID.
Sender Password String/Password Manager Please provide the password that corresponds to your SenderID. You can store your password inside the component, or use the Matillion ETL Password Manager feature instead (highly recommended).
Connection Options Parameter A JDBC parameter supported by the Database Driver. The available parameters are explained in the Data Model.
Manual setup is not usually required, since sensible defaults are assumed.
Value A value for the given Parameter.
Data Source Select Select a data source.
Data Selection Multiple Select Choose one or more columns to return from the query. The columns available are dependent upon the data source selected.
Data Source Filter Input Column Select an input column. The available input columns vary depending upon the Data Source.
Qualifier Is: Compares the column to the value using the comparator.
Not: Reverses the effect of the comparison, so "equals" becomes "not equals", "less than" becomes "greater than or equal to", etc.
Comparator Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", and "Null".
"Equal to" can match exact strings and numeric values, while other comparators such as "Greater than" and "Less than" will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The "Null" operator matches only null values, ignoring whatever the value is set to.
Not all data sources support all comparators. Therefore, it is likely that only a subset of the above comparators will be available to choose from.
Value The value to be compared.
SQL Query Text This is an SQL-like SELECT query, written according to the Sage Intacct Data Model. This property is only available in Advanced Mode.
Combine Filters Select Select whether to use the defined filters in combination with one another according to either And or Or.
Limit Integer Set a numeric value to limit the number of rows that are loaded.
Schema Select Select the table schema. The special value, [Environment Default], will use the schema defined in the environment. For more information on schemas, please see the Azure Synapse documentation.
Table String Provide a new table name.
Warning: This table will be recreated on each run of the job, and drop any existing table of the same name.
Storage Account Select Select an Azure storage account with your desired blob container to be used for staging the data.
Please visit the Azure documentation for help creating an Azure Storage Account.
Blob Container Select Select a blob container to be used for staging the data. The blob containers available for selection depend on the chosen storage account.
Load Options Multiple Select Configure this Orchestration Job's load options. These load options will apply each time the job runs. Sensible defaults are assumed. Clean Staged Files: Destroy staged files after loading data. Default is On.
String Null is Null: Converts any strings equal to "null" into a null value. This load option is case-sensitive and only works with entirely lower-case strings. Default is Off.
Recreate Target Table: Choose whether the component recreates its target table before the data load. If set to Off, the existing table will be used instead. Default is On.
File Prefix: Give staged file names a prefix of your choice. The default setting is an empty field.
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Distribution Style Select Select the distribution style
Hash: This setting assigns each row to one distribution by hashing the value stored in the distribution_column_name. The algorithm is deterministic, meaning it always hashes the same value to the same distribution. The distribution column should be defined as NOT NULL, because all rows that have NULL are assigned to the same distribution.
Replicate: This setting stores one copy of the table on each Compute node. For SQL Data Warehouse, the table is stored on a distribution database on each Compute node. For Parallel Data Warehouse, the table is stored in an SQL Server filegroup that spans the Compute node. This behavior is the default for Parallel Data Warehouse.
Round Robin: Distributes the rows evenly in a round-robin fashion. This is the default behaviour.
For more information, please read this article.
Distribution Column Select Select the column to act as the distribution column. This property is only available when the Distribution Style property is set to "Hash".
Index Type Select Select the table indexing type. Options include:
Clustered: A clustered index may outperform a clustered columnstore table when a single row needs to be retrieved quickly. The disadvantage to using a clustered index is that only queries that benefit are the ones that use a highly selective filter on the clusted index column. Choosing this option prompts the Index Column Grid property.
Clustered Column Store: This is the default setting. Clustered columnstore tables offer both the highest level of data compression and the best overall query performance, especially for large tables. Choosing this option prompts the Index Column Order property.
Heap: Users may find that using a heap table is faster for temporarily landing data in Synapse SQL pool. This is because loads to heaps are faster than to index tables, and in some cases, the subsequent read can be done from cache. When a user is loading data only to stage it before running additional transformations, loading the table to a heap table is much faster than loading the data to a clustered columnstore table.
For more information, please consult the Azure Synapse documentation.
Index Column Grid Name The name of each column.
Sort Assign a sort orientation of either acending (Asc) or descending (Desc).
Index Column Order Multiple Select Select the columns in the order to be indexed.
Partition Key Select Select the table's partition key. Table partitions determine how rows are grouped and stored within a distribution.
For more information on table partitions, please refer to this article.
Auto Debug Select Choose whether to automatically log debug information about your load. These logs can be found in the Task History and should be included in support requests concerning the component. Turning this on will override any debugging Connection Options.
Debug Level Select The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution.
1: Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
3: Will additionally log the body of the request and the response.
4: Will additionally log transport-level communication with the data source. This includes SSL negotiation.
5: Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

Variable Exports

This component makes the following values available to export into variables:

Source Description
Time Taken To Stage The amount of time (in seconds) taken to fetch the data from the data source and to upload it to storage.
Time Taken To Load The amount of time (in seconds) taken for the COPY statement to load the data into the target table from the staging area.

Strategy

Connect to the Sage Intacct API and issue the one or more queries. Stream the results into objects into a storage area, and then recreate or truncate the target table as necessary. Then, use a COPY command to load the stored objects into the table. Finally, clean up the temporary stored objects.