Workflow and ServiceDesk Community

 View Only

Workflow - Component - Developer Guide - Help File 

Nov 09, 2016 05:09 PM

In this Article I'm going to explain how to create an accompanying Help file with added information to display to the User when they open and configure the component.

Table of Contents

 

 

These are located:

[Install Drive]:\Program Files\Symantec\Workflow\Designer\Help\

When creating a Component using the Int.png Integration Project type when you Compile and close the Help Editor loads and allows you to make changes.

If you have created a custom component this file won't exist.

The File name is usally the DLL name with the ".libconfig" file extension.

To create a new Help file for a custom dll open the Help Editor

[Install Drive]:\Program Files\Symantec\Workflow\Designer\bin\WorkflowHelpEditor.exe

Select File | New

Help Editor - File New.png

Select Browse

Help Editor - New File.png

Find the dll in the customlib folder

Help Editor - New File - From Assembly.png

Now we have the Component to work with.

If we compare what data we have to what Attributes we provided in code:

[Serializable,
ComponentCategory("Protirus"),
ComponentImage("Protirus.Workflow.Protirus.png"),
ComponentName("Protirus Concat"),
ComponentDescription("This component joins two Strings."),
ComponentHelp("http://www.protirus.com/components/"),
ComponentUsage("Requires two strings."),
ComponentExample("String a = 'Hello' String b = 'World', this will return 'Hello World', if Add Space is True."),
ComponentPublisher("Protirus", "www.protirus.com")]
[PropertyPageOrder("General", "Configuration", "Settings")]

Help Editor - Protirus.Components.Concat (Anno).png

If you click on Property (2).png Properties we can then add extra information and group them by tabs.

Data annotations in code are now deprecated so the help file is the only way to add it and show in the Help file within Workflow.

Help Editor - Protirus.Components.Concat - Properties.png

As we see the Component Properties don't have any information and aren't grouped by tabs.

To add the Published add the Company name in the Assembly Info of the component in Visual Studio.

Protirus.Concat Help (Anno).png

I annotate my variables in code, these can then be copied to help

[VariableType(typeof(string), false), 
  PropertyIndex(3), 
  DisplayName("String 1"), 
  Category("Configuration"), 
  ComponentDescription("The first String to be merged")]      

You can create new Categories or groupings within a tab,

Help Editor - Protirus.Components.Concat - Properties - New Category.png

Give it a name

Help Editor - Protirus.Components.Concat - Properties - New Category - Name.png

Drag the Properties into the Category, then add your information.

Help Editor - Protirus.Components.Concat - Properties - Category - Configuration.png

Save this file.

Reload your Workflow.

Protirus.Concat General (Updated).png

You may notice the Icon has changed back to the default.

cubes.png

Back to the Help file.

Click on the Component, then click Icon.png Icon

Click Add then search for your image, choose and click OK.

Help Editor - Protirus.Components.Concat - Icon.png

Now you might want Tabs aswell as grouping items in the General tab.

Help Editor - Protirus.Components.Concat - Properties - New Page.png

Drag the Category into the new tab

Help Editor - Protirus.Components.Concat - Properties - Page.png

Now save and reload the WF.

Protirus.Concat Configuration (Filled In).png

If we click the Help ?

Protirus.Concat Help (Updated).png

If we'd filled in the Help and Example etc they would show here too.

 

Protirus.png

Statistics
0 Favorited
1 Views
0 Files
0 Shares
0 Downloads

Tags and Keywords

Related Entries and Links

No Related Resource entered.