LogoLogo
IntegrationsInstallationAdministrationContact Support
XMPro WorkFlow
XMPro WorkFlow
  • What is XMPro WorkFlow?
  • Getting Started
    • Browser Requirements
    • Features
  • Resources
    • What's New in 7.0
    • Security
    • Connectors
    • FAQs
      • Integration
      • Configuration
      • Troubleshooting
      • WorkFlow Monitor
  • Concepts
    • WorkFlow
    • WorkFlow Designer
    • WorkFlow Monitor
    • Administrator Model
    • Process Model
    • Activities
    • Activity Fields
    • Visio Basics
    • Activity Configuration Wizard
    • Integration Wizard
    • Report Designer Wizard
    • Dashboard Designer Wizard
  • How-To Guides
    • Business Group Management
      • Business Group Management in WorkFlow Designer
      • Business Group Management in WorkFlow
    • Role Management
      • Role Management in WorkFlow Designer
      • Role Management in WorkFlow
    • User Management
      • User Management in WorkFlow Designer
      • User Management in WorkFlow
    • Site Settings Management
      • Using Site Settings in WorkFlow Designer
      • Using Site Settings in WorkFlow
    • Meta Data Management
      • Meta Data Management in WorkFlow Designer
      • Meta Data Management in WorkFlow
    • Working with Process Groups
    • Working with Processes
    • Working with Activities
    • Working with Fields
    • Importing and Exporting Visio Diagram
    • Using Fast Fields
    • Using the Designer Wizards
      • Activity Configuration Wizard
      • Object Configuration Wizard
      • Integration Wizard
    • Configuring Landing Pages
    • Using the Report Designer
    • Using the Dashboard Designer
    • Using the Site Styles in WorkFlow
    • Transfer Manager
    • WorkFlow Connectors Administration
    • Creating WorkFlow Connector Plugins
  • Administration
    • Applying License
    • Manage Options
  • Installation
    • 1. Preparation
    • 2. Install WorkFlow
    • Upgrading Existing Installations
  • Release Notes
    • v7.0
Powered by GitBook
On this page
  • Architecture
  • WorkFlow Installation
  • WorkFlow Installation
  • WorkFlow Web Application and Database Installation
  • WorkFlow Designer Installation
  • Pre-requisites
  • WorkFlow Monitor Installation
  • Install the WorkFlow Monitor Installer
  • Install WorkFlow Monitor
  • Verify WorkFlow Monitor

Was this helpful?

Export as PDF
  1. Installation

2. Install WorkFlow

Previous1. PreparationNextUpgrading Existing Installations

Last updated 1 month ago

Was this helpful?

Architecture

The following deployment diagram shows an example on-premise architecture and the necessary resources for the XMPro WorkFlow in Microsoft Windows.

WorkFlow Installation

Start the installation process by downloading the executable installer file (called XMWorkFlowWeb.exe). Read through and accept the Microsoft license agreement when asked. Please note that an installer that would enable you to install the database and Web application will be installed first. When this installation is complete, you will be able to locate the WorkFlow installer from your Start menu, which will allow you to install one or more instances of the WorkFlow Web application and its database.

The installation process will proceed as follows:

  1. Install the WorkFlow installer

  2. Install an instance of the WorkFlow Web Application and Database

WorkFlow Installation

Start XMPro WorkFlow Setup Wizard

After accepting the Microsoft license agreement, you should see the welcome screen. Click Next.

License Agreement

Carefully read through the license agreement and select the I Agree option. Please note that you will not be allowed to continue with the installation unless you agree to this license agreement. If you have any questions or if there is something you don’t understand, don’t hesitate to contact us.

Click Next.

Installation Folder

Select the folder where WorkFlow should be installed. If needed, you can click on the Disk Cost button to see how much space is available and how much space you will need for the installation. Lastly, choose who this installation should be available for once complete. Should it be available for everyone that uses the machine you’re installing the software on or just for you?

Click Next and confirm the installation.

Confirm Installation

Click Next to confirm the installation.

When the installation is complete, click Close.

WorkFlow Web Application and Database Installation

To start the installation process for the WorkFlow Web application and database, select “XMPro WorkFlow” in your start menu.

You will be presented with a welcome screen as soon as the installer opens. On this screen of the wizard, choose “Install a new WorkFlow Site” and click Next.

Installation Details

The Installation Details form requires you to check installation details mainly focused on how the Web application will be installed in IIS.

Company

Enter the name of your company in the Company Name field.

Application Pool

Next to the Application Pool Name field, click on Change. Choose which application pool the application should use. You can either create a new application pool or select Use an existing Application Pool and select an existing application pool from the drop-down.

Next to the Security Account field, click on Change. Choose which security account you would like to use. The following options are available:

  • Network Service

  • Local System

  • Local Service

Alternatively, specify your own security account by selecting Specify your own Security Account and filling in your username and password.

Virtual Directory

In the Virtual Directory section, verify that all the values are correct for each of the fields using the table below.

Property
Description

Web Site

The Web site referred to here is the site you would like to use in IIS, for example Default Web Site (automatically selected in the screenshot below this table; this is the first Web site generally created for standard Windows machines on which IIS is available).

Virtual Directory Name

This is the name of the directory in IIS of the Web application that is being installed.

DNS Host Name

The DNS host name is the name of the host on which the Web application is being installed. The Web application will normally be installed to run under HTTP. If you would like to change this, select HTTPS from the drop-down next to the DNS Host Name label.

Content Directory

The content directory is the directory in which the content of the Web application will be stored. Click on the ellipse button next to the field to change the directory.

Create a Sub-Directory

Checking this box will cause the installer to create a sub-directory within the content directory.

Installation Path

The installation path is the full path of where the Web application will be created. This path is the content directory and the sub-directory combined.

Database Details

The Database Details form mainly focuses on capturing the details required to be able to connect to an existing SQL Server WorkFlow database or create a new one that can be used for the Web application that is to be installed.

Database Server

In the Database Server Name field, fill in the name of the server on which either an existing WorkFlow database that can be used can be found or where a new WorkFlow database can be created. Clicking on Reload will load all available servers, enabling you to choose a server from the drop-down.

Authentication Method

Either Windows or SQL Authentication can be used to connect to a WorkFlow database. Windows Authentication will, by default, is selected. To change the authentication method, click on Change. Next, fill in your SQL username and password and click OK.

Database Details

The default values filled in this section will cause the installer to attempt to create a new database on the selected server. If you would like to use an existing database, click on Change. Next, click on Connect to an existing database and choose the name of the database to which you would like to connect from the drop-down. If you would like to make a back-up of your database in case something happens or if you think you might need it later, select Backup my existing database and specify the Backup path.

Administrator Configuration

On the Administrator Configuration form you are required to provide details for an administrative user. Fill in your first and last name and specify the name and group of the first role. Next, note that three authentication options are presented to you as a way of logging into the Web application:

  • Windows Authentication

    • This will allow you to use Windows Authentication for authentication.

  • Custom Authentication

    • Choose your own username and password here. Use this username and password to log into WorkFlow once it is successfully installed.

Licensing Details

Fill in your licensing details. Click Next.

Script Execution Details

Specify which language should be used in the site. Two options are available:

  • CSharp

  • VBNet

Web Service Proxy Details

Enter your Web service proxy details. Details for Proxy Host can be left blank and for Proxy Port kept to the default "8080".

Click Next.

Installation Summary

Lastly, verify that all the details that you have specified are correct. If you’re satisfied, click Next.

Setup Complete

Once the installation is complete, you will be notified. You will be able to access the WorkFlow site by opening it from IIS or adding the URL into your browser. What the URL is will depend on the site details you’ve specified, for example, if the site was installed using HTTPS, the DNS host name was “mysampleserver.com” and the virtual directory name was “workflow“, the URL will be “https://mysampleserver.com/workflow/“.

WorkFlow Designer Installation

Pre-requisites

  • Check Hardware and Software requirements relating to the WorkFlow Designer first.

  • Check to make sure there is enough free disk space on your hard disk to meet the system requirements.

The following section includes procedures to install the WorkFlow Designer.

  1. Download and double-click the XMWorkFlowDesigner.exe to start the installation process. The Installation Wizard displays.

  2. Click Next. The End User License Agreement is displayed.

  1. Click I Agree or I Do Not Agree to the License Agreement.

  1. Click Next. The Installation Wizard displays the default directory in which the software will be installed.

  1. Change the directory if required by clicking on Browse and providing the required directory.

  2. Click the Everyone or Just Me Radio Button and click Next. A message will be displayed that the Installer is now ready to install the software.

    1. Confirm the installation by clicking Next.

  1. Installation Complete is displayed once the installation is completed. Click Close.

WorkFlow Monitor Installation

Start the installation process by downloading the executable installer file (called XMWorkFlowMonitor.exe). When this installation is complete, you will be able to locate the WorkFlow Monitor installer from your Start menu, which will allow you to install a WorkFlow Monitor instance.

Install the WorkFlow Monitor Installer

  1. Click the XMWorkFlowMonitor.exe, this opens the WorkFlow Monitor Setup Wizard.

  2. In the Welcome window of the WorkFlow Monitor Setup Wizard, click Next.

  1. Read through the License Agreement, select 'I Agree' and click Next.

  1. Specify the installation folder. Select 'Everyone' or 'Just me' to Install XMPro WorkFlow Monitor for yourself, or for anyone who uses this computer. Click Next.

  1. Click Next to confirm Installation.

  1. Click Close once installation is completed.

Install WorkFlow Monitor

  1. Access the WorkFlow Monitor installer from your computer's applications.

  2. Setup WorkFlow Monitor via the wizard. Click Next to continue.

  1. Select Install WorkFlow Monitor, click Next.

  1. Enter the Installation Details. Click Next.

NOTES:

The Authentication Server URL is the WorkFlow URL. To confirm the valid WorkFlow site, click Verify prior to clicking Next to proceed with the installation.

Uncheck Authentication Server Uses Windows Authentication if you do not intend to access server via Windows Authentication.

If the WorkFlow is not active (i.e. License is expired), the WorkFlow Monitor installation will fail.

  1. Specify the Database details and click Next.

NOTES:

Change the Authentication Method to Use SQL Authentication if you are not using Windows Authentication.

Enter details in the SQL Authentication Settings window.

  1. Specify the Web Application details and click Next.

  1. Confirm Installation and click Next to proceed.

  1. Click Finish to complete the installation wizard.

Verify WorkFlow Monitor

To verify that WorkFlow Monitor is installed correctly, check that:

  • Web UI is created

  • Database is created

Start the WorkFlow Monitor service before logging into the Web UI. You can change the Service Startup Type to Automatic rather than Manual.

If the WorkFlow Monitor is not started, it will give the error message when trying to login into the WorkFlow Monitor Web UI.

If WorkFlow Monitor is installed correctly, the following Web UI will be displayed.

Fig 1. Example of XMPro WorkFlow architecture in Windows
Fig 2. Starting WorkFlow Web Setup Wizard
Fig 3. Accept License Agreement
Fig 4. Select Installation Folde
Fig 5. Confirm Installation
Fig 6. Complete Installation
Fig 7. Access web application and database installer from Windows Start menu
Fig 8. XMPro WorkFlow site and database setup wizard
Fig 9. Enter site details
Fig 10. Application Pool Settings window
Fig 11. Security Account Settings window
Fig 12. Enter database details
Fig 13. SQL Authentication window
Fig 14. Database Details
Fig 15. Configure administrative user details
Fig 16. Enter license details
Fig 17. Select Script Code Language details
Fig 18. Enter Web Service Proxy Detail
Fig 19. Installation Summary
Fig 20. Installation Complete
Fig 21. Designer Setup Wizard
Fig 22. Click "I Agree"
Fig 23. Select Installation Folder
Fig 24. Confirm Installation
Fig 25. Installation Complete
Fig 26. WorkFlow Monitor Setup Wizard
Fig 27. WorkFlow Monitor Setup Wizard - License Agreement
Fig 28. WorkFlow Monitor Setup Wizard - Select Installation Folder
Fig 29. WorkFlow Monitor Setup Wizard - Confirm Installation
Fig 30. WorkFlow Monitor Setup Wizard - Installation Complete
Fig 31. WorkFlow Monitor Setup
Fig 32. Select action for wizard to perform
Fig 33. Add installation details for the WorkFlow Monitor service
Fig 34. Add database details
Fig 35. Add web application details
Fig 36. Confirm installation
Fig 37. Complete WorkFlow Monitor installalion
Fig 38. Verify Web UI is created in IIS Manager
Fig 39. Verify Database is created
Fig 40. Check WorkFlowService is running in the Service app
Fig 41. WorkFlow Monitor - Login failed
Fig 42. Inside WorkFlow Monitor Web UI successfully installed