Q-flow 3.0: Installation and Configuration

i

Q-flow 3.0: Installation and Configuration

Manual code: Qf304002ENG Version: 1.0 Applies to: Q-flow 3.04 Latest revision: 2/4/2009

Q f 3 0 4 0 0 2 E N G v 1 . 0

ii

Q - f l o w 3 . 0

Installation and Configuration

© Urudata Software Canelones 1370 • Piso 2 CP11200

Montevideo, Uruguay Teléfono: (598 2) 900 76 68 • Fax: 900 78 56

Q f 3 0 4 0 0 2 E N G I n s t a l l a t i o n a n d C o n f i g u r a t i o n v 1 . 0

3

Contents Introduction .................................................................................................................. 6

Organization of this manual ........................................................................................ 6

Requirements for standard installation ..................................................................... 8

Web client requirements .......................................................................................................................... 8 Software requirements ............................................................................................................................ 8 Hardware requirements .......................................................................................................................... 8

Windows client requirements .................................................................................................................. 8 Software requirements ............................................................................................................................ 8 Hardware Requirements ......................................................................................................................... 9

Web server requirements ........................................................................................................................ 9 Software Requirements .......................................................................................................................... 9 Hardware Requirements ......................................................................................................................... 9

Back-end server requirements ................................................................................................................ 9 Software Requirements .......................................................................................................................... 9 Hardware Requirements ....................................................................................................................... 10

Data Base ................................................................................................................................................ 10 Software requirements .......................................................................................................................... 10 Hardware Requirements ....................................................................................................................... 10

Infrastructure requirements .................................................................................................................. 10

Hardware requirements for software required by Q-flow ................................................................... 11 Internet Explorer 6.0 requirements ....................................................................................................... 11 Microsoft .net Framework 3.5 requirements ......................................................................................... 11 SQL Server requirements ..................................................................................................................... 11 Oracle requirements ............................................................................................................................. 11

Enabling IIS7 components (Windows Vista, Windows 2008 and Windows 7) ................................. 12

Installation .................................................................................................................. 14

Database installation on SQL Server .................................................................................................... 16 Troubleshooting .................................................................................................................................... 20

Database installation on Oracle ............................................................................................................ 21


4

Back-end services installation .............................................................................................................. 26

Site personalization database installation (SQL Server) .................................................................... 31

Site personalization database installation (Oracle) ............................................................................ 35

Web site installation ............................................................................................................................... 37 Troubleshooting .................................................................................................................................... 41

Tools installation .................................................................................................................................... 43

Q-flow web services installation ........................................................................................................... 51

Manual installation of mail services ..................................................................................................... 54 Creating the message queue ................................................................................................................ 55 Creating the Windows service .............................................................................................................. 56 Configuring the mail service .................................................................................................................. 57

Installers and their corresponding files ............................................................................................... 58

Updating Q-flow ...................................................................................................................................... 58 Before installing ..................................................................................................................................... 58 Updating the database .......................................................................................................................... 59 Updating the backend services ............................................................................................................. 61 Updating the site personalization database .......................................................................................... 61 Updating the web site ........................................................................................................................... 62 Updating the web services .................................................................................................................... 62 Updating the client tools ........................................................................................................................ 62

Uninstalling and repairing Q-flow components .................................................................................. 62

Licensing .................................................................................................................... 63

Configuration ............................................................................................................. 66

Configuration tool ................................................................................................................................... 66

Parameter Tree options ......................................................................................................................... 67

Parameters .............................................................................................................................................. 67 Database configuration ......................................................................................................................... 68 Notification senders .............................................................................................................................. 69

Organizational model elements’ extended properties ........................................................................ 70 Configurating extended properties ........................................................................................................ 70

Properties of attachments ..................................................................................................................... 72 Configuring the properties of attachments ............................................................................................ 72

Integration with Q-flow 2.3 ........................................................................................ 73


5

Configuring the connection to the Q-flow 2.3 database ..................................................................... 74

Installation and startup of Q-flow 2.3 service ...................................................................................... 75 Configuration of the Q-flow 3 web site backend service ....................................................................... 76

Q-flow parameter reference ...................................................................................... 77


6

Introduction The purpose of this manual is to describe the installation requirements of Q-flow 3.0 and to explain the installation procedure for all of its components. These are:

• The Q-flow database • The backend services • The Q-flow website personalization database • The Q-flow website • Tools

o The Business Processes Modeler o The Organization Model Manager o The Business Process Administrator

• Web services All of these components may be stored in different computers. Installing the web services is optional, since they are only necessary if the organization wishes to develop an application that uses Q-flow as a base. The manual also explains how to configure Q-flow. Starting with version 3.02, Q-flow has a quick installation option (Express Installation), which has been conceived for those who wish to install Q-flow in order to perform tests and evaluate the product. This installation mode is much simpler and requires less participation on the part of the user, since all components are installed in the same computer and, therefore, there is no need of asking many data which are necessary for the standard installation mode. If you wish to install Q-flow in this way, then, instead of reading this manual, please read the Installation Express manual (Qf304009ENG).

Organization of this manual This manual is divided into the following sections. The first section, “Requirements”, describes the software and hardware requirements for each component of the Q-flow architecture. The second section, “Installation”, describes the prerequisites and permissions needed in order to install each component, and the procedure for installing them. The third section, “Licensing”, explains how to load Q-flow licenses. The fourth section, “Configuration”, explains how to use the Q-flow configuration tool. It also describes the installation parameters that can be modified. The fifth section, “Integration with Q-flow 2.3”, explains how to make it possible for users of Q-flow 3 who are also users of Q-flow 2.3 to see their tasks from both products in a unified way in the Q-flow 3 web site.


7

The sixth section, “Q-flow parameter reference”, has a list of Q-flow installation parameters. This manual takes into account the Q-flow architecture, dividing each section according to Q-flow’s components. Although all components may be installed in the same computer, the manual separately shows the units that make it possible to install each component in a different server. It is possible to install all components in a single computer or at least in a single server with several clients.


8

Requirements for standard installation This section describes the installation requirements for each component of Q-flow 3. To execute the Express installation, it is not necessary to comply with all these requirements. For more information about it, see the Express installation manual.

Web client requirements Common users of Q-flow (those who only take part in workflows, do not design processes and do not perform Q-flow administrative tasks) need only to use a web browser. Additionally, if they wish to use e-mail to receive Q-flow task notifications, they need a mail client.

Software requirements

• One of the following operating systems: o Windows 2000 o Windows 2003 o Windows XP o Windows Vista o Windows Server 2008 o Windows 7

• One of the following web browsers: o Internet Explorer 6.0 or higher o Google Chrome o Mozilla Firefox 3 or higher

• Mail client (optional)

Hardware requirements Hardware requirements are the same as the same as the browser’s hardware requirements.

Windows client requirements Next, requirements that have to be met by computers belonging to users who use Q-flow’s Windows Tools (Business Process Modeler, Organizational Model Manager and Business Process Administrator) are described.


• One of the following operating systems: o Windows 2003 o Windows XP (recommended) o Windows Vista


9

o Windows Server 2008 o Windows 7

• Microsoft .net Framework 3.5

Hardware Requirements

• As required by Microsoft .net Framework 3.5 • Minimum recommended setup:

o Pentium 4 o 512 MB RAM

Web server requirements The web server is the server where the Q-flow website will run. The server where the web services will be hosted can be the same as the web server. The web services server must meet the same requirements as the web server.

Software Requirements

• One of the following operating systems: o Windows 2003 o Windows XP o Windows Vista o Windows Server 2008 o Windows 7

• Internet Information Services 5 or higher • Microsoft .net Framework 3.5


• Hardware requirements are the ones of Microsoft .net Framework 3.5 and Internet Information Services 5

• Minimum recommended configuration: o Pentium 4 o 512 MB RAM

Back-end server requirements The back-end server runs the services used by other Q-flow components.

Software Requirements

• One of the following operating systems o Windows 2003 (recommended) o Windows XP o Windows Vista o Windows Server 2008


10

o Windows 7 • MSMQ (common) • Microsoft .net Framework 3.5


• These are the requirements of Microsoft .net Framework 2.0 • Minimum recommended configuration:

o Pentium 4 o 1GB RAM

Data Base Next, requirements are described that must be met by the computer where the database will be hosted.


• One of the following operating systems: o Windows 2003 (recommended) o Windows XP o Windows Vista o Windows Server 2008 o Windows 7

• One of the following database management systems: o SQL Server 2005 or higher o SQL Server 2005 Express or higher (this option is not recommended for production

environments) o Oracle 9i SR2 or higher

• Microsoft .net Framework 3.5


• These requirements are the same as those of the database management system used (SQL Server, SQL Server Express or Oracle 9i SR2 or higher). For more information, see the database management system’s documentation.

• Minimum recommended configuration: o Pentium 4 o 1 GB RAM

Infrastructure requirements

• SMTP Mail services or Exchange • Active Directory (recommended) or NTDomain


11

Hardware requirements for software required by Q-flow Next, the requirements of the software needed to run Q-flow (as, for instance, the .net Framework 3.5) are described.

Internet Explorer 6.0 requirements Internet Explorer 6.0 requires:

• 486/66 MHz or higher processor (Pentium processor recommended) • 32 MB of memory • Super VGA Monitor(800 x 600) or higher resolution monitor with 256 colors • Required space for Internet Explorer 6.0 installation: 12 MB

Microsoft .net Framework 3.5 requirements

• Processor: 400 MHz (recommended: 1 GHz) • 96 MB RAM: (recommended: 256 MB) • Disk space (32 bits): 280 MB

Note: These are the requirements for the redistributable framework package. More information is available at http://msdn.microsoft.com/en-us/library/bb882520.aspx.

SQL Server requirements SQL Server 2005 and SQL Server 2008 are available in several editions, each of which has different requirements. See the product documentation. SQL Server 2005 documentation is available at: http://www.microsoft.com/australia/servers/sql/prodinfo/sysreqs/default.mspx SQL Server 2008 documentation is available at: http://msdn.microsoft.com/en-us/library/ms143506.aspx

Oracle requirements Requirements for oracle vary depending on the version. See the product documentation.


12

Enabling IIS7 components (Windows Vista, Windows 2008 and Windows 7) In versions of Windows that include Internet Information Services 7 (Windows Vista, Windows 2008 and Windows 7), the components needed in order to install the engines and the web site may be present without being enabled. In these cases, before executing the installer, you must follow certain steps to enable the features required by Q-flow. To that end, do the following:

1. Open the Control Panel. 2. Inside the Control Panel, open Programs. 3. Choose the "Turn Windows Features On or Off" option. 4. In the Windows Features window, enable the following components:

a. ASP .Net (Figure 1) b. IIS 6 Metabase and IIS6 configuration compatibility (Figure 2) c. Windows authentication (Figure 3)

Figure 1 ASP .Net activation


13

Figure 2 IIS 6 Metabase and IIS6 configuration compatibility

Figure 3 Windows authentication


14

Installation To install Q-flow, insert the product's CD into the CD-ROM drive of the computer in which you wish to run the installer. If auto-run is enabled in the computer in which you insert the Q-flow CD, the Q-flow installer will run automatically. Otherwise, run the Setup.exe file, which is in the CD. Figure 4Figure 4 shows the installer's initial screen. This screen shows two options:

• Standard Setup: standard installation. Choose this option, unless you wish to install Q-flow with the sole purpose of evaluating it. In that case, choose the second option.

• Express Setup: Express installation. Choose this option only if you wish to install the product in a single computer, with the purpose of evaluating it.

This manual explains the standard setup. If you wish to perform the Express setup, which is simpler, see the Express installation manual (Qf304009ENG). From this point on, this manual assumes you are performing a standard setup.

Figure 4 Main Q-Flow installer screen.

Figure 5 shows the installer's second screen. This screen shows, in the order in which they must be executed, the installers of all Q-flow components. These installers are the following:

1. Database installer 2. Backend services installer 3. Personalization site database installer 4. Web site installer


15

5. Client tools installers (business process manager, organization model manager and business process administrator)

Figure 5 Q-flow installer's main screen


16

Database installation on SQL Server This section explains how to install the Q-flow database on SQL Server Prerequisites

• SQL Server 2005 or higher, or SQL Server Express 2005 or higher • Microsoft .net Framework 3.5 on the computer where the installation will be performed.

Permissions The user performing the installation must have the following permissions.

• Permission to create databases (only necessary during installation) • It is not necessary to log in to the database server to perform the installation.

Procedure 1. Run the Q-flow installer and select the “Database Setup” option (see Figure 4Figure 4). This will

start the database installer. (Figure 6Figure 6)

Figure 6 First database installer screen (SQL Server)

2. Click “Next” 3. In the new screen, if you are performing a new Q-flow installation, select Option “Create new Q-flow database” (Figure 7Figure 7) and click “Next”. If, on the contrary, you already have a Q-flow databse installed and you wish to update it, choose the "Update Q-flow database" option.


17

Figure 7 Second installer screen

4. The following screen (Figure 8Figure 8) will ask you to enter the following data:

• Server name: the name of the database server • Windows authentication: check this option if the SQL Server instance hosted on the server

whose name you entered above is configured for using Windows authentication, or if it uses mixed authentication but you want to use the current Windows user to connect to the server.

• SQL Server authentication: check this option if the SQL Server instance hosted on the server whose name you entered above is configured for using mixed authentication. In this case, you must enter the user name and password that should be used to connect to the server.

• Database: the name you want to give to the database Once the data has been entered, click “Next” Note: Remember that the user account used to perform the connection to the database must have permissions to create a database. Note: In a computer that is used for tests or for software development, both SQL Server 2000 and SQL Server 2005 or Express (or a later version) may be installed simultaneously. In this case, be careful when you write the server name. For example, if the computer has SQL 2000 and SQL Server Express is installed afterwards, the computer name will probably reference the SQL Server 2000 instance. In order to reference the SQL Server Express instance, you will probably have to add "\SQLExpress" as a suffix to the server name. For example: "dbserver\SQLExpress" instead of "dbserver". If you do not add that suffix, the installer will attempt to install the database on SQL Server 2000 and will fail with the following error:


18

"Line 2: Incorrect syntax near 'XML'."

Figure 8 Database connection configuration

5. The following screen (Figure 9Figure 9) allows you to configure the following properties:

• Default user properties o User name: default user name. The default user is the first Q-flow user to be created. o Domain name: the domain name that will be used to authenticate the default user. o Logon name: the Windows user name matching the default user name.

• Content properties o Language: The default language to be used by Q-flow. The names of the system views

and other predefined Q-flow database elements will be created in the language selected here.

• Click "Next" to continue.


19

Figure 9 User and default language configuration

6. The following screen shows the information entered on the previous screens. Check the entered data, and if you find that any of them is incorrect, click “Back” until you get to the screen where you entered it and change it. If there are no errors, click “Next” to start the installation.

Figure 10 Database installation


20

Troubleshooting This section describes some of the most usual errors that may occur during the database setup. The error on Figure 11 appears when the installer attempts to update an existing database and the installer fails to find a database with the name provided. In this case:

• Check that you've written the database name correctly.

Figure 11 Wrong database name

If the error shown in Figure 12 appears, check whether you have written the server name correctly.

Figure 12 Unable to establish connection to the server

The "Incorrect syntax near 'XML' error (Figure 13) has already been described above, and it probably indicates that the name of the server is wrong, or that the name you entered for it corresponds to an SQL Server 2000 instead of a later version of SQL Server. It is also possible that you do not have the “CREATE XML SCHEMA COLLECTION” permission.


21

Figure 13 Incorrect syntax near 'XML'

Database installation on Oracle This section explains how to install the Q-flow database on Oracle. Prerequisites

• Oracle 9i SR2 or higher. • ODP.NET 11g (can be downloaded from http://download.oracle.com/otn/other/ole-

oo4o/ODTwithODAC1110621.zip) • Microsoft .net Framework 3.5 in the computer where the installation will be performed.

Permissions The user that performs the installation should have the following permissions:

• Permission to create databases (only necessary during installation) • It is not necessary to log in to the database server to perform the installation.

Procedure

1. Run the Q-flow installer. Check the “Oracle” option and select "Database Setup" (see Figure 4Figure 4) with the "Oracle". Q-flow will open the window shown in Figure 14Figure 14.

2. Click "Next".


22

Figure 14 The first Database Installer screen (Oracle)

3. In the new screen, select "Create new Q-flow schema" and click "Next".

Figure 15 The second Database Installer Screen (Oracle)


23

4. The following screen (Figure 16Figure 16) will ask you to enter the following information:

• Connection properties:

o TNS name: the TNS that must be used in order to make a connection with the database server.

o User name: the user name that must be used to make a connection to the database server.

o Password: the password corresponding to the user name entered above. • Schema properties:

o Schema: the name of the schema of the new database (default is Qflow3). o Schema password: the password of the schema mentioned above. o Data TableSpace: path and name of the file that will be used to create the data

tablespace for the new schema in the database server. The name of the tablespace that will created will be “TD_<Schema name>”. If the installer is run in the Oracle server, the <ORACLE_BASE> and <SID> tags are replaced by the paths corresponding to that server.

o Index TableSpace: path and name of the file that will be used to create the index tablespace for the new schema in the database server. The name of the tablespace that will be created will be “TI_<Schema name>”. If the installer is run in the Oracle server, the <ORACLE_BASE> and <SID> tags are replaced by the corresponding paths in the server.

o Temp TableSpace: temporal table space (by default, TEMP).

Figure 16 Data for database installation (Oracle)


24

5. The next screen (Figure 17Figure 17) allows you to configure the following properties:

• Default user properties

o User name: The default user’s user name. The default user is the first Q-flow user to be created.

o Domain name: The domain name that will be used to authenticate the default user. o Logon name: The name of the Windows user that corresponds to the default user.

• Content properties o Language: The default language to be used by Q-flow. The names of the system views

and other predefined elements of the Q-flow database will be created in the language selected here.

Click "Next" to continue.

Figure 17 Default user and language configuration

6. The following screen (Figure 19Figure 19) shows the information entered on previous screens. Check it for errors, and if you find any incorrect information, click “Back” until you get to the screen where the information was entered and correct it. If there are no errors, click “Next” to start the installation.


25

Figure 18 Summary of entered data

Figure 19 Database installation


26

Back-end services installation Prerequisites

• Microsoft .net Framework 3.5 • MSMQ (common) • Optional: Messaging service (SMTP o MAPI) • If you are using Oracle: ODP 11g or higher (download it from

http://download.oracle.com/otn/other/ole-oo4o/ODTwithODAC1110621.zip). Permissions

• While installing: o Local administrator with permissions to interactively log in to the server (for installation). o Permissions to create queued messages and services.

• While running the services (permission for the user who will run the services.) o Run as service o Execute as batch process

Procedure 1. Run the Q-flow installer and select the Option "Backend Services Setup". This will start the back-end services installer (Figure 20Figure 20).

Figure 20 Back-end services installer

2. Click "Next".


27

3. In the following screen (Figure 21Figure 21), where it says “Folder”, write the path of the folder where you wish to install the Q-flow back-end services. If you wish the services to be installed for all of the computer users, check the “Everyone” box. Otherwise, check the “Just me” box. Click “Next.”

Figure 21 Selecting the Q-flow installation folder.

4. At this point (Figure 22Figure 22), everything will be ready to perform the first part of the installation. Click “Next” to continue.

Figure 22 The screen that comes before the first part of the installation.


28

Figure 23 Running the first part of the installation.

5. Once you finish the first part of the installation, a window will appear (Figure 24Figure 24) requesting you to enter a user name and password. This is the user account thatwill run the back-end services. Remember that this user must have permissions to run the services (if you have doubts regarding needed permissions, see the section on necessary permissions).

Figure 24 Service login configuration

6. Next, a window will appear (Figure 25Figure 25) that will let you configure several service parameters:

• Organization properties o Organization name: The name of your organization. Q-flow uses this name to validate

Q-flow licenses. Therefore, if you already have licenses, it is important that you use the same name that was used to generate them. If you do not have licenses yet, remember, when requesting them, that this is the name that must be used to generate them.

• Web site properties


29

o Server FQDN: FQDN (the name) is the name of the server that will host the Q-flow web site.

o Virtual directory: The name of the virtual IIS directory that will host the Q-flow web site. • Notification services: Select the mail services you wish to use. You can choose more than one

and configure Q-flow users later in order to use different services. o SMTP: SMTP mail. o Simple MAPI: Simple MAPI (Exchange) mail. It does not allow messages to be sent in

HTML. o Extended MAPI: extended MAPI mail. It differs from simple MAPI in that it allows

messages to be sent in HTML. • Data base properties

o Data provider: Database provider (for example, SQL Server 2005). o Server name: name of the server that stores the Q-flow database, which must have

been installed previously. o Data base name: name of the Q-flow database created by the database installer. o Integrated security: specify whether the back-end services should connect to the

database using integrated security. If this option is checked, Q-flow will connect to the database with integrated security, using the user account that runs the service. Otherwise, the installer will enable two text boxes for you to enter the SQL Server user name and password to be used in order to connect to the database with SQL Server security.

Push the "Test connection" button to test whether Q-flow is able to establish a connection to the database with the provided data. If the test fails, check the data, correct it and test the connection again.

Figure 25 Installation parameters.

When you finish entering the information and checking the connection, click “OK”.


30

7. Next, you must enter the data that will be used by the mail services selected on the previous screen (it is also possible that no mail service has been selected; in this case the installer should go directly to step 8. Enter the following information for the SMTP engine:

• Host name: name of the server that will be sending messages. • System user name: user name corresponding to the account that will be used to send the

messages. • System user e-mail: name of the mail box from which messages will be sent.

Figure 26 SMTP service configuration

Enter the following information for the simple MAPI engine:

• Server Name: Exchange server name. • Mailbox: name of the mailbox that will be used to send messages. • Profile: name of the Outlook profile that will be used to send messages.

Figure 27 Simple MAPI service configuration

The extended MAPI engine requires the same information to be entered as the MAPI engine, except for Profile name.


31

Figure 28 Extended MAPI service configuration

8. Once the mail services have been configured, Q-flow will complete the back-end services installation. (Figure 29Figure 29). Once installation is complete, the installer will automatically run the Q-flow license configuration tool (License Viewer). If you have no licenses or, for some reason, you want to load the licenses later, close the tool. You will be able to open it later simply by using the desktop shortcut created by the installer.

Figure 29 Finishing backend services installation

Site personalization database installation (SQL Server) Prerequisites

• SQL Server 2005 or higher, SQL Server Express 2005 or higher • Microsoft .net Framework 2.0 with SDK on the computer where the installation will be run.


32

Permissions

• User with permissions to create databases on the server (used only when creating the database)

• It is not necessary to log in to the server to perform the installation. Procedure 1. Run the Q-flow installer and select the "Personalization Database Setup" option. The installer will start the site personalization database installation. Click “Next.”

Figure 30 Site personalization database installer.

2. In the following window (Figure 31Figure 31), select the option "Configure SQL Server for application services". Click "Next".


33

Figure 31 Second screen of the site personalization database installer.

3. In the following window (Figure 32Figure 32), complete the information regarding the server where you wish the site personalization base to be installed. The information to be completed is:

• Server: server where you wish to create the database. • Windows authentication: indicates that Windows authentication, along with the current user's

credentials, must be used to establish a connection to the server specified in "Server". If this SQL Server is configured to use Windows security only, you must select this option.

• SQL Server authentication: indicates that an SQL Server user must be used to establish a connection to SQL Server. This is possible only if the SQL Server is configured to use mixed security. If you choose this option, enter the SQL Server user name ("User name") and password ("Password") to be used.

• Notification services: Select the mail services you wish to use. You can choose more than one and configure Q-flow users later in order to use different services.

• Database: name of the database to create. If you leave the default option ("<default>") the installer will use the default name("aspnetdb").

Note: remember that the user account that will be used to establish a connection to the SQL Server must have permissions to create databases. Click "Next".


34

Figure 32 Server, credentials and database name

4. The following screen (Figure 33Figure 33) shows the information entered in the previous steps. Check it, and if there are no errors, click “Next.” to proceed with the installation. Otherwise, click on “Previous” to make the corrections you think necessary.

Figure 33 Confirmation screen


35

5. The following screen (Figure 34Figure 34) indicates that the installation is ready.

Figure 34 Finished installation

Site personalization database installation (Oracle) Prerequisites

• Oracle 9i SR2 or higher • Microsoft .net Framework 3.5 with SDK in the computer where the installation will be performed

Permissions

• A user that is an administrator of the database in which the schema will be installed. • The user that has been created when installing the Q-flow schema.

Procedure 1. Run the Q-flow installer so that Oracle is selected as database provider, and select the

“Personalization Database Setup” option. The installer will start installing the site personalization database. Click on “Next”.

2. The installer shows a screen like the one shown in Figure 35. Keep the “Install all providers” option checked.


36

Figure 35 Second screen of the site personalization database installer

3. In the following screen, select the Oracle database and the server in which the new schema will be

installed.

• Connection properties (DBA privileges required) o TNS name: TNS that must be used in order to make a connection to the database

server. o User name: name of the user that must be used in order to make a connection to the

database server. o Password: password that must be used in order to make a connection to the server.

• Schema properties: o Schema: name of the schema that will store the personalization data. o Schema Password: password of the above mentioned schema. o Data TableSpace: name of the tablespace that must be used for the data of the

personalization schema. This tablespace must exist before, since, unlike the database installer, this installer does not create a tablespace. One option is to use the tablespace that has been created during the database installation.


37

Figure 36 Connection and schema properties

4. The following screen shows the data that have been entered. Review them, and if you find no mistakes, click on "Next" in order to perform the installation. Otherwise, click on "Back" in order to make the necessary corrections.

Web site installation Prerequisites

• Microsoft .net Framework 3.5 • IIS • ASP.net 2.0

Permissions

• Local Administrator, with permission to log in interactively to the server • Permission to create virtual directories or writing permissions on the selected virtual directory • The site’s Application Pool user must have reading and writing permissions over the site

personalization database Procedure To install the Q-flow web site, do the following: 1. Log in to the server and run the Q-flow installer. 2. Select "Website Setup". This will initialize the web site installer (Figure 37Figure 37). Click "Next".


38

Figure 37 Web site installer

3. In the following screen, choose the IIS site in which you wish to install the Q-flow site, and the name of the virtual directory to be used (see Figure 38Figure 38). Choose the application pool as well.

Figure 38 Virtual directory and site selection


39

4. At this point (Figure 39Figure 39), everything is ready to start the installation. Click "Next" to begin the installation.

Figure 39 Everything ready for installation

Figure 40 Q-flow web site installation in progress

5. Once the installation is finished (Figure 40Figure 40), you must configure the site (Figure 41Figure 41). In order to do this, complete the following information:


40

• Personalization data base: information regarding site personalization database location.

o None: indicates that no personalization database should be used. o Sql Server 2005: indicates that a database that is stored in an SQL Server 2005 should

be used. o Server name: you will be asked to enter this parameter if you have chosen the “Sql

Server 2005” option. It specifies theserver where the site personalization database has been installed.

o Service name: this parameter appears instead of “Server name” if you have selected the “Oracle” option above. It indicates the TNS corresponding to the schema that will be used as site personalization database.

o Database name: you will be asked to enter this parameter if you have chosedn the “Sql Server 2005” option above. It specifies the name of the site personalization database (if you left the default option when installing, it is "aspnetdb").

o Integrated security: This parameter appears if you have chosen the “Sql Server 2005” option above. It specifies whether the connection to the site personalization database should be performed with integrated security. If this option remains checked, Q-flow will connect to the database with integrated security by using the current user's credentials. Otherwise, the installer will enable two text boxes so that you can enter the SQL Server user name and password that are to be used in order to connect to the server with SQL Server security.

o User name: if Oracle or SQL Server with no integrated security is used, it specifies the user name to be used in order to make the connection to the database. Otherwise, this option is disabled.

o Password: if Oracle or SQL Server with no integrated security is used, it specifies the password to be used in order to make the connection to the database. Otherwise, this option is disabled.

• Backend services o Server name: name of the server that hosts the back-end services.

Figure 41 Site parameters


41

Click "OK". 6. At this point, the installation should finish (Figure 42Figure 42). Click "Close".

Figure 42 Installation complete

Troubleshooting If you try to access the web site and instead of seeing the site you see an error message like the one shown in Figure 43Figure 43, it means that the ASP.NET version for this site has not been configured properly (notice the references to the 1.1 version of the Framework in the lower part of the figure). To correct this problem: 1. Open the Internet Information Services Manager (Control Panel, Administrative Tools, Internet Information Services (IIS) Manager). 2. Right-click the Q-flow web site virtual directory and select the “Properties” option from the menu (Figure 44Figure 44). 3. In the Properties window select the ASP.NET tab (Figure 45Figure 45) and change the version to 2.0.xxxxx. Click “Apply”.


42

Figure 43 Possible error after installing the site

Figure 44 First step for correcting the error


43

Figure 45 Changing the ASP .NET version used by the site.

Tools installation Prerequisites

• Microsoft .net Framework 3.5 Permissions

• Local Administrator with permission to interactively log in to the server Procedure Q-flow 3.0 provides three Windows Tools: the Business Process Modeler, the Organization Model Manager and the Business Process Administrator. To install the Business Process Modeler: 1. Log in to the server and run the Q-flow installer. Select the option "Business Process Modeler Setup". This will initiate the Business Process Modeler installer. (Figure 46Figure 46). Click "Next".


44

Figure 46 Business Process Modeler installer

2. In the second screen (Figure 47Figure 47), specify the folder into which you wish to install the tool. Also specify whether the tool is to be available only to the user who is running the installation or if all computer users should be able to access it. Click "Next".


45

Figure 47 Installation folder selection

3. At this point, (Figure 48Figure 48), everything is ready for installation. Click “Next.”

Figure 48 Everything ready for installation


46

Figure 49 Installation in progress

4. When the screen showing Figure 50Figure 50 appears, the installation is complete. Click "Close".

Figure 50 Finished installing Business Process Modeler

To install the Organization Model Manager: 1. Select the option "Organization Model Manager Setup". This will start the installation of Organization Model Manager (Figure 51Figure 51). Click "Next".


47

Figure 51 Organization Model Manager installation

2. In the second screen (Figure 52Figure 52), specify the folder in which you wish to install the tool. Also specify whether the tool is to be available only to the user who is running the installation or if all computer users should be able to access it. Click "Next".

Figure 52 Folder selection


48

3. At this point (Figure 53Figure 53) everything is ready for installation. Click "Next".

Figure 53 All set for installation

Figure 54 Running the installation

4. When the installer shows a screen like the one in Figure 60Figure 60, the installation is complete. Click "Close".


49

Figure 55 Organization Model Manager installation complete

To install the Business Process Administrator:

1. Select “Busines Process Administrator Setup”. This will start the Business Process Administrator installer (). Click on “Next”.


50

Figure 56 First screen of the business process administrator installer

2. In the second screen, specify the folder in which you wish to install the tool. Specify also

whether the tool will be available only to the user that is performing the installation or to all users of the computer. Click on “Next”.


51

Figure 57 Second screen of the business process administrator installer

3. At this point (Figure 58Figure 58), everything is set for the installation. Click on “Next”.

Figure 58 Last screen before installation


52


When the installation ends, click on “Close”.

Q-flow web services installation The Q-flow web services installation is performed separately from the installation of the other components. Prerequisites

• Microsoft .net Framework 3.5 • IIS • ASP.net 2.0

Permissions

• Local Administrator, with permission to interactively log in to the server • Permission to create virtual directories or writing permissions in the selected virtual directory

Procedure To install the web services, do the following: 1. Run the WebServiceSetup.msi file. This will bring up a window as shown in Figure 60Figure 60. 2. Click "Next". This will bring up a window as shown in Figure 61Figure 61.


53

Figure 60 First web services installation screen

3. The second screen will request the following information:

• Site: The IIS site in which you wish to install the web services. • Virtual directory: the name of the virtual directory where the web services will be hosted.

Figure 61 Second web services installation screen


54

4. Click "Next". This will bring up a window announcing that the installation is ready to be performed (Figure 62Figure 62). 5. Click "Next". The installer shows a screen showing the installation progress (Figure 63Figure 63).

Figure 62 Everything is ready for the web services installation



55

6. After a while, the installer will show a window requesting information about the location of the back-end services. Write the name of the server that hosts the back-end services where it says "Server name", and click “OK”. 7. Web services installation has finished.

Figure 64 The installer requests information about the location of the back-end services.

Figure 65 Installation complete

Manual installation of mail services If Q-flow’s mail services have not been installed when the other services were installed, and you wish to install them, you must do it manually. Manual installation comprises three steps:

1. Creating the message queue 2. Creating the Windows service 3. Configuring the mail service


56

Creating the message queue To create the message queue:

1. Open the Windows Computer Management tool, which can be found in the Administrative Tools folder.

2. Expand the “Services and Applications” node and the “Message Queing” node. 3. Right click on “Private queues” and, under the “New” category, select “Private Queue” (Figure

66Figure 66). This causes the message queue creation dialog window to open (Figure 67Figure 67).

Figure 66 Creating a message queue


57

Figure 67 Message queue creation window

4. Enter a name for the queue. The name you must enter depends on the service you are installing, as shown in the following table. Service Queue name SMTP message_to_smtp SimpleMAPI message_to_mapi ExtendedMAPI message_to_mapiex

Once the name has been entered, check the “Transactional” option and click on “OK”.

5. After creating the queue, make sure the user account with which the mail service will run has

sufficient permissions. That user account must have the “Receive Message”, “Peek Message” and “Send Message” permissions. Make sure also that the user account which executes the Q-flow engine service (Engine) has the “Send Message” permission in the queue.

Creating the Windows service The following step, after creating the message queue, is to create the Windows service. In order to do this, the InstallUtil tool, which the .Net Framework provides in order to install Windows services. This tool is an executable file which can be found in the system’s hard drive, in the \WINDOWS\Microsoft.NET\Framework\v2.0.xxxxx folder. To execute it:

1. Run the Windows command line tool (Start, Run, “cmd”).


58

2. Navigate towards the folder where the InstallUtil can be found. This tool is in the \Windows\Microsoft.NET\Framework\v2.0xxxxx folder (xxxxx may vary; the folder may be called, for example, v2.0.50727). Example: run the following command, “cd C:\Windows\Microsoft.NET\Framework\v2.0.50727”.

3. Run “InstallUtil” followed by the complete path of the file corresponding to the mail service you wish to install. The mail service files can be found in the same folder as the Q-flow backend services installer. The following table shows which file corresponds to which service.

Service Service file SMTP Qframework.Listener.SMTP.exe SimpleMAPI Qframework.Listener.SimpleMAPI.exe ExtendedMAPI Qframework.Listener.ExtendedMAPI.exe

Example: if you want to install the SMTP service, assuming the disk drive is “C” and that the files are in the default location, you should run the following command:

InstallUtil “C:\Program Files\Urudata\Q-flow Backend Services\Qflow.Listener.SMTP.exe” Once you have executed the command, a dialog window which allows you to enter the credentials with which the service should run appears (Figure 68Figure 68).

Figure 68 Configuring the account under which the service will run

4. Enter the username, password and password confirmation of the user whose account will run the service. This user must have permissions to access the message queue you created before.

Configuring the mail service Once the message queue and the Windows service for the mail service have been created, you must register the service in the Q-flow configuration so that later it is available for users to use. It is advisable to use the Q-flow configuration tool to do this. This tool provides a graphical interface which simplifies the system configuration tasks (see “Configuration toolConfiguration tool”). Next, the steps you should follow to configure the mail server are described:

1. Open the configuration tool (“Configuration Editor”). 2. Right click on the “Notification senders” node to display the “Add new notification sender” option. 3. Select the type of the mail service you are installing. Figure 69Figure 69 shows the mail service

type options:


59

Figure 69 Mail service configuration

4. Enter the properties of the mail service. No matter which mail service you are installing, you must enter a name and the address of the service’s queue. In addition to that, each type of service has specific parameters that determine how the service will work. These are described in the “Notification senders” section of this manual.

After making these changes, restart the engine service and the organizational model manager backend (OMM listener). You must also start the mail service you have just installed. The new mail service will appear in the “Notifications” tab of the user properties window in the organizational model manager (see corresponding manual). There, it is possible to enable the delivery of notifications for each user through the new service.

Installers and their corresponding files The Q-flow installer (Setup.exe) opens a screen from which it is possible to execute all the Q-flow component installers. Therfore, it is seldom necessary to manually execute each component installer. However, knowing which file corresponds to which installer might be useful. The files corresponding to each installer are as follows:

• Database installer (SQL Server): DataBaseSetup_Sql2005.exe • Database installer (Oracle): DataBaseSetup_Oracle9iSR2.exe • Backend services installer: BackendSetup.msi • Web site personalization database installer: aspnet_regsql.exe • Web site installer: WebSetup.msi • Business Process Modeler: BPMSetup.msi (this is in a folder with the installer’s language

name, inside the Tools folder). • Organization Model Manager installer: OMMSetup.msi (this is in a folder with the installer’s

language name, inside the Tools folder). • Business Process Administrator installer: BPASetup (this is in a folder with the installer’s

language name, inside the Tools folder).

Updating Q-flow This section explains how to install a new version of Q-flow 3.0 where Q-flow 3.0 is already present.

Before installing Before executing the installers, do the following:

1. Make sure that all packages, templates and other elements have been checked in (see, in the business process modeler manual, the sections on change control).


60

2. Stop all Q-flow services and make sure no messages are left in the message_to_notify queue and in the news_to_qflow queue. If there are messages left in any of these queues, start Q-flow’s services again and let them run until both queues are empty. After that, stop the services again. In order to check whether the message queues are empty, do the following:

a. Open the “Computer Management” tool (Start, Control panel, Administrative tools, Computer Management).

b. In the tree that appears on the left, open the “Services and applications” item. c. Inside “Services and applications”, open “Message Queuing”. d. Inside “Message Queuing”, open “Private queues”. e. Inside “Private queues” are the queues mentioned above. For each one of them, select

the corresponding “Queue messages” item, and check whether it is empty.

Figure 70 How to check whether the message queues of Q-flow are empty

Updating the database To update the database, run the Q-flow installer, choose the “Database setup” option and select the “Update Q-flow database” option (SQL Server, Figure 71) or the “Update Q-flow schema” option (Oracle, Figure 72). For more information about the first steps, see the “Installation” and the “Database installation on SQL Server” or “Site personalization database installation (Oracle)” sections, according to the database management system you use.


61

Figure 71 Updating the database, SQL Server


62

Figure 72 Updating the database, Oracle

Updating the backend services Before updating the backend services, it may be convenient to make a backup of the “System.config” file, so that configuration changes are not lost. In order to update the backend services, you must uninstall the ones that are currently installed and install the new ones. To uninstall the backend services, use the “Add or remove programs” tool. Once the new version of the backend services has been installed, use the backup of the “System.config” in order to compare it with the new System.config, which has been installed, and modify the latter in order to restore the configuration that existed before the update. It is not advisable to replace the new System.config with the old one, since the new one may contain parameters that are not present in the old one and that are necessary for the new version of Q-flow to function. It is better to modify the new System.config so that it becomes consistent with the old one and it has the configuration changes the old one had.

Updating the site personalization database When updating Q-flow, do not run the web site personalization database installer. This database must not be updated, as its structure does not change.


63

Updating the web site Before updating the web site, you should backup those pages of Q-flow that have been modified, as these will be overwritten when you install the new version of the site. Once the update has been performed, you should compare the pages that have been installed with the ones you have backed up, and modify the former so that they are consistent with the latter and are compatible with the new version of Q-flow. It is not necessary to backup custom forms, as the installer does not remove them. If you have modified the web.config file, you should back it up before performing the update. Once the update has been performed, you should modify the web.config file that has been installed so that it becomes consistent with the web.config that you have backed up, and so that it has the changes that had been made to the latter. In order to update the web site, uninstall it by using the “Add or remove programs” tool. After that, install the new version by using its web site installer.

Updating the web services Considerations that are valid for the web.config file of the web site are also valid for the web services’ web.config file. To update the web services, uninstall them by using the “Add or remove programs” tool. After that, install the new version by using its installer.

Updating the client tools To update the client tools (business process modeler, organizational model manager and business process administrator), uninstall them by using the “Add or remove programs” tool. Then, install the new versions by using their installers.

Uninstalling and repairing Q-flow components To uninstall a component of Q-flow, run the corresponding installer and choose the “Remove…” option. For example, to uninstall the business process modeler, you must run the installer of that tool. As the tool is already installed, two options will appear: “Repair Q-flow BPM” and “Remove Q-flow BPM”. Select the second option, and the business process modeler will be uninstalled. The repair option is useful when you wish to correct installation problem. It checks whether all necessary files exist and whether the computer’s setup is correct. For example, if someone has accidentally removed the files of a component that was installed, this option will install the missing files. Alternatively, all components of Q-flow, with the exception of the database, may be uninstalled by using the “Add or remove programs” Windows tool (Start, Control panel, Add or remove programs). For each component, two options are shown: “Change” and “Remove”. The first one behaves as if you had run the component’s installer from the beginning. The second one allows you to directly uninstall the component.


64

To remove the database, use its installer and select the “Remove Q-flow Database” option. Make sure, though, that you back it up before proceeding, unless you have used just for testing and you have not stored important data in it.

Figure 73 Changing or removing one of Q-flow's components

Licensing Q-flow can be used for free if the number of users is less than or equal to 10. Organizations in which more than ten users will use Q-flow must obtain a license in order to be able to use it. This section of the manual explains how to load the license. A license works for a server and for a certain number of users. You must have a license file for the server that hosts the back-end services. You can load the licenses either when installing the backend services or later, by using the License Viewer tool, which is located in the directory where the services were installed (a desktop shortcut is created by the installer).


65

Figure 74Figure 74 shows the main License Viewer.

Figure 74 License Viewer

The screen lists all installed licenses. For each license on the list you will see:

• Type • Organization name • Server name • Number of licensed users (Count) • License expiration date (Due date).

Next to the "Current server" label, the screen shows server where the tool is running. The number to the side of "Enabled users" indicates the number of enabled users, which is the sum of enabled users for all licenses appearing on the list. To add a license, click the “Add” button. This will open a window that allows you to search for the license file (Figure 75Figure 75). Q-flow license filenames have the qlic extension.


66

Figure 75 Loading licenses

Choose the file that corresponds to the license you wish to load and click “Open.” This will add the license to the list and update the number of enabled users (Figure 76Figure 76).

Figure 76 License Viewer with one loaded license for five hundred users


67

Configuration This section explains how to configure Q-flow. The Q-flow configuration data is stored in the System.config file in the Q-flow back-end services installation folder. Q-flow provides a configuration tool to make it simpler to modify this file. Not all changes to the System.config file can be performed by using this tool. For example, in order to specify extended properties for the elements of the organizational model or attachment properties, you must manually modify the System.config file. To run the Q-flow configuration tool, run the file ConfigurationEditor.exe. As a general rule, after performin changes with the configuration tool, you must restart those backend services whose parameters have been modified, so that the changes take effect.

Configuration tool Figure 77Figure 77 shows the Q-flow configuration tool screen. The screen is divided in two:

• The parameter tree: on the left side. • The editing panel: on the right side. It is blank in the figure. Whenever a user clicks on one of

the elements that appear in the parameter tree, the editing panel shows the information of the selected element, and allows it to be modified.

Figure 77 Configuration tool


68

Parameter Tree options The parameter tree is divided into three parts:

• Parameters: shows the Q-flow installation parameters. • Database Configuration • Notification senders: Q-flow mail services configuration.

Parameters Each parameter has an identifying key (a name) and a value. The value’s format depends on the parameter. To add a parameter: 1. Right click on the "Parameters" element in the parameter tree. This causes Q-flow to open a menu. 2. In the window that Q-flow has just opened, select the option "Add new parameter". This causes the editing panel to show the parameter’s two properties so that you can edit them: Parameter key (key) and Parameter value (value). 3. Enter the Parameter key and value. To see a list of available parameters, see the “Q-flow parameter reference” section. 4. Click "Save".

Figure 78 Creating a parameter


69

To modify a parameter: 1. Select the parameter in the parameter tree. This causes Q-flow to show the parameters’ properties in the editing panel. 2. Modify the value of the parameter. 3. Click "Save". To delete a parameter: 1. Right click on "Parameters" in the parameter tree. This causes Q-flow to open a menu. 2. Select "Delete".

Database configuration To modify the database configuration, select "Database configuration" on the parameter tree. This causes the editing panel to show the database configuration properties (Figure 79Figure 79).

Figure 79 Database configuration

The database configuration properties are the following:

• Database properties: o Provider type: database provider. Can be SQL Server or Oracle. o Server name: name of the server that hosts the database.


70

o Database name: name of the Q-flow database. • Authentication properties:

o Integrated Security: if this option is checked, Q-flow connects to the database with integrated security (Windows user).

o User name: if the "Integrated Security" option is not checked, this property indicates the user name Q-flow must use to connect to the database.

o Password: if the option "Integrated Security" is not checked, this property indicates the password Q-flow must use to connect to the database with the user name entered in "User name".

• Connection properties: o Timeout: database connection timeout in seconds.

Notification senders The notification senders’ configuration section allows you to specify which notification services will be used by Q-flow to send mail messages. Q-flow can use three types of service:

• SMTP: mail SMTP • Simple MAPI: simple MAPI mail (Exchange). Does not allow sending HTML formatted

messages. • Extended MAPI: MAPI mail service which makes it possible to send HTML formatted

messages. The three services can co-exist and, and it is possible to have more than one service of each type. To add a service: 1. Right click on "Notification senders" in the parameter tree. This causes Q-flow to show a menu. 2. In the menu, select "Add new notification sender". This will open a submenu with three possible types: SMTP, Simple MAPI and Extended MAPI. To modify a service, select the service you want to modify in the parameter tree. This causes Q-flow to show the properties in the editing panel. No matter what their type, all the services have the following properties:

• General sender properties o Sender Type: type of service. o Sender Name: a descriptive name. This name is used to identify the service in the

parameter tree. o Queue Path: location of the mail queue. Example: FormatName:DIRECT=OS:nbk-

pberton\private$\message_to_smtp In addition, each service has its own particular properties which are explained below. To delete a service: 1. Right click on the service you wish to erase. This causes Q-flow to show a menu. 2. Select "Delete" on the menu.


71

Proper t ies of SMTP serv ices

SMTP services have the following properties:

• SMTP server properties o Host: SMTP server name o Port: (Optional): if the server does not use the default port, this property allows you to

specify another port. o Timeout: (Optional): allows you to specify a timeout value in seconds. o SMTP User Name: (Optional): allows you to specify a user for the service. o SMTP Password: (Optional): password for the specified user. o System User Name: The name that will appear as sender in messages sent by Q-flow. o System E-mail: system e-mail address. The address from which Q-flow sends

messages. Proper t ies of S imple and Extended MAPI

• MAPI Profile o Server Name: Exchange server name. o Mailbox: the mail box to be used by Q-flow. o Message Class: by default, IPM.Note.Qflow. o Profile Name: the profile name to be used by Q-flow. It is optional in the case Extended

MAPI. o Profile Password

Organizational model elements’ extended properties This section explains how to define extended properties for nodes, groups and users. Extended properties are additional properties that complement those which are already included in Q-flow. It is not necessary to define them beforehand, as they may be created by means of a grid when modifying the properties of an element of the organizational model. However, it is possible to define them in Q-flow’s configuration file, so that they exist for all elements of a given type and appear in the organizational model manager’s user interface in a more friendly and natural way. If you want more information about extended properties and the advantages of defining them through configuration, see the organizational model manager manual.

Configurating extended properties To define extended properties, you must modify Q-flow’s System.config file. This file can be found in the backend services installation folder (default is C:\Program Files\Urudata\Q-flow Backend services). This file contains a section called “SecurityMemberProperties”). This sections is divided into three parts (nodes, Figure 80):

• NodeProperties: defines extended properties of nodes. • GroupProperties: defines extended properties of groups. • UserProperties: defines extended properties of users.


72

Figure 80 Configuration of extended properties

To define an extended property, create a “Property” node inside the node corresponding to the type of element to which you wish to add a property. For example, if you wish to add a property to the nodes, create a “Property” node inside the “NodeProperties” node. The “Property” node contains three attributes.

• key: property identifier. It is also used to access the property’s value by means of programming code (for example, in a code step).

• text: this is the property’s name. It is the text that will be shown in the organizational model manager in order to identify the property in a user-friendly way.

• type: this is a .Net Framework type. Possible types are: o Sytem.String (text) o System.Int32 (integer) o System.DateTime (date) o System.Boolean (binary value: True or False).

A “Property” node, therefore, has the following format: <Property key=”key” text=”text” type=”type” /> Example

If you wish to add the “Address”, “Age”, “Birthdate” and “Is adult” to all users, section “SecurityMemberProperties” must be modified so that it resembles the one shown in Figure 81 (there are no properties defined for groups or nodes in the figure, but there could be). Figure 82 shows the appearance of the “Properties” tab of a user’s editing window in the organizational model manager when the System.config file has been configured as shown in Figure 81.

Figure 81 Configuring extended properties of users


73

Figure 82 A user's extended properties

Properties of attachments Q-flow makes it possible to define a set of properties for attachments. The properties of an attachment can be viewed and modified in the web site, if the attachment scope allows it (for information on attachment scope, see the section about attachment scope in the business process modeler manual; for information on viewing and modifying the properties of an attachment, see the web site manual).

Configuring the properties of attachments To define the properties of attachments, you must modify Q-flow’s System.config file, which is in the backend services installation folder (by default, C:\Program files\Urudata\Q-flow Backend services). This file has a section named “AttachmentProperties”. To define a new property, create a new “Property” node inside the “AttachmentProperties” node. The “Property” node has three attributes.

• key: this is the identifier of the property. It is also used to access the value of the property through programming code (for example, in the code of a code step).


74

• text: this is the name of the property. This is the text that is shown in the web site to identify the property in a user friendly way.

• type: this is the type of the property. It is a .Net framework type. Possible types are: o System.String (text) o System.Int32 (integer) o System.DateTime (date) o System.Boolean (binary value; either “True” or “False”).

A “Property” node, therefore, has the following format: <Property key = “clave” text = “título” type = “tipo” /> Example

Figure 83 shows the configuration created for three properties:

• “Description”, which is a text (System.String) • “Version”, which is an integer number (System.Int32) • “Publishing date”, which is a date (System.DateTime)

Figure 83 Configuring the properties of attachments

Integration with Q-flow 2.3 Since Q-flow 3.03, Q-flow 3.0 can coexist with Q-flow 2.3 and can be configured so that those users who have pending tasks from Q-flow 2.3 can see these tasks in the Q-flow 3 web site and respond them from there. This makes it easier to migrate from Q-flow 2.3 to Q-flow 3. If this functionality is enabled, tasks from Q-flow 2.3 appear beside those of Q-flow 3.0 in the “My tasks” view of each user’s personal site, as well as in all views of the “My tasks” type that have been defined in the site. The correspondence between users of Q-flow 2.3 and of Q-flow 3 is made by means of their credentials. That is, for a user of Q-flow 3 to be able to see the tasks assigned to hum in Q-flow 2.3, he must use the same Windows user account in both versions of the product. The steps that must be followed so that tasks from Q-flow 2.3 appear in users’ sites are the following: 1. Configuration of the connection to the Q-flow 2.3 database. 2. Installation and startup of Q-flow 2.3 service 3. Configuration of the Q-flow 3 web site backend service


75

Configuring the connection to the Q-flow 2.3 database In order to configure the connection to the Q-flow 2.3 database, follow these steps: 1. Find, in the Q-flow installation folder, the file named Qflow23Integration.config. 2. Open the file. The contents of that file must be similar to the one shown in Figure 84.

Figure 84 Default contents of the Qflow23Integration.config file

3. Modify the file so that the connection to the Q-flow 2.3 database is correctly specified:

a. DataAccess/DataProvider i. “SQLServer2000” if your Q-flow 2.3 database resides in SQL Server 2000. ii. “SQLServer2005” if your Q-flow 2.3 database resides in SQL Server 2005. iii. “Oracle9i” if your Q-flow 2.3 database resides in an Oracle server.

b. DataAccess/Server/Name: name of the server where the Q-flow 2.3 database resides. c. DataAccess/Server/Database: the name of the database, which is always “Qflow”. d. DataAccess/Authentication/IntegratedSecurity: “True” (integrated security is

recommended). If the database resides in an Oracle server, the value of this parameter must be “False” and the user name and password used in order to establish a connection to the database must be written in the “UserName” and “Password” parameters.

e. DataAccess/Authentication/UserName: useful when using Oracle. Write here the name of the user you will use to establish a connection to the data base.

f. DataAccess/Authentication/Password: password corresponding to the user entered in “UserName”.

g. DataAccess/ConnectionTimeout: connection timeout in seconds.


76

Installation and startup of Q-flow 2.3 service Q-flow 3.03 and more recent versions include a service that accesses the Q-flow 2.3 database in order to obtain a user’s pending tasks and send this information to the web site when required. Thus, if a user that enters the Q-flow 3.0 web site has pending tasks in Q-flow 2.3, he will see tasks from Q-flow 3.0 and from Q-flow 2.3 together. The Q-flow 3.0 backend services installer installs the service’s executable file. However, it does not install the service. Therefore, the service must be manually installed. To do that, follow these steps: 1. Run the Windows command line tool (Start, Run “cmd”). 2. Navigate to the folder where the InstallUtil tool is. This tool is in the

\Windows\Microsoft.NET\Framework\v2.0.xxxxx (xxxxx may vary; the folder can be named, for example, v2.0.50727). Example: run the command “cd C:\Windows\Microsoft.NET\Framework\v2.0.50727\”.

3. Run “InstallUtil” followed by the complete path of the Qflow.Listener.Qflow23Web.exe file. For example, if the Q-flow services have been installed in C:\Program files\Urudata\Q-flow Backend services, you must run the following command:

InstallUtil “C:\Archivos de Programa\Urudata\Q-flow Backend services\Qflow.Listener.Qflow23Web.exe”

4. The execution of that command will cause a dialog window to be opened. In that window, your must

write the user name and password of the account under which the service you are installing will run (this window is the same as the one that appears when installing the other backend services; see Figure 68). In general, this account will the same as the one used to run the other services. Enter the user name and password and click on “Ok”.

5. After that, the installation will go on and will be ready after some seconds.

Figure 85 SDK Command Prompt once installation is over


77

6. To verify that the service has been correctly installed, open the Windows services window and check whether the “Q-flow 2.3 Web integration listener” has been installed.

7. Start the service.

Figure 86 Q-flow 2.3 Web Integration listener

Configuration of the Q-flow 3 web site backend service Finally, it is necessary to indicate the web site backend service that, when a user requests to see his tasks, he should be shown tasks from Q-flow 2.3 beside those of Q-flow 3. In order to do that, the value of the “EnableQflow23MyTasks” installation parameter must be set to “True”. The value of the “Qflow23ResponseLink” parameter must be modified too. This parameter specifies, given a Q-flow 2.3, which URL must be accessed in order to respond to it. It has the following form: http://<web server>/Qflow/Responder.asp?Flowid={0}&stepid={1}&toid={2}&magicnumber={3} By default, <web server>, which indicates the name of the server that hosts Q-flow 2.3’s web access, is “localhost”. Replace it with the name of the server where Q-flow 2.3’s web access runs. For example, if Q-flow 2.3’s web access is in a server called “Qflow23WebServer”, the value of the “Qflow23ResponseLink” parameter must be: http://Qflow23WebServer/Qflow/Responder.asp?Flowid={0}&stepid={1}&toid={2}&magicnumber={3} Once the parameters have been modified, restart the Q-flow web site backend service.


78

Q-flow parameter reference This section lists all Q-flow installation parameters, explains their purpose and what values they may take. Parameter key Description

ActionLink

Is the URL that action links will use in messages sent by e-mail. It has the following form: "http://<Q-flow site URL>/TaskAction.aspx?FlowID={0}&FlowStepID={1}&FlowStepActionID={2}&FlowStepActionToID={3}&FlowStepActionType={4}".

DefaultDomainNetBiosName Default user domain name. Can be left blank.

EnableQflow23MyTasks

Specifies whether the Q-flow 3 web site must show, in the “My tasks view”, the current user’s pending tasks of Q-flow 2.3 in addition to those of Q-flow 3. Enabling this parameter affects all views of tasks proper to a user (that is “My tasks” and all views of the “My tasks” type in the user’s personal site). This parameter must be set to “true” only after the Q-flow 2.3 integration service has been installed and the connection to the Q-flow 2.3 database has been configured (see Integration with Q-flow 2.3 )

EncryptAttachments

If the value of this parameter is “true”, Q-flow will encrypt the contents of attachments, so that the only way of accessing their contents is by means of Q-flow’s permissions. Not even the database administrator will be able to see the contents of the files stored in the database, unless he has permissions to do it through Q-flow. If this parameter is enabled, it is not possible to perform full-text searches using within the contents of attachments.

EngineNewsDBPeekPeriod Checking period for expirations and alerts

EngineNewsMessageQueuePath Message queue used by the engine to process flows

MaxBAVarsCacheTimeout Reserved for use by Urudata. Specifies the life time of variables in business actions.

MaxDataSourceItemsPerQuery Indicates the maximum number of records that can be fetched from the database when testing a query made against a data source defined in the business process modeler.

MaxLoopCount It is a number. If a workflow passes through step a number of times greater than that number, it enters a state of error.

MaxPipelineVarsCacheTimeout Reserved for use by Urudata. Specifies the life time of variables in the pipeline.

NotificactionMessageQueuePath Message queue for notification processing.

OrganizationName Specifies the organization’s name. This name is used by Q-flow to control product licenses. A license is valid only for a particular organization.


79

Qflow23ResponseLink

It is the URL that will be used to construct links to Q-flow 2.3 task response forms when integration with Q-flow 2.3 is enabled. It has the following form: http://<web-server>/Qflow/Responder.asp?Flowid={0}&stepid={1}&toid={2}&magicnumber={3}, where <web-server> is the name of the server hosting the Q-flow 2.3 web site.

ResponseLink

Is the URL used by links to response forms of messages sent by e- mail. It has the following form: "http://<Q-flow site URL>/TaskResponse.aspx?FlowID={0}&FlowStepID={1}&FlowStepToID={2}".

SessionLeaseTime Time that a Q-flow user session lasts. If there is no activity during this time, the user session expires and the user has to be authenticated again.

Documents

Q-flow 3.0: Installation and Configuration