Tools for working with Medable Cortex scripts and versioning orgs in source control
Medable Dev Tools Atom Package
This atom package makes it easy to download all of your Medable Cortex org configuration for versioning. Additionally, you can edit your scripts and save your scripts back to your org, making it much easier to develop your Cortex scripts.
Installing
Download and install Atom from https://atom.io
Open Atom, open up Atom > Preferences
and select Install
In the search field, type medable
and hit enter
. This will bring up the medable-dev-tools
package. Click Install
to install the package.
From Atom > Preferences
select Core
settings. Then, add .medable
to the list of ignored file names.
Then, select Packages
and search for Tree-View
and click on the Settings
button.
From the Tree-View package settings, check the check box to Hide Ignored Names
Now restart Atom
Using Medable Dev Tools
To get started, create a new folder for your project and open it in Atom.
You'll have a new empty project that looks similar to this.
To enable Medable Dev Tools in your project, from the Packages menu choose Medable > Enable
Specify the Medable settings for your project:
- Environment
api.dev.medable.com
for your dev environment (recommended)api.medable.com
for you prod environment- Org Name
- The unique name for your org. This is the org name you specified when signing up.
- API Key
- A session-based API key for your org. You can get this key from the
Settings > Apps
menu in your org control panel. You can also click on theGet API Key
link which will take you to your control panel to log in. - If you don't yet have an API key, seeGenerating an API Key in the Medable docs.
Now, you'll see a Medable
menu in the menu bar. From the Medable
, select Pull All
.
You'll then be prompted to log into your org.
After logging in, you'll see the Pull take place. You'll see a new folder structure appear in your project for all of your org elements.
These folders contain all of the definitions for your org configuration. From here, you can now commit this project to source control to begin versioning your org config.
Also you can use Atom as your IDE for your custom scripts. In your scripts
folder, you'll find sub-folders for all the different types of scripts you've created in your org. You'll also notice that for each scripts, you have a .js
file and a .json
file. The .js
file is your script itself, while the .json
file holds all of the definition detail about your script. You can modify these files and save them locally. Then, when ready, you can select Push Scripts
from the Medable
menu to save your scripts back to your org.
Happy coding!