Editing the Workflow Description and Appearance

The description and appearance of a workflow in the Workflow Launcher pad are defined in the *.slmd file that is automatically created for each new workflow. Editing this file is optional. The file is written in XMLand common markdown language and allows you to define the name, category, and the workflow description text. If you use a template to create a workflow, the *.slmd file will be prefilled with some dummy text that you can just alter.

Define Workflow Name and Category

Particularly for a higher number of different workflows, it can be crucial to have a clear naming and categorization. The name and category can be defined in the XML header of the *.slmd file, as shown here:

 <?xml version="1.0" encoding="utf-8"?>
   <Property key="Name">2.1 Query for Part (StueLi) in Data Graph</Property>
   <Property key="Category">2 Analyses</Property>        
   <Property key="IsHidden">False</Property>  <!-- True or False -->
   <Property key="Description">
          Workflow description (see below)

The properties are called Name, Category and IsHidden. Name defines the display name shown in the Workflow Launcher pad, Category can be used to define sections in the Workflow Launcher pad (e.g. the category “1 Optional Data Graph Preparations” in the image below). The IsHidden property can be used to hide a WF from the Workflow Launcher pad.

Example of a wrokflow with an argument field used to run a query on a data graph.

Define the Workflow Description

To explain what a workflow does, what input arguments are required and so on, it is crucial to have a clear description of each workflow. These descriptions are written in common markdown language. Here is a short code example of the description part of the workflow:

# Query for Part
## A second headline
### A third headline

This workflow will ...
Learn more about it online [here](https://support.soley.io/).

You can learn more about the used markdown language here. Make sure to enclose your description in the HTML section of the *.slmd file. The description can contain links, images as links or encoded in base64, different text styles and so on.

By saving the *.slmd file and selecting the workflow in the Workflow Launcher pad you can directly see how your workflow name, category, and description looks.

Was this article helpful?

Related Articles