Working copy - M-Files Process Maps Installation Guide

M-Files Add-On
Process Maps
Installation Guide

Page 1 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

This document describes the installation of the M-Files Process Map Add-On to your M-Files Vault. It outlines the
installation process on the server, the client and shows how to configure the system so that you can work with M-Files
Objects on your drawing canvas.

TABLE OF CONTENTS

1. M-Files Process Maps .......................................................................................................................................... 3

Prerequisites to the installation .................................................................................................................... 3

Launching VPN for the first time ................................................................................................................... 4

2. Configuration ...................................................................................................................................................... 4

PMAPS Objects View .................................................................................................................................... 4

Mapping Vault Objects with Process Notation Symbols ................................................................................. 4

2.2.1 Default behavious for M-Files Objects ...................................................................................................... 4

2.2.2 Configuring Object Types to Process Maps Symbols .................................................................................. 5

Configuration: User Interface - Custom Tabs ................................................................................................. 8

3. Moving Maps Between Vaults.............................................................................................................................. 9

Page 2 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

1. M-FILES PROCESS MAPS

PREREQUISITES TO THE INSTALLATION

The Process Map application is delivered as an .MFAPPX File which gets installed with the M-Files Admin console using
admin rights. The Process Maps can be installed to any vault. During installation it enhances the vault structure with a
server piece as a so called vault application, a client UI-extension and some additional objects, classes and views. It also
installs some sample data and configuration information in the named value store.

It is encouraged and best practice to create a full vault backup prior installing the Process Map add-on.

Process Maps can be installed into M-Files 2015.3 with the latest service pack and with M-Files 2018. Installation
requires a Vault Application and a Vault Application License.

Please download the latest version for the installer here: https://mfilescdn.blob.core.windows.net/public/Add-
ons/ProcessMaps/ProcessMaps.mfappx

In M-Files Admin:

Install the Vault Application

1) Select the target vault.

2) Right click -> Applications
3) Install…
a. Select file: ‘ProcessMaps[possible version].mfappx’
b. Answer Yes to the "Do you want to restart the document vault now?" or separately restart the
vault.

Install the Vault Application License

1) Select the target vault.

2) Action –menu or right click on the vault name.
3) Select Process Map application
4) License
a. Install License…
b. Select .lic-file provided for you.
c. If the license is valid, click Apply and OK to install it.

In M-Files Desktop:
After installing the Process Map add-on on the server using the M-Files Admin and restarting the vault, you can install
the UI Extension on the M-Files Desktop.

1) Log out from the selected vault, if already in. The Log Out performed from the M-Files notification area icon is
the most to secure one.
2) Log in to the selected vault. To be able to configure the tool, log in as a user with the full control of vault -
rights.

Page 3 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

3) Allow the following new application to run.

First time launch on a client will take a little longer. Give it some time to start up.

LAUNCHING PROCESS MAPS FOR THE FIRST TIME

Making sure Process Maps has been installed properly.

1) Log in to M-Files Desktop
2) Create a Process Map Object
3) If the editor doesn't open upon saving, open the process map by double clicking
4) Save the process map and exit
5) Make sure that the following files can be found under the process map object
a. Config.xml - describes some standards for the map
b. Pmap.svg – a vector drawing (for importing to other applications – including MS-Office 2016)
c. Pmap.xml – the actual map itself.

2. CONFIGURATION

PMAPS OBJECTS VIEW

The PMAPS OBJECTS View is a predefined view. Its purpose is to contain predefined views that return objects or
documents which shall be made available for the use within your maps. By default the PMAPS OBJECTS view is empty.
Create Views to Objects that you wish to see in listings in Process Maps Editor

MAPPING VAULT OBJECTS WITH PROCESS NOTATION SYMBOLS

2.2.1 Default behavious for M-Files Obje cts

Process Maps has a default notation for any object that is pulled into a map. In addition to this, the Document Object
Type (ID 0) gets assigned automatically a dedicated symbol depending on the type of chart.

Type Result in default behavior – without mapping.

Document Document-Shape of the notation

(FLOWCHART) (BPMN) (EPC)

Page 4 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

∂ Document type icon (Word, Excel, Powerpoint, etc.) is shown.

∂ ‘on Click Symbol’ to launch the metacard of the object (which could show a preview
of the document)
∂ Text can be moved, sized, formatted but “name or title” is taken from the object
and is not editable.

Object All objects are displayed as a rectangle with Ikon and Label ‘Name or Title’

∂ M-Files object type Icon or class icon is shown.

∂ ‘on Click Symbol’ to launch the metacard of the object (which could show a preview
of the document
∂ Text can be selected, moved, sized, formatted but “name or title” is taken from the
object and is not editable.

2.2.2 Configuring Object Types to Process Maps Symbols

In many cases it makes sense to have your M-Files objects be represented by a special symbol of the notation. For
documents we have automated that, but for any other object type, you manually need to assign this mapping with MF
Admin.

1. Open up M-Files Admin

2. Go to the Configuration panel and find branches for each of the different chart types.

3. Map the symbols of each chart type to any of the

Portfolio maps point from Map to map

typically. So let us configure this:

Select Portfolio, expand to the list of the 11

symbols.
Select the ‘functionstart’ symbol.

ADD… an ObjectType, expand to the object

type.
Select ‘PROCESS MAP’ as Identifier.
(You see the alias or the ID, depening on
your metadata model)

Page 5 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

Add another ObjectType that makes sense,

if you have an ‘Process’ Object, you could
map it aswell.

Note: Alternatively you can map CLASSES to

the Process Maps Symbols as well. .

To fully configure the system, you should spend some time review symbols of the notations an reflect, which M-Files
object could help to define them.

Page 6 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

Here is a list of the symbols by notation. We marked those, where a mapping is specifically useful:

BPMN FLOW EPC VCD Portfolio

Page 7 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

CONFIGURATION: USER INTERFACE - CUSTOM TABS

Process Maps lets you define some custom UI behavior in the configuration.

Internal
Internal
Internal
Internal
Search-Query: Number of results (dropdown)
ID of the View that provides the MF objects in the left
pane of the editor
To show a ‘Home View’ you need to determine the
viewpath.

Root = Main page

Name of the tab

Show a process map
Show the map with ID 166
Focus = put tab forward as selected
SVG= No: Don´t show SVG, fully render the map.
Lazy Loading switched off.

Path is the ‘PMAP Objects’ View. When this is selected,

a Help map shall appear.

Name of the tab

Show a process map
Show the map with ID 191
Focus = put tab forward as selected
SVG= Yes is faster loading than map, but non-interactive
Lazy Loading switched off.

Workflow tabs are shown based on ‘workflowID’ and

‘WorkflowStateID’.
WorkflowID

WorkflowStateID
WorkfllowStateID

Which tabs to display

(TAB CONTENT – see above)

Page 8 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION
Working copy - M-Files Process Maps Installation Guide

Load a website at the start of M-Files Desktop?

Name of the Tab
Which URL
Shall the tab be focused on after start?

3. MOVING MAPS BETWEEN VAULTS

Process Maps can be exported/imported and replicated with M-Files standard means. If you want to manually carry
over a map, all you need to transport is the XML-Content in the Object. The PMAP.XML file contains the drawing. So
theoretically, this is the only piece of information that needs to be transferred.

o Target environment:
ƒ Create a new PMAP object with the desired class.
ƒ Launch the editor, draw just some irrelevant content
ƒ Save the map.
∂ You now have created the object with 3 files
o Config.xml
o Pmap.SVG
o Pmap.xml (this is the file that needs to be replaced)

o Source environment
ƒ Navigate to the object, expand the object
ƒ Pick the Pmap.xml file and
ƒ Drag it onto the TARGET to replace the Pmap.xml file.

o Target environment:
ƒ Doubleclick the object to load the editor
ƒ See your map, just move an object slightly
ƒ Save the map.
∂ All files are updated.
ƒ You successfully moved from source to target.

Page 9 of 9

CONFIDENTIAL PROPERTY OF M-FILES CORPORATION, DO NOT COPY OR PUBLISH ONLINE WITHOUT AUTHORIZATION