SFCC Jobs Executor
Run SFCC jobs from VSCode.
Features
- Read the job id from the comments on the active file
- Show the job execution logs in the output window
Installation
You can install it from the marketplace.
ext install ionutvmi.sfcc-jobs-executor
Configuration
Business Manager
Administration > Site Development > Open Commerce API Settings
Data - Global
{
"allowed_origins": [],
"client_id": "",
"resources": [
{
"resource_id": "/jobs/{job_id}/executions",
"read_attributes": "(**)",
"write_attributes": "(**)",
"methods": ["post"]
},
{
"resource_id": "/jobs/{job_id}/executions/{id}",
"read_attributes": "(**)",
"write_attributes": "(**)",
"methods": ["get"]
}
]
}
Administration > Organization > WebDAV Client Permissions
{
"client_id": "",
"permissions": [
{
"path": "/Logs",
"operations": ["read"]
}
]
}
In the VSCode workspace
// dw.json file
{
"hostname": "",
"client-id": "",
"client-secret": ""
}
// In any file you can specify the job id and timeout
// The job id should be last in the configuration list.
// @sfccJobTailLogTimeout 60000
// @sfccJobClearLog
// @sfccJobId 000-test-job
// or jsdoc style
/**
* @sfccJobTailLogTimeout 60000
* @sfccJobClearLog
* @sfccJobId 000-test-job
*/
Keyboard shortcuts
To configure a custom keyboard shortcut:
// keybindings.json
{
"key": "ctrl+shift+f6",
"command": "sfcc-jobs-executor.runJob"
}
Release Notes
The release notes are available in the CHANGELOG.md document.
Author
Mihai Ionut Vilcu
Enjoy!
