Connecting an environment to Salto
Setting up a Salto Netsuite environment (prod, sandbox, etc.) includes two parts:
Installing SuiteCloud Development Framework and creating an Oauth certificate
Salto SuiteApp installation and creating tokens for the Salto integration
Ensure that each of your NS environments has the following 6 features enabled:
OAuth 2.0
SOAP web services
REST web services
Token Based Authentication
SuiteCloud Development Framework
Create bundles with SuiteBundler
Detailed Netsuite environment setup instructions can be found here
Environment settings
To update the settings for a particular environment, navigate to the settings section where you will find:
General: where to update the environment name, setup the Scheduled fetch, and optionally mark an environment as "sensitive"
Application Connections:
credentials used for fetch and deploy (Note: make sure you have set up "Personal credentials" in the environment ahead of starting a deployment)
The Salto adapter config file. (Note: not all types are fetched by default, review the Supported Metadata types docs page. Also review the fetching custom records documentation)
Version Control: Git connection for the environment 🎥: Git for Salto users
Monitor changes: where to set up custom notifications (see below)
Fetching Your Netsuite Configuration
To learn what is the default NetSuite configuration and how you can modify it to support different use-cases such as fetching custom records or file cabinet, check out this guide.
🚧 Note: Adding more types to your fetch configuration is likely to influence the fetch duration, especially if these types have many instances.
Unlock the full potential of analytics in Salto by adjusting your NetSuite adapter configuration to include analytics Workbooks & Datasets.
This enables a deeper analysis and a broader view of your business metrics, leveraging multiple joins and dynamic data presentations.
To enable Analytics in your account, it's necessary to remove the metadata types 'Workbook' and 'Dataset' from your adapter configuration's exclude list.
Fetch Types
There are three types of fetches in Salto:
1. Full Fetch
Fetches all configuration updates for the environment (the scheduled fetch uses a full fetch)
2. Change-Based Fetch
Changed-Based Fetch leverages NetSuite’s ‘system notes’ mechanism and significantly reduces the fetch time by fetching only records and file cabinet items that were modified since your last fetch. (Note: due to NetSuite API limitations, Salto cannot fetch certain updates to some metadata types. Review our documentation to see if a full fetch is required)
3. Custom - Fetch Specific Types or Files
Specifying NetSuite type names and/or file cabinet path patterns (regular expressions) can reduce fetch time.
Once specified, Salto will fetch only instances of specified types and file cabinet items that matches the specified path patterns.
For example, specifying the following targets:
entitycustomfield
addressForm
customrecord_slt_tst
/MyFileCabinetDir/.*\.js
will only fetch entity custom fields, address forms, custom records of customrecord_slt_tst
and all files with the .js
suffix under the MyFileCabinetDir directory.
Note that:
Deletions in File Cabinet can not be detected in a Change-Based Fetch. All other deletions (standard instances, custom types & custom records) are supported.
References in fetched elements will be updated as part of the partial fetch as long as the referenced element exists in the Salto environment. If the referenced element does not exist in the Salto environment (meaning it is either new in that environment and was not fetched yet or that it was deleted), its reference will be omitted until a full regular fetch is performed
Overriding Configuration Values
It is possible to override any fetch configuration property by specifying a key value pair.
Full list of available configuration options can be found here.
Impact Analysis
The explore page in Salto is used to explore your configurations, see dependencies and understand where and how configurations are used.
Monitoring changes
Set up notifications to alert when changes are made in production.
Comparison Overview
Here is an overview of the comparison screen showing you the differences between two environments, part of the compare and deploy process.
Changelog
Salto automatically keeps track of all changes made to each environment in the Changelog.
Backup and Restore
Through the scheduled fetch, Salto will automatically backup the configurations for each environment. Those backups can be used through the restore process to revert any changes made directly in the environment. 🎥 * Ex: Bringing back deleted workflows, saved searches with Salto
Deployment types
There are different types of deployments in Salto
Compare & Deploy: Choose which changes to align between any two environments.
Find environment changes & deploy: Choose the changes made during a specific time period to deploy into another environment. Especially useful when deploying from a shared environment.
Deploy from Pull Request: Initiate a deployment in Salto based on the changes contained in a Pull Request in an SDF repository
Promote a deployment: used to promote the same set up changes to another target environment. (ex: after deploying a set of updates to a form in
UAT
, promoting those same changes up toProduction
)Revert a deployment: Revert all changes made in a specific deployment (Note: to revert specific changes, use the restore process mentioned above)
Deployment examples
Comparing and deploying a custom list
A 3-minute walkthrough of the compare and deploy process using Salto to deploy a new custom list
Deploying forms and saved searches
A detailed walkthrough of deploying forms and saved searches from sandbox to Production using Salto.
Additional References