Salesforce Environment Variables

A simple library which uses Custom Metadata to manage simple Key/Value Environment variables. Includes a custom UI to make configuration as easy & error free as possible.

📦 Install

via sfdx-cli sfdx force:package:install --package 04t1C000000lIDuQAM -u [email protected]

via url login and navigate to /packaging/installPackage.apexp?p0=04t1C000000lIDuQAM. Choose Install for: Admin Only.

Upgrading

This project has been updated to a namespaced unlocked package. If you installed before the namespace was added, and want to stay up-to-sync with the latest improvements, then please follow the manual migration process!

🔨 Usage

Open Environment Variables from the app switcher (or "tabs" in classic)
Add and Save some env-vars
Use in Apex, Formulas or javascript applications.

Apex

//basic usage
Map<String,String> fieldMap = (Map<String,String>) VARS.ENV.get('MY_MAP');

//with a string transform
Map<String,String> fieldMap = (String[]) VARS.ENV.get('MY_ARRAY', VARS.ENV.Transform.TO_LOWER);

// with ANY json
Foo fieldMap = (Foo) VARS.ENV.get('MY_FOO', Foo.class);

Formula

$CustomMetadata.VARS__ENV__mdt.FIELD_MAP.Val__c

Note: Only the first 255 characters will be returned in formula!

✨Features

Currently supports the following types:

String
Integer
Decimal
Boolean: Format: true or false
String[]: Format: ["a","b","c"]
Map<String,String>: Format: {"456":"xyz","123":"abc"}
ANY: Any valid JSON string

Copy apex/formula code to clipboard

"Type-checking" to prevent user input errors

Simple type checking on primitive types.
ability to apply JSON Schema to ANY json type!

"Secret" Values Support (Optional)

In order to enable, follow these instructions.

Quick Find

Quickly filter VARS based on either key or value string search.

Auto-formatting of JSON types

Automatically formats JSON after editing

Ability to group like "VARS" together

Ability to add Notes

Add information about how it's used, how to manage it, etc

🤝 Contributing/Modifying

Project Overview:

env-vars: Salesforce metadata for core env-vars functionality
app: React UI for managing env-vars. Uses B.A.S.S. Stack
env-vars-encrypt: managed package to allow for "secret" vars
sf-env-vars-npm: npm package to make using env-vars easy in js applications

leshchukandrej / salesforce-environment-vars Goto Github PK

salesforce-environment-vars's Introduction