Sidebar

The Sidebar is a tool developed by the acadon AG to assist in the daily processes of developers. It can run several PowerShell scripts that you can develop by yourself and/or run standard-tasks to facilitate your daily doing.

Installation

To install the sidebar and set up everything necessary click here and follow the instructions.

Shortcuts

In the following you see all shortcuts that you can use:

Shortcut	Description
Ctrl + ^	Opens the sidebar
Ctrl + 1	Use action 1
Ctrl + 2	Use action 2
Ctrl + 3	Use action 3
Ctrl + 4	Use action 4
Ctrl + 5	Use action 5
Ctrl + 6	Use action 6
Ctrl + 7	Use action 7
Ctrl + 8	Use action 8
Ctrl + 9	Use action 9
Ctrl + Q	Opens the log-window
Ctrl + S	Opens the branch drop-down list
F5	Reload all logos, scripts, ...

Layer handling

The sidebar actions can enter another layer. This means that you can create something like a folder. You enter this layer and it will show you the next layer with other actions. You always can go back with Ctrl + 1 because the first action will always lead you back to the parent layer. The structure of the layer is defined in the config.json-file for the project itself or in the type-definition.json. In the following, you see an example for one action that two further actions behind it in the layer two:

{
  "Commands": [
        {
            "Title": "Dev. Client",
            "Icon": "%scripts%\\Icons\\finsql.png",
            "Command": "%scripts%\\Scripts\\Commander\\run_devclient.ps1 \"%repopath%\"",
            "BackgroundColor": "#002050"
        },
        {
            "Title": "DevOps",
            "Icon": "%scripts%\\Icons\\devops.png",
            "Command": "%scripts%\\Scripts\\Other\\open_devops.ps1 \"%repopath%\"",
            "BackgroundColor": "#4F6367"
        },
        {
            "Title": "Todo",
            "Icon": "%scripts%\\Icons\\todo.png",
            "BackgroundColor": "#7EA8BE",
            "Commands": [
                {
                    "Title": "Start Feature",
                    "Icon": "%scripts%\\Icons\\ToDo\\Feature.png",
                    "Command": "%scripts%\\Scripts\\Versioning\\Solution\\start_change.ps1 \"%repopath%\" feature",
                    "BackgroundColor": "#78BC61"
                },
                {
                    "Title": "End Feature",
                    "Icon": "%scripts%\\Icons\\ToDo\\Feature.png",
                    "Command": "%scripts%\\Scripts\\Versioning\\Solution\\end_change.ps1 \"%repopath%\" feature",
                    "BackgroundColor": "#EF6F6C"
                }
            ]
        }
    ]
}

Stream Deck

You also can use the Stream Deck to execute actions in the sidebar. To do this you just need to plug in the Stream Deck and install the sidebar.

Create your scripts

It is possible to develop your specific scripts without publishing them in the remote repository on DevOps. To do this, put everything in the project-folder as the following examples will show you.

• Create your folder in the sidebar-report-folder and create the normal .adc-folder inside.
• Create a logo.png and put it in the .adc-folder of the project. This logo will be loaded if you refresh your sidebar with F5 or restart it.
• Change the RepoType to CustomType and add Commands with all your commands and layers. This will define your structure of the RepoType. With the placeholder %scripts% you can refer to your script-folder. With the placeholder %repopath% you can refer to the project folder:

{
    "Name": "Parent-action",
    "RepoType": "CustomType",
    "Version": "1.0.0",
    "Commands": [
        {
          "Title": "Child-action",
          "Icon": "%scripts%\\Icons\\Commander\\HUD.png",
          "BackgroundColor": "#000000",
          "Command": "acadoncommander://cmd/toggle_hud",
          "Type": "Link"
        },
        {
          "Title": "Child-action",
          "Icon": "%repopath%\\Icons\\beyondFile.png",
          "BackgroundColor": "#696969",
          "Command": "%repopath%\\Scripts\\compareFile.ps1"          
        }
    ]
}

Git

The sidebar is pushed on DevOps here.