https://github.com/controlm/ctm-vscode-extension
Control-M extension for Visual Studio Code
https://github.com/controlm/ctm-vscode-extension
automation automation-api control-m controlm jobs-as-code orchestration
Last synced: 4 months ago
JSON representation
Control-M extension for Visual Studio Code
- Host: GitHub
- URL: https://github.com/controlm/ctm-vscode-extension
- Owner: controlm
- License: apache-2.0
- Created: 2022-10-24T14:31:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-30T14:57:38.000Z (8 months ago)
- Last Synced: 2026-02-13T08:15:50.264Z (4 months ago)
- Topics: automation, automation-api, control-m, controlm, jobs-as-code, orchestration
- Homepage:
- Size: 1.44 MB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Jobs-As-Code Werkzeugkiste for Control-M Next Generation
**Orchestrate the Impossible™**
Integrate BMC Control-M workflows with Visual Studio Code. Write, manage, and deploy Control-M jobs using modern development practices.
   
## Overview
The Control-M Extension brings enterprise workflow automation capabilities directly into VS Code. Build, test, and deploy Control-M jobs using Jobs-as-Code with full IDE support.
**Key Features:**
- 🌳 **Visual Infrastructure Browser** - Browse Control-M/Servers, Agents, and Host Groups
- 📋 **Job Management** - Create and manage Control-M jobs from VS Code
- 🔌 **Connection Profiles** - Manage multiple Control-M environments
- 📝 **Code Snippets** - Pre-built templates for jobs and configurations
- 🔄 **Jobs-as-Code** - Define workflows in JSON or Python
- 📊 **Telemetry** - Usage and feature tracking (experimental)
## Quick Start
### 1. Installation
Install from VS Code Marketplace: [Jobs-As-Code Werkzeugkiste for Control-M Next Generation](https://marketplace.visualstudio.com/items?itemName=bmcsoftware.jobs-as-code)
```
ext install jobs-as-code
```
Or install manually:
```bash
code --install-extension jobs-as-code-x.y.z.vsix
```
### 2. Configure Connection
1. Open VS Code Settings (`Cmd+,` or `Ctrl+,`)
2. Search for "Control-M"
3. Configure:
- **Control-M URL**: Your Automation API endpoint (e.g., `https://ctm.example.local:8443/automation-api`)
- **API Token**: Your Control-M API token (stored securely)
Or use `.ctm_connection.json` in your workspace:
```json
{
"endpoint": "https://ctm.example.local:8443/automation-api",
"token": "your-api-token"
}
```
**Getting an API Token:**
```bash
# Login to get token
https://ctm.example.local:8443/Welcome
```
### 3. Start Using
1. Open Command Palette (`Cmd+Shift+P` or `Ctrl+Shift+P`)
2. Type "Control-M" to see available commands
3. Try "Control-M: Show Infrastructure" to browse your environment
## Features in Detail
### Infrastructure Browser
View your Control-M environment structure:
- **Control-M/Servers** - All registered servers
- **Agents** - Agents by server with status indicators
- **Host Groups** - Logical agent groupings
**Usage:**
1. Click Control-M icon in Activity Bar
2. Expand servers to see agents
3. Right-click items for context actions
### Job Management
Create and manage jobs using modern development practices:
- **JSON Jobs** - Define jobs in JSON format
- **Python Jobs** - Use Python API for complex workflows
- **Snippets** - Quick templates for common job types
**Supported Job Types:**
- Command jobs
- Script jobs
- Application Integrator jobs
- AWS ECS jobs
- And more...
### Code Snippets
Type `ctm-` in JSON or Python files to see available snippets:
- `ctm-job-simple` - Basic job template
- `ctm-job-aws-ecs` - AWS ECS job
- `ctm-connection-profile` - Connection profile
- `ctm-python-job` - Python API job
### Settings
Configure the extension behavior:
| Setting | Description | Default |
|---------|-------------|---------|
| `controlm.endpoint` | Automation API URL | (none) |
| `controlm.token` | API authentication token | (none) |
## Documentation
Comprehensive documentation is available to help you get the most out of the Control-M Extension:
### 📚 [Getting Started Guide](docs/GETTING_STARTED.md)
Complete guide for new users:
- Installation and setup instructions
- Initial configuration walkthrough
- Your first tasks with the extension
- Troubleshooting common issues
### 📖 [Features Guide](docs/FEATURES_GUIDE.md)
Detailed reference for all extension capabilities:
- Infrastructure Management (Datacenters, Agents, Host Groups, etc.)
- Workload Management (Folders, Jobs, Export functionality)
- Data Services (MFT/MFTE configuration and management)
- Job Development (Build, Run, Deploy services)
- Code Snippets and templates
- Configuration options and advanced features
### 🔧 [REST API Reference](docs/REST_API_REFERENCE.md)
Technical documentation for developers:
- Complete list of Control-M Automation API endpoints used
- Request/response formats and examples
- Authentication and security details
- Performance considerations and best practices
### 📝 [Snippets Guide](docs/SNIPPETS_GUIDE.md)
Complete reference for all 200+ code snippets:
- Job type snippets for all Control-M job types
- Connection profile snippets for all platforms
- MFTE configuration snippets
- Python API snippets
- Usage examples and best practices
## 📖 Control-M Folders
### Privacy Guard
To gather the agent's GPG keys or to import a GPG key these Control-M folder will be executed against the target agent:
- [VSCODE_PRIVACY_GUARD_IMPORT](folders/VSCODE_PRIVACY_GUARD_IMPORT.json)
- [VSCODE_PRIVACY_GUARD_LIST](folders/VSCODE_PRIVACY_GUARD_LIST.json)
## Troubleshooting
If you encounter issues while using the Control-M Jobs-As-Code Toolkit, try the following tips:
### Connection Issues:
Double-check your Control-M Automation API endpoint and API token in the extension settings.
Ensure your network allows access to the Control-M server.
If using a .ctm_connection.json file, verify its format and location.
### Authentication Problems:
Make sure your API token is valid and not expired.
Refer to the Getting Started Guide for instructions on obtaining a new token.
### Missing Features or Commands:
Confirm you have the latest version of the extension installed.
Review the Features Guide to see which functionality is supported.
### General Errors:
Check the output and error logs in VS Code (View > Output).
Restart VS Code after installation or configuration changes.
If problems persist, consult the documentation or reach out via the BMC community forums or GitHub issues.
## Disclaimer
This extension is provided by BMC Software as a community-driven, open-source solution for educational and demonstration purposes only. The content and functionality are offered “as is” without warranty of any kind, either express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, or non-infringement. Use of this extension in any production or production-like environment is strictly out of scope and not supported.
## User Responsibilities
By downloading or using this extension, you acknowledge and agree that:
- You are solely responsible for evaluating its suitability for your intended use.
- You must not use this extension in any production or production-like environment.
- You are responsible for ensuring compliance with all applicable laws, regulations, and organizational policies when using this extension.
- Any reliance on the extension or its outputs is at your own risk.
## Limitation of Liability
To the fullest extent permitted by law, BMC Software and its contributors disclaim any and all liability for any direct, indirect, incidental, special, consequential, or punitive damages arising out of or in connection with the use of, or reliance on, this extension or any related information.
## Need help or want to contribute?
Visit the https://community.bmc.com/ or open an issue on https://github.com/controlm/ctm-vscode-extension/issues.