COLECTICA Colectica Workflow Deployment As of 4.1.3192
COLECTICA WORKFLOW DEPLOYMENT This document provides detailed instructions for deploying the Colectica Workflow Service and Web Application. CONTENTS... 2... 3 Database Options... 3 Authentication Options... 3 Step 1. DNS... 3 Step 2. Database... 3 Step 3. Dependencies... 3 Step 4. Deploy Site Binaries... 4 Step 5. IIS Configuration... 4 Step 6. Workflow Website Config Files... 5 Step 7. Install and Configure the Workflow Service... 6 Step 8. (Optional) Install and Configure the Workflow Preview Portal... 6 Step 9. System Configuration... 7 Step 10. Test... 7 2
COLECTICA WORKFLOW DEPLOYMENT This chapter provides detailed instructions for deploying Colectica Repository. DATABASE OPTIONS Colectica Repository is tested to work with the following databases: Microsoft SQL Server 2008 R2 Microsoft SQL Server Express 2008 R2 PostgreSQL version 9 or higher AUTHENTICATION OPTIONS Colectica Repository can use the following authentication mechanisms: Built-in Colectica authentication ActiveDirectory STEP 1. DNS Create a DNS record for the hostname you would like to use to access Colectica Workflow. STEP 2. DATABASE Database files are installed with the workflow service installer. Run the installer to install the service, the default location is C:\Program Files (x86)\colectica\colectica Workflow Service SQL Server 1. Connect to your SQL Server 2. Create a database named colectica_workflow 3. Run the SQL commands in Data\colectica_workflow.sqlserver.sql of the Colectica Workflow Service package 4. Give the LocalService account, or the user account that will run the workflow service, access to the colectica_workflow database. 5. Give the LocalService account, or the user account that will run the workflow service, access to all colectica repository databases you wish to configure. PostgreSQL 1. Connect to your PostgreSQL server 2. Create a database named colectica 3. Run the SQL commands in Data\colectica_workflow.postgresql.sql of the Colectica Colectica Workflow Service package STEP 3. DEPENDENCIES 1. Install.NET 3.5.1 features 2. Install.NET 4.0 Framework (the full version) a. http://www.microsoft.com/download/en/details.aspx?id=17718 3. Install MVC 3 (for Colectica Web) 3
a. http://www.microsoft.com/download/en/details.aspx?id=1491 4. Install the IIS Server Role on Windows Server Web Server. Include the following options. a. Web Server i. Common HTTP Features ii. Static Content iii. Default Document iv. Directory Browsing v. HTTP Errors vi. HTTP Redirection b. Application Development i. ASP.NET ii..net Extensibility iii. ISAPI Extensions iv. ISAPI Filters c. Health and Diagnostics i. HTTP Logging ii. Request Monitor d. Security i. Basic Authentication, ii. Windows Authentication, iii. Digest Authentication, iv. Client Certificate Mapping Authentication, v. IIS Client Certificate Mapping Authentication, vi. URL Authorization, vii. Request Filtering, viii. IP and Domain Restrictions e. Performance i. Static Content Compression ii. Dynamic Content Compression f. Management Tools i. IIS Management Console STEP 4. DEPLOY SITE BINARIES 1. Extract the ColecticaWorkflowWeb/ directory to a location where IIS can access it. STEP 5. IIS CONFIGURATION Create Site for Colectica Workflow 1. In IIS, choose your machine and select Add Web Site a. Site Name: ColecticaWorkflow b. Physical path: The location where you extracted the ColecticaWorkflow/ directory c. Binding: http d. Hostname: your desired hostname 4
2. In the newly created Application Pool, make sure the.net Framework Version is set to 4.0 3. Right click the new web site, choose Manage Web Site Advanced Settings a. Set Enabled Protocols to http STEP 6. WORKFLOW WEBSITE CONFIG FILES Configure Workflow Website 1 - Update database connection strings 1.1 - Located in the Config directory, named Workflow.ConnectionStrings.<databaseType>.config 1.2 - Create a connection string for each Colectica Repository that should be accessible by the system. a. Use the convention hostname:port to name the connection strings that point to source Colectica databases. b. Use a friendly name for connection strings to the target Colectica databases 2 - In the web.config, include the appropriate database connection string config file. <connectionstrings configsource="config\workflow.connectionstrings.sqlserver.config" /> 3 - In the web.config, Add the connection string names that are targets for publication to the TargetConnectionStringNames setting list. <setting name="targetconnectionstringnames" serializeas="xml"> <value> <ArrayOfString xmlns:xsi=http://www.w3.org/2001/xmlschema-instance xmlns:xsd="http://www.w3.org/2001/xmlschema"> <string>colecticarepositorypublic</string> </ArrayOfString> </value> 4 - In the web.config, Add the connection string names that are sources for publication to the SourceConnectionStringNames setting list, these are named in the form of hostname:port. <setting name="sourceconnectionstringnames" serializeas="xml"> <value> <ArrayOfString xmlns:xsi=http://www.w3.org/2001/xmlschema-instance xmlns:xsd="http://www.w3.org/2001/xmlschema"> <string>localhost:19893</string> </ArrayOfString> </value> 5 - If using a Colectica Portal for workflow preview, add the URL to the base of the Preview Portal installation. <setting name="portalpreviewuri" serializeas="string"> <value>http://localhost:1942/</value> 5
6 In the Config Directory, edit the Repository.Settings.config to configure Colectica Administrators for the Workflow Website. Add groups names that should have access to the Workflow Admin area and the ability to Designate Assigners. 7 As a ColecticaAdmin user, open the workflow web site Admin Area and configure Email server information. If the SMTP username and password is left blank, default credentials (Active Directory) will be used. STEP 7. INSTALL AND CONFIGURE THE WORKFLOW SERVICE Install Workflow Service 1 Run the Workflow Service Installer. It will be installed in C:\Program Files (x86)\colectica\colectica Workflow Service by default. Update Workflow Service Config files 2 - Update the Algenta.Colectica.Workflow.Service.exe.config file 2.1 - Create a connection string to the colectica_workflow database named ColecticaWorkflow <add name="colecticaworkflow" connectionstring="server=.; Initial Catalog=colectica_workflow; Integrated Security=SSPI;" providername="system.data.sqlclient"/> 2.2 - Copy all connection strings created in 5.1.2 for source and target repositories to the connection strings of the Workflow Service 3 - Install the workflow service using the install.bat file provided with the installation. Run this as an Administrator. 4 - Open the Services from the Administrative Tools. Start the Colectica Workflow Service STEP 8. (OPTIONAL) INSTALL AND CONFIGURE THE WORKFLOW PREVIEW PORTAL Preview Portal 1 Choose a Physical Path location for preview databases to be stored. By default this is c:\colectica\workflowpreviewdatabases\. All Workflow related software will need access to this path, installing on the same machine is a simple solution. 1.1 Add file permissions to the User Account that runs the Colectica Workflow Service, Colectica Preview Portal, and Colectica Workflow Website read and write access to this physical path. 2 Install Colectica Portal. Use the Colectica Portal installation instructions. You can skip database and connection string configuration. This will be the Colectica Preview Portal for the workflow service to use. 3 Edit the Config\Portal.Settings.config of the new installation 3.1 Change Portal to Preview Mode 6
<setting name="isworkflowpreview" serializeas="string"> <value>true</value> 3.2 Configure the Preview database Physical Path <setting name="workflowpreviewfilepath" serializeas="string"> <value>c:\colectica\workflowpreviewdatabases\</value> 4 As an ColecticaAdmin user, open the Workflow Website Admin area, enable preview and specify the Physical Path for preview databases. STEP 9. SYSTEM CONFIGURATION Miscellaneous 1. Add appropriate ports to any inbound firewall configurations STEP 10. TEST 1. Make sure you can start the Workflow Service. The Service s log will appear in C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\Algenta\Colectica\Logs a. Be sure there are no reported errors once you start the service. 2. Make sure you can connect to Colectica Workflow Web. 7