Prerequisites
Before setting up environments, ensure you have:- Admin access to your Elementum organization
- Snowflake credentials for the new environment (if using Snowflake-connected apps)
- CloudLink configured in your production environment
Part 1: Creating an Environment
Create a new environment from your production organization to start developing and testing in isolation.Navigate to Environments
Create New Environment
Enter Environment Details
| Field | Description | Example |
|---|---|---|
| Environment name | A descriptive name for the environment | Development, Testing, Staging |
| Subdomain | The URL prefix for this environment | dev, test, staging |
| Description | Optional description of the environment’s purpose | For testing new features before production |
[subdomain]-[yourorg].elementum.ioComplete Creation
Part 2: Configuring CloudLink
After creating an environment, configure CloudLink to connect the environment to your data warehouse.Open Environment Configuration
Access CloudLink Settings
Edit CloudLink Connection
- Name - Identifier for this CloudLink connection
- Username - Snowflake service account username
- URL - Your Snowflake account URL (e.g.,
your-account.snowflakecomputing.com) - Authentication Method - Select Password or Key-pair authentication
- Password - Service account password (if using password authentication)
- Interval - Sync frequency (default: 20 minutes)
- Time unit - Minutes, Hours, or Days
Configure Data Connection
- Role - Select the Snowflake role for this connection
- Warehouse - Select the Snowflake warehouse to use
- Database - Select the database where Elementum stores platform data
Save Configuration
Part 3: Deploying Apps Between Environments
Once your environment has CloudLink configured, you can deploy apps to and from it.Navigate to the App
Open Deployments
View Environment Status
- Environment name and description
- Status indicator: Deployed (green), Deploying (yellow), Failed (red), or Not Deployed (gray)
- Deploy button to initiate deployment
Initiate Deployment
- Title: “Deploy App To Environment”
- Message: “Deployment will copy all app configurations and associated objects to the target environment.”
- Visual showing the deployment flow from source to target
- Summary: “Deploy App from [Source] to [Target]”
Confirm and Deploy
- Status changes to “Deploying” (yellow)
- Progress bar shows deployment progress
- Upon completion, status changes to “Deployed” (green)
Monitor Deployment
| Status | Description |
|---|---|
| Deploying | Deployment is in progress |
| Deployed | Deployment completed successfully |
| Failed | Deployment encountered an error |
| Not Deployed | App has not been deployed to this environment |
Part 4: Post-Deployment Configuration
Apps with Tables or Elements linked to Snowflake require additional configuration after deployment. Simple apps without external data dependencies complete immediately.Apps Without External Dependencies
For apps that don’t connect to Snowflake data:- Deployment completes immediately
- Environment card shows green “Deployed” status
- No additional configuration required
- App is ready to use in the target environment
Apps With Snowflake Dependencies
For apps with Tables or Elements linked to Snowflake, you must configure the data connections in the new environment.Access Post-Deployment Configuration
- Green “Deployed” status pill
- “Complete” progress indicator
- Configure button
Review Items Needing Configuration
- Dataset name
- Configuration status (“Not configured”)
- Error count indicating fields needing mapping
Select a Dataset
- Dataset name and error count
- “Configure data source connection and field mappings”
- Valid fields count and errors count
Configure Data Connection
- Database - Select the database from the dropdown
- Schema - Select the schema containing your data
- Table - Select the table that corresponds to this dataset
Map Fields
| Target Field | Action |
|---|---|
| Field from the deployed app | Select the corresponding Source Field from the new environment’s table |
- Use the dropdown to select the matching Source Field
- Ensure data types align (TEXT to TEXT, NUMBER to NUMBER, etc.)
- Repeat for all fields in the dataset
Save Configuration
- Click Configure Dataset to save the configurations
- Configured items are removed from the list
- Continue until all items are configured
- When the list is empty, the modal closes
Troubleshooting
Deployment Fails Immediately
Deployment Fails Immediately
- CloudLink not configured in target environment
- CloudLink credentials invalid or expired
- Network connectivity issues
- Verify CloudLink is configured in the target environment
- Test CloudLink connection in Organization Settings
- Check Snowflake service account permissions
Cannot See Target Environment
Cannot See Target Environment
- Environment not yet created
- Insufficient permissions to view environments
- Verify the environment exists in Organization Settings > Environments
- Contact your administrator to check access permissions
Field Mapping Errors
Field Mapping Errors
- Table structure differs between environments
- Missing columns in target environment’s table
- Data type mismatches
- Verify the target table exists and has the expected columns
- Check that column names match or can be mapped correctly
- Ensure data types are compatible between source and target
Configure Button Not Appearing
Configure Button Not Appearing
Using the Same Snowflake User Across Environments in Different Organizations
Using the Same Snowflake User Across Environments in Different Organizations
-
Obtain the Public Key from the Organization You Are Adding the CloudLink To:
- Navigate to Organization Settings > CloudLinks in the organization where you want to add the CloudLink
- Start creating a new Snowflake CloudLink
- Select Key-pair authentication as the authentication method
- Copy the public key displayed
-
Configure Key-Pair Rotation in Snowflake:
- Contact your Snowflake administrator to set the
RSA_PUBLIC_KEY_2property for the Snowflake user - Provide the public key copied from the organization where you’re adding the CloudLink
- The Snowflake admin should run:
- Contact your Snowflake administrator to set the
-
Complete CloudLink Setup:
- After the second public key is configured in Snowflake, complete the CloudLink setup in the organization
- Both organizations will now be able to authenticate with the same Snowflake user
- The existing CloudLink in the other organization continues to work without interruption
Best Practices
Environment Strategy
Use Descriptive Names
Document Configurations
Test Before Production
One App at a Time
CloudLink Management
- Use dedicated Snowflake service accounts for each environment when possible
- Verify IP whitelisting includes Elementum’s IP addresses
- Monitor CloudLink connection health regularly
- Document database and schema mappings for each environment
Deployment Workflow
- Develop - Make changes in a Development environment
- Test - Deploy to Testing/QA environment for validation
- Stage - Deploy to Staging for final verification (optional)
- Release - Deploy to Production when ready