Set Up Your Agency
Learn how to create your first agency, configure environments, and set up credentials for your Accela instances
Agencies in RadishKit represent your Accela agencies and serve as collaborative workspaces for your team. This guide will walk you through creating your first agency and configuring environments.
Creating Your First Agency
Step 1: Navigate to Agencies
- From your dashboard, click Create Agency or navigate to the agencies section
- You'll see the agency creation form
Step 2: Fill in Agency Details
Provide the following information:
- Agency Name: The name of your Accela agency (e.g., "City of Springfield")
- Agency ID: Your Accela agency ID (e.g., "SPRINGFIELD")
- Slug: A URL-friendly identifier (auto-generated from the name)
- Description: Optional description of the agency
Step 3: Create the Agency
- Review your information
- Click Create Agency
- Your agency workspace will be created
- You'll be redirected to the agency dashboard
Setting Up Environments
Environments represent the different Accela instances you work with (e.g., TEST, PROD, SUPP, CIVCON).
Create Your First Environment
- Navigate to your agency workspace
- Go to Environments from the sidebar
- Click Create Environment
- Fill in the environment details:
Required Information:
- Name: A descriptive name (e.g., "Production", "Testing")
- Environment Type: Select from TEST, PROD, SUPP, CIVCON, or CUSTOM
- Accela URL: Your Accela environment URL (e.g.,
https://apis.accela.com
) - Agency ID: Your Accela agency ID (if different from the main agency)
Optional Information:
- Description: Additional details about this environment
- Notes: Internal notes for your team
Configure Environment Credentials
After creating an environment, you'll need to add your Accela credentials:
- Go to the environment details page
- Click Add Credentials
- Enter your Accela credentials:
- Username: Your Accela username
- Password: Your Accela password (encrypted and stored securely)
- Click Save Credentials
Security Note: Your Accela credentials are encrypted before storage and are only used to authenticate API requests to your Accela environments.
Install the CLI Wrapper Script
Before you can execute scripts through RadishKit, you must install the RADISH_ACCELA_CLI.js
wrapper script in your Accela environment:
Step 1: Download the Script
- Download the script from the RadishKit CLI package or your environment settings page
- The script is also available in the CLI package installation
Step 2: Install in Accela Admin
- In your Accela Admin interface:
- Navigate to Settings → Scripts → EMSE Scripts
- Click Add New Script
- Set Script Name to exactly:
RADISH_ACCELA_CLI
- Copy and paste the wrapper script contents
- Save the script
Step 3: Repeat for Each Environment
Install the wrapper script in each Accela environment you plan to use:
- TEST environment
- PROD environment
- Any other environments (SUPP, CIVCON, etc.)
Important: The script name must be exactly RADISH_ACCELA_CLI
(case-sensitive) for the CLI to work correctly.
Environment Management
Viewing Environments
From your agency dashboard:
- Click Environments in the sidebar
- View all configured environments
- See connection status and last activity
Editing Environments
To modify an environment:
- Click on the environment name
- Click Edit Environment
- Update the information as needed
- Save your changes
Next Steps
Now that your agency and environment are set up:
- Install the CLI - Set up local development tools
- Install VS Code Extension - Enhance your development experience
- Execute Your First Script - Test your setup
Ready to install the CLI? Continue to Install the CLI!