Skip to main content
Matrix42 Self-Service Help Center

WorkflowStudioActivityCloud

Installer Guide

You can find a small guide how to install Matrix42 Marketplace Addons here:

CustomizingInstaller2020

Feature

To provide a convenient way to include additional functionality in customer workflows, a collection of Activities is offered to extend the library that is available in the Workflow Studio.
The features included in the Workflow Activities are described in the following sections.
The implementation of these Activities may be subject to change as feedback from customers who operate clients becomes available. This document will be adapted accordingly.

What are the benefits of this feature?

When you use this feature, you gain a more automizableness environment and all your business logic can set up in workflows with some more functionality for your dataobjects and Active Directoy, or your office Products.

When to use this feature?

Use this feature to extend the functionality of your Matrix42 Workflow Studio for a better link between your data and your workprocesses.

Available Workflow Activites

Utility Package

·   Add Journal

·   Assign HTML

·   Assign String

·   Assign Text

·   Exception Info

·   Generate Password

·   Object Link

·   Password Hasher

·   Read User Profile

·   Run Compliance Rule

·   Send Email With Attachment

·   Validate Email

·   Workflow Log Writer

SchemaTransfer

·   Add Configuration-Item by ID

·   Add Configuration-Item by Name

·   Add Data-Definition by ID

·   Add Data-Definition by Name

·   Add Object

·   Apply Import-Collection

·   Create Export-Collection

·   Create Import-Collection

·   Save Zip File

Service Desk

·   Calculate Calendar Target

·   Calculate SLA Escalation

·   SLA Time Query

Active Directory

·   Add Active Directory Object To Group

·   Create Active Directory Group

·   Create Active Directory User

·   Delete Active Directory Object

·   Get Active Directory Group

·   Get Active Directory User

·   Move Active Directory Object

·   Remove Active Directory Object From Group

·   Update Active Directory User

Office Products

·   Excel bookmark activity

Soon to come

·   Cascading Deletion

·   DB-Logging

·   More office product activities

Category "Utility Package"

The Utility Package activities contain a bunch of activities to extend or modify incoming and outgoing text as well as some additional functionality for a better automization and usability of workflows.  

 

clipboard_ede6dfbf808be969c04bae0410ec3c4dd.png

Add Journal

   
Input Arguments Type-ID GUID optional
  Object-ID GUID  
  User Fragment-ID GUID  
  Journal Type Pickup  
  Solution HTML Resource  
Output Arguments Journal Fragment-ID GUID  
  Journal HTML String  
       

By using this activity a workflow can add journals to specific objects like incidents or tasks.

 

clipboard_e641756f0ba6ce4056c0b7d603d5766ee.png

Assign HTML

   
Input Argument Input HTML Resource Variable or formatted text from Editor
  Output HTML String  

With this activity you are able to assign HTML text to a string variable

 

clipboard_e0a8c5baf4de926207afbc04c65dbbfcd.png

Assign String

   

Input Argument

Input String

Resource

Variable or formatted text from Editor

Output Argument Output String String  

Equal to the Assign HTML activity this activity assigns any string variable resource to the output variable

 

  clipboard_ea39f0b5352c24e9d5608925d5ac1e74a.png

Assign Text

   
Input Argument Input Text Resource Variable or formatted Text from Editor
Output Argument Output Text String  

In addition to the Assign HTML and Assign String acitivity there is a special activity for the text type.

clipboard_ea36362225709d194f5ebc02f3c390c63.png

Exception Info

   
Input Argument Exception Exception  
Output Arguments All Text String Full Text of the passed exception
  Message String

Message of the passed exception

  Stack Trace String Strack-Trace of the passed exception
  Result OK Boolean Result of the activity operation
  Result Message  String Activity operation message
  Result Exception Exception Activity operation exception

The Exception Info activity gets an exception object which returns the exceptions information as output arguments.

clipboard_e55d3a9df7249d08d333ac391033372e6.png

Generate Password

   
Input Arguments

Length

Integer

The number of characters in the generated password. The length must be between 1 and 128 characters

 

Number Of Non Alphanumeric Characters

Integer

The minimum number of non-alphanumeric characters (such as @, #, !, %, &, and so on) in the generated password

Output Arguments

Random Password

String

A random password of the specified length

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity generates a password due to the given criteria and returns it as string. Can be used to generate random passwords for new users.

clipboard_ee661b37698f00e742585f2f5beb4b459.png

Object Link

   
Input Arguments Object-ID GUID Object identifier
  Object Type-ID GUID Object type identifier
  Display Text String URL display text
  HTML Link Target String Link target for <a> tag
Output Arguments URL String raw URL
  HTML Link String <a> tag
  Result OK Boolean Result of the activity operation
  Result Message  String Activity operation message
  Result Exception Exception Activity operation exception

This activity returns a link for a specified object.

clipboard_e1e4a1d9717e0bbd648dc706c6da8a637.png

Password Hasher

   
Input Arguments Password String

Password to hash

Output Arguments Password Salt String Password Salt value
  Password Hash String Password Hashed value
  Result OK Boolean Result of the activity operation
  Result Message  String Activity operation message
  Result Exception Exception Activity operation exception

The activity Password Hasher turns text into password hashes. So no one can read a password in the database anymore. 

clipboard_ed0af75985f42f1fdb3a6054fe8b16a14.png

Read User Profile

   
Input Arguments User Fragment-ID GUID

 

Output Arguments

Grid Page Size

Integer

 
 

Console-Language ID

GUID

 
 

Console-Language LCID

Integer

 
 

Mail-Language ID

GUID

 
 

Mail-Language LCID

Integer

 
 

Portal-Language ID

GUID

 
 

Portal-Language LCID

Integer

 
 

User Currency

String

 
 

Working-day Start

String

 
 

Working-day End

String

 

This activity returns some specific data for a specified User Fragment-ID

clipboard_e7501ef38c4919302b07d3cabf16129e3.png

Run Compliance Rule

   
Input Arguments

ObjectID

GUID

The ObjectID of the Compliance Rule that is to be triggered. (Mandatory)

 

Context ObjectID

GUID

The ObjectID of the context object that is evaluated by the Compliance Rule. (Optional. When provided, Context-ObjectTypeID must also be set!)

 

Context TypeID

GUID

The TypeID of the context object that is evaluated by the Compliance Rule. (Optional. When provided, Context-ObjectID must also be set!)

Output Arguments

Result OK

Boolean

Result of the Activity

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity is able to trigger a specific compliance rule registered in the database by taking the objects ID or the context object ID 

clipboard_e508d0e8fb2ac4f6beedee4db21b4a756.png

Send Email With Attachment

   
Input Arguments

Sender Address

String

 

 

Recipient Addresses (TO)

List<String>

 

 

Recipient Addresses (CC)

List<String>

 

 

Recipient Addresses (BCC)

List<String>

 

 

Subject

String

 

 

Body

String

 

 

Priority

Enum

Mail Priority Values:

- Normal

- Low

- High

 

Attachments

List<String>

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

A must have activity. This enables to give emails also attachments which can be used to send .ics invitations for example.

clipboard_ecbdaeab9f76601beac7b67ddd23e4289.png

Validate Email

   
Input Arguments

E-Mail Address

String

E-Mail address to check

 

Black-list

StringCollection

List of invalid hosts and addresses

Input/Output

User Display-Name

String

Display-name for the E-Mail address

Output Arguments

Blacklisted

Boolean

Is it Blacklisted

 

Resolved Address

String

Parsed e-mail address

 

Mail Host

String

Host part of the e-mail adress

 

Mail User

String

User part of the e-mail adress

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Example

Viktor Vogel<viktor.vogel@imagoverum.com>

 

à User Display-Name = “Viktor Vogel”

à Resolved Address = “viktor.vogel@imagoverum.com

à Mail Host = “imagoverum.com”

à Mail User = “viktor.vogel”

   

The acitvity Validate Email, validates an E-Mail Address and returns all it's parts as return values.

clipboard_e0942afdd8c07d1c254f973ae0cc10c06.png

Workflow Log Writer

   
Input Arguments

Root Object-ID

GUID

Workflow Root Object identifier

 

Log Level

Enum

Log Level Values:

- DEBUG

- INFO

- WARN

- ERROR

 

Message

String

Message to log

 

Exception

Exception

Exception to log

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

With this activity every string or exception or what ever someone would like to save in a log file can write data and information to the workflow log.

Category "SchemaTransfer"

The Schematransfer activities deliver all functionality needed to implement new configuration items, datadefinitions and an easy way to ex- and import them via workflows. The export-collection can be saved as a .zip file.

clipboard_e41cae17ea416f286021c5b51c9d0b703.png

Add Configuration-Item by ID

   
Input Arguments

Export-Collection

ExportCollection

 

 

Configuration-Item ID

GUID

 

 

Include Dialog-Pages

Boolean

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity adds a configuration-item by it's ID to the exportcollection.

clipboard_e41cae17ea416f286021c5b51c9d0b703.png

Add Configuration-Item by Name

   
Input Arguments

Export-Collection

ExportCollection

 

 

Configuration-Item ID

GUID

 

 

Include Dialog-Pages

Boolean

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity adds a configuration-item by it's name to the exportcollection.

clipboard_e887a16a45d5785f6fdadf8c10ebbc0c2.png

Add Data-Definition by ID

   
Input Arguments

Export-Collection

ExportCollection

 

 

Data-Definition ID

GUID

 

 

 

 

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity adds a datadefinition by it's ID to the exportcollection.

clipboard_e887a16a45d5785f6fdadf8c10ebbc0c2.png

Add Data-Definition by Name

   
Input Arguments

Export-Collection

ExportCollection

 

 

Data-Definition Name

String

 

 

 

 

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity adds a datadefinition by it's name to the exportcollection.

clipboard_e6dedc27277e97bb00126123451a93fea.png

Add Object

   
Input Arguments

Export-Collection

ExportCollection

 

 

Type-ID

GUID

 

 

Object-ID

GUID

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Any kind of object can be added to the export collection with this activity.

clipboard_ed3ecac4a384bc2f046c2e08b6059deb6.png

Apply Import-Collection

   
Input Arguments

Import-Collection

ImportCollection

 

 

Skip Model Import

Boolean

 

 

Skip Data Import

Boolean

 

 

Skip Update Info

Boolean

 

 

SQL-Dump Path

String

 

Output Arguments

Major Version

Integer

 

 

Minor Version

Integer

 

 

Build Version

Integer

 

 

Project Title

String

 

 

Project Prefix

String

 

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Apply Import-Collection is the key activity to import dataobjects exported by an export-collection.

clipboard_ee25ba397c30d36f9ba94e9c1ab0ad13e.png

Create Export-Collection

   
Input Arguments

Connect-String

String

 

 

Temporary Disk-Path

String

 

 

 

 

 

Output Arguments

Export-Collection

ExportCollection

 

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Create Export-Collection creates the export-collection object which can then be filled with all the objects for the export.

clipboard_e4755f842b4fb9818be3eec137c1677e9.png

Create Import-Collection

   
Input Arguments

Full File-Path

String

 

 

Load at once

Boolean

 

 

SQL Chunk-size

Integer

Default is 30000

Output Arguments

Import-Collection

ImportCollection

 

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

Create Import-Collection is the import equivalent for all imports of the schema.

clipboard_e3dc7e74ec12d199524c17b6ef366e7db.png

Save Zip File

   
Input Arguments

Export-Collection

ExportCollection

 

 

Full File-Path

String

 

 

Major Version

Integer

 

 

Minor Version

Integer

 

 

Build Version

Integer

 

 

Project Title

String

 

 

Project Prefix

String

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Save Zip File saves an export-collection at the path specified.

Category "Service Desk"

These special abilities improve your calculation of SLA's and Calenders.

clipboard_ef917485f54faae5e92e15eeb17598302.png

Calculate Calendar Target

   
Input Arguments

Object-ID

Guid

SLA Object ID

 

Priority

Integer

 

 

Start Date

DateTime

 

 

Work Runtime

TimeSpan

 

Output Arguments

Calendar Target

DateTime

 

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

This activity automatically calculates a calender target for an SLA object.

 

Calculate SLA Escalation

   
Input Arguments

Object-ID

Guid

SLA Object ID

 

Priority

Integer

 

 

Start Date

DateTime

 

Output Arguments

Reaction Point

DateTime

 

 

Solution Point

DateTime

 

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Calculate SLA Escalation does like the name tells a calculation of the escalation of an SLA object.

clipboard_e675c5d067f5626bd529e038e4e933b4e.png

SLA Time Query

   
Input Arguments

SLA Object-ID

Guid

SLA Object ID

 

Priority

Integer

 

 

Start

DateTime

 

 

End

DateTime

 

Output Arguments

Time

Int

Calculated SLA time in minutes

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

The SLA Time Query provides a calculation of the time passed between the start and the end time of an SLA Object.

Category "Active Directory"

clipboard_e428b5d873966deb4bbcfabbb5cccb7b2.png

Add Active Directory Object To Group

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

Object Name To Add

String

Object name to add to the destination group

 

Group Name

String

Group name where to object will be added

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Add Active Directory Object To Group empowers workflows to asign an active directory object to an AD group.

clipboard_ed969800841925a51e5edba8e3f03dbda.png

Create Active Directory Group

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

Group Name

String

Name of the group to create

Output Arguments

Group Guid

Guid

Created Group GUID

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Create Active Directory Group does like the name says: it creates an AD Group. It can be used for example if you have a datadefinition for departments and they should be created automatically if a new department is set.

clipboard_e675c5d067f5626bd529e038e4e933b4e.png

Create Active Directory User

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

Display Name

String

 

 

Domain

String

 

 

Enabled

Boolean

 

 

Expiration Date

DateTime

 

 

First Name

String

 

 

Last Name

String

 

 

User Mail

String

 

 

User Name

String

 

 

User Password

SecureData

 

Output Arguments

Group Guid

Guid

Created User GUID

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

Create Active Directory User. Self-explaining. This activity creates a new AD User.

clipboard_ecf61a608d739cf9cb06ba4ab0a48a108.png

Delete Active Directory Object

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

Object Name

String

Name of the Object to delete

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity "Delete Active Directory Object" can be used to automatically delete AD objects like users or groups. It only needs the objects name and an username with permissions.

clipboard_ed01ef5e33a8e77b6c45c0163096560d5.png

Get Active Directory Group

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

Group Name

String

Name of the group to search

Output Arguments

Common Name

String

Common Group Name

 

GUID

Guid

Global Unique Identifier

 

Member

List<string>

Members oft he group

 

Member Of

List<string>

Group that contains the group as a member

 

Object Path

String

Directory Path

 

SID

String

Security Identifier

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity returns information about an AD Group

clipboard_e675c5d067f5626bd529e038e4e933b4e.png

Get Active Directory User

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

User Name

String

Name of the user to search

Output Arguments

Last Name

String

 

 

First Name

String

 

 

Display Name

String

 

 

User Mail

String

 

 

User Description

String

 

 

Telephone Number

String

 

 

Street Address

String

 

 

Post Office Box

String

 

 

City

String

 

 

Province

String

 

 

Postal Code

String

 

 

Enabled

Boolean

 

 

Object GUID

Guid

Object Global Unique Identifier

 

Object SID

Guid

Object Security Identifier

 

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity returns information about an AD User

clipboard_ee8d7e4f480e1feff419123ba1c7eb5a9.png

Move Active Directory Object

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

Object Name

String

Name of the object to move

 

Current Path

String

Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com'

 

New Path

String

Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com'

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity moves an AD Object from one path to another.

clipboard_e822edf08ca3549ca692f8c4e882d47cd.png

Remove Active Directory Object From Group

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

Object Name

String

Name of the Object to remove

 

Group Name

String

Name of the Group where the object will be removed

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity removes an AD Object from a group.

clipboard_e7ab119c9d3a2b707bb2097a7ab4d2caf.png

Update Active Directory User

   
Input Arguments

Server

String

Server Name or IP Address

 

Path

String

Directory Path (Ex: 'OU=Test,DC=Lab,DC=Matrix42,DC=com')

 

Server User Name

String

Sets the user to use when authenticating the client

 

Server Password

SecureData

Sets the password to use when authenticating the client. Password value must be encrypted

 

User Name

String

Name of the user to search

 

User Password

SecureData

User Password

 

Last Name

String

 

 

First Name

String

 

 

Display Name

String

 

 

User Mail

String

 

 

User Description

String

 

 

Telephone Number

String

 

 

Street Address

String

 

 

Post Office Box

String

 

 

City

String

 

 

Province

String

 

 

Postal Code

String

 

 

Enabled

Boolean

 

 

Expiration Date

DateTime

 

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

This activity updates an older entry of a User.

Category "Office Products"

The office product activities cover a various range of possibilites to merge every office product with workflows. The workflows can create files and fill in predefined template for your needs. 

clipboard_e675c5d067f5626bd529e038e4e933b4e.png

Excel Bookmark Activity

   
Input Arguments

Template Path

String

Systempath of the excel template

 

Save to

String

Systempath of the directory to save to

 

Save as

String

Name of the file without suffix

 

Bookmarks

Dictionary<String,String>

Key, Value Pair of bookmarks

Output Arguments

Result OK

Boolean

Result of the Activity operation

 

Result Message

String

Activity operation message

 

Result Exception

Exception

Activity operation exception

The Excel Bookmark Activity contains the functionality to receive a list of bookmarks which are named fields in Excel and the paths where the template comes from and where it should be saved to. If it fails it returns the normal exception handling. 

The office product activities can only be used if office is installed on the webserver. 

 

  • Was this article helpful?