Service Manager Visual Studio Code Extension

A VSCode extenstion which allows you to create and modify Service Manager ScriptLibraries outside the Service Manager Client.

Features

Multiple Environments
Create a new ScriptLibrary from a local file
Push and Pull for ScriptLibraries
Compile
Compare
Execute/Run Code

Installation

Just load the extension via the VSCode Marketplace.

Inside the Service Manager, you have to create a new extaccess record.

Please ensure that the used operator has enough permissions to create/update/compile a ScriptLibrary and that the capability RESTful API is set in the operator.

Header fields

Field Name	Value
Service Name	ScriptLibrary
Name	ScriptLibrary
Object Name	ScriptLibrary

Tab Allowed Actions

Allowed Actions	Action Names	Action Type
add	Create	Create only
save	Update	Update only
compile	Compile
executelibrary	executelibrary

It's important to use the action name executelibrary, otherwise, the Execute Command will not work in Visual Studio Code.

Tab Fields

Field	Caption	Type
name	Name
package	Package
script	Script

If you're using different Caption Names, you have to modify also the extension settings. See `fields` inside the example settings.

Tab RESTful

Field	Value
RESTful enabled	true
Resource Collection Name	ScriptLibrary
Resource Name	ScriptLibrary
Unique Keys	name
Resource Collection Action - POST	Create
Resource Actions - POST	Update
Resource Actions - PUT	Compile

If you're using a different Resource Collection Name and/or Resource Name, you have to modify also the extension settings. See resourceCollection and resourceName inside the example settings.

Enable the Execute command

To run a ScriptLibrary from your Visual Studio Code, you have to create a new Process.

State Changes

You have to add a new method/process entry in State ScriptLibrary.view.

Display Action: executelibrary
Process Name: ScriptLibrary.execute
Condition: true

New Process

Create a new Process with the name ScriptLibrary.execute. In the tab Initial Expressions add the following code and save the record.

$L.void=jscall(1 in $L.file)

This is the same code as in the display option for the execute button.

Extension Settings

This extension contributes the following settings:

servicemanager.environments - Object - Defines the available environments

Example

"servicemanager" : {
    "environments" : {
        "env1": {
            "name": "Environment 1",
            "url": "http://localhost:13080/SM/9/rest/",
            "resourceCollection": "ScriptLibrary",
            "resourceName": "ScriptLibrary",
            "username": "System.Admin",
            "password": "System.Admin",
            "path": "/Users/marcusreinhardt/Documents/sm/env1/",
            "defaultPackage" : "User",
            "fields" : {
                "name" : "Name",
                "package" : "Package",
                "script" : "Script"
            }
        },
        "env2": {
            "name": "Environment 2",
            "url": "http://localhost:23080/SM/9/rest/",
            "resourceCollection": "ScriptLibrary",
            "resourceName": "ScriptLibrary",
            "username": "System.Admin",
            "password": "System.Admin",
            "path": "/Users/marcusreinhardt/Documents/sm/env2/",
            "defaultPackage": "User",
            "fields": {
                "name": "Name",
                "package": "Package",
                "script": "Script"
            }
        }
    }
}

Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

Release Notes

2.0.0

Refactored the Extension
Enabled Compare functionality
Enabled Execute functionality

1.0.0

Initial release

Credits

Special thanks goes to:

yim OHG - My old company :heart: They got me the idea to give VSCode a try and here it is - the SM Extension :)

Service Manager VSCode

Marcus Reinhardt