Installation Guide Genesis Edition for SharePoint 2010 Genesis for SharePoint 2010 Document Revision r5.0.15 October 2014
Contents 2 Contents Preface...4 Disclaimer of Warranty...4 Copyright...4 Trademarks...4 Government Rights Legend... 4 Virus-free software policy...4 Document Revision Numbers...4 AgilePoint Documentation in PDF and HTML... 5 Opening the Documentation Library... 5 Finding Information in the Documentation Library...6 Downloading Files and Sharing Links from the Documentation Library... 6 Contacting AgilePoint Sales...7 Contacting Customer Support...7 Installation Guide: Genesis Edition for SharePoint 2010...8 Installing AgilePoint Genesis Edition for SharePoint 2010... 9... 9 Installing AgilePoint Server... 9 Installing AgilePoint Server, Genesis Edition... 9 Setting Firewall Rules to Open AgilePoint Server Ports... 14 Verify the AgilePoint Server Installation...15 Check the AgilePoint Monitor Service in Windows Service Mode... 16 Troubleshooting AgilePoint Server Installation...16 Installing AgilePoint Envision, Genesis Edition...26 Installing AgilePoint SharePoint Integration... 27 Installing SharePoint Integration, Genesis Edition... 28 Manual SharePoint Installation...32 Verify the Installation was Successful...46 Add the AgilePoint Web Parts to SharePoint... 46 Installing AgileReports...47 Install AgileReports, Genesis Edition... 47 Configure AgileReports...49 Using AgileReports for the First Time...51 Installing AgilePoint Data Services... 51 Install AgilePoint Data Services in Windows Service Mode...51 Setting Up AgilePoint Data Services...52 Activating AgilePoint Licenses... 56 Activating Over the Internet... 56 Activating Manually...56
Contents 3 Uninstalling AgilePoint BPMS... 58 Uninstall AgilePoint Server...58 Uninstall Clustering Server Manager... 58 Uninstall AgilePoint Enterprise Manager...59 Uninstall AgilePoint Envision...59 Uninstall AgilePoint Developer... 59 Uninstall AgilePoint InfoPath Integration...60 Uninstall AgilePoint Microsoft Office Client Integration...60 Uninstall AgilePoint Outlook Integration...60 Uninstall AgilePoint SharePoint Integration v1... 61 Uninstall AgilePoint SharePoint Integration v2... 62 Uninstall AgilePoint Data Services...63 Uninstall AgileReports... 63 Uninstall AgilePoint One Click Deployment... 63
Preface 4 Preface Disclaimer of Warranty AgilePoint, Inc. makes no representations or warranties, either express or implied, by or with respect to anything in this document, and shall not be liable for any implied warranties of merchantability or fitness for a particular purpose or for any indirect, special or consequential damages. Copyright Copyright 2013 AgilePoint, Inc. All rights reserved. Trademarks AgilePoint, Inc. and AgilePoint's products are trademarks of AgilePoint Inc. References to other companies and their products use trademarks owned by the respective companies and are for reference purpose only. Government Rights Legend Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the applicable license agreement and as provided in DFARS 227.7202-1(a) and 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (Oct 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14, as applicable. Virus-free software policy AgilePoint recognizes that viruses are a significant security consideration for our customers. To date, we have had no report of AgilePoint BPMS carries any virus. AgilePoint takes the following measures to ensure our software is free of viruses upon delivery: AgilePoint is built on top of Microsoft.NET framework. The pre-compiled executable is a.net Common Language Runtime (CLR) application, not a native machine binary. As far as is known at this time, there are no viruses that infect.net CLR executables. The virtual environment for the product packaging process in is fully isolated and protected, and anti-virus software is installed and running during packaging. The deliverable package is scanned by anti-virus software before upload to our customer download site. Document Revision Numbers AgilePoint documentation uses the revision number format rx.y.z. The letters and numbers in this revision number can be interpreted as follows:
Preface 5 r - Indicates "revision." This helps to differentiate the document version numbers, which start with v. X - The major version number for AgilePoint BPMS to which this document refers. For example, AgilePoint releases 5.0, 5.0 SP1, and 5.5 would all have an X value of 5. Y - The major document revision number. This number typically changes only when either there is a new AgilePoint release, or there are major changes to the document. Z - The minor document revision number. This number is incremented each time the document is republished. AgilePoint Documentation in PDF and HTML AgilePoint documentation is provided in both print-friendly (PDF) and web-based (HTML) formats. Advantages of HTML Documentation HTML is the primary delivery format for AgilePoint documentation. Unified, global search across all documentation. PDF documents allow you to search only within the context of a given PDF file. All hyperlinks supported. Links in PDFs are only supported in certain contexts. "One-stop shopping" for all information related to AgilePoint BPMS. The HTML documentation is updated more frequently than the PDF documentation. Web-based documentation is updated periodically between AgilePoint releases to address errors and omissions, but the PDF documentation is updated only at the time of a software release. Advantages of PDF Documentation PDFs can be more easily printed, archived, and transferred (such as by FTP or email) than HTML documentation. For more information, refer to Downloading Files and Sharing Links from the Documentation Library in the Documentation Library. Opening the Documentation Library To open the AgilePoint Documentation Library, do the following. You must have a valid account on the AgilePoint Support Portal. Instructions 1. Log on to the AgilePoint Support Portal. 2. Click Documentation. 3. On the Documentation page, click the documentation library for your AgilePoint release. For AgilePoint BPMS v5.0 SP1 and higher, the web-based documentation library opens in a new tab or window in your web browser.
Preface 6 For releases prior to v5.0 SP1, a download starts for a Zip file with the PDF documentation for your release. Finding Information in the Documentation Library The information in this topic will help you to locate information in the AgilePoint Documentation Library. Using the Table of Contents The table of contents in the AgilePoint Documentation Library is divided by content areas. For example, the Installation section includes all the information you need to install AgilePoint BPMS. The AgilePoint API section includes information about the AgilePoint APIs. You can use the Table of Contents to explore the AgilePoint documentation content and find the information you want. Searching The web-based documentation includes a centralized search for all documentation content. To search for information: 1. In the AgilePoint Documentation Library, click the Search tab. In the Search box, enter 1 search team, and click Search. The search results display in alphabetical order by topic title. It is important to understand that the third-party software AgilePoint uses to generate web-based documentation allows only 1 search term. More than 1 search term will cause the search to fail. AgilePoint recommends using a relatively unique search term to find the information you need. For example, entering a common term, such as "process," will return a high percentage of the total documentation topics in the search results. 2. Browse the list of topic titles to find the information you want. Printing The PDF documentation is provided mainly for the purpose of printing and archiving. To print a set of information: 1. Navigate to the main page of the Documentation Library from which you want to print. 2. In the list of documents, click the document name in the PDF column. 3. From your PDF reader software, print the portion of the document you want. Downloading Files and Sharing Links from the Documentation Library You can download and share files AgilePoint's documentation library as you would in any other web page. Note that if you send links to recipients, they must have a Support Portal login to view the file. These procedures are common examples based on Internet Explorer with the Adobe Reader plug-in. Exact procedures may vary depending on your web browser, PDF viewer, and email client configuration.
Preface 7 Share a Link to an HTML Topic 1. Navigate to the topic you want to share. 2. Copy the URL in the Location box in your web browser. 3. Paste the URL in an email, IM client, etc. Share a Link to a PDF Document 1. In Internet Explorer, navigate to the Documentation Library home page. 2. In the PDF column, right-click the name of the PDF file you want to share. 3. In the quick menu, click Copy shortcut. 4. Paste the URL in an email, IM client, etc. Save a Copy of a PDF Document 1. In Internet Explorer, open the Documentation Library home page. 2. In the PDF column, click the name of the PDF file you want to share. 3. In the Adobe Reader plug-in, click Save button. Contacting AgilePoint Sales AgilePoint is a leading Business Process Management System (BPMS) provider created by a team of driven people who strive to incorporate the principles of relentless innovation for the benefit of our customers. Our mission is to help companies of any size attain and sustain operational success through process excellence. Headquarters: AgilePoint Corporation 1916C Old Middlefield Way Mountain View, CA 94043, USA Tel: (650) 968-6789 Fax: (650) 968-6785 Email: info@agilepoint.com Web site: www.agilepoint.com International: For AgilePoint EMEA and AgilePoint Asia Pacific, please call the AgilePoint Corporate Office for contact information. Contacting Customer Support To contact AgilePoint Support, please submit a ticket on the AgilePoint Support Portal: http:// support.agilepoint.com/supportportal/ If you do not have a Support Portal account, you can send an email to request one: support@agilepoint.com
Installation Guide: Genesis Edition for SharePoint 2010 8 Installation Guide: Genesis Edition for SharePoint 2010 This document provides instructions for installing and configuring AgilePoint BPMS with the following conditions: AgilePoint BPMS Genesis Edition for SharePoint 2010 Note: It is important to understand that this document is provided in multiple versions. The guide that is appropriate to you depends upon your environment. To complete your installation, you must select the correct installation document from the list. Note: In most cases, AgilePoint recommends using HTML documentation because it is much easier to search all the AgilePoint documentation for the information you want. However, the Installation Guides have been designed specifically to exclude information that is not relevant to your installation scenario. Therefore, AgilePoint strongly recommends you use the PDF versions of the Installation Guides. AgilePoint BPMS Genesis Edition The installation instructions for AgilePoint BPMS Genesis Edition depend upon your version of SharePoint: Document Variant AgilePoint AgilePoint Genesis for SharePoint 2013 AgilePoint BPMS for Azure AgilePoint BPMS for Azure supports only one installation scenario, which is detailed in the following document: Document Variant AgilePoint BPMS for Azure AgilePoint BPMS Standard or Enterprise Edition for.net 3.5 The complete list of AgilePoint BPMS installation instructions for Standard and Enterprise Edition are divided according to the conditions in the following table. Document Variant NLB or Single Server? IIS or Windows Service Mode? Not Available NLB IIS Configuration C NLB Windows Service Not Available Single Server IIS Configuration G Single Server Windows Service
Installing AgilePoint Genesis Edition for SharePoint 2010 9 Installing AgilePoint Genesis Edition for SharePoint 2010 This section provides instructions for installing the software components for AgilePoint BPMS Genesis Edition for SharePoint 2010. Note: This is only one of a number of possible installation scenarios, which vary based on your AgilePoint BPMS edition and your environment. For more information, refer to Installation Guide. Before installing the AgilePoint system, you must comply with the following prerequisites. New Installations Only This section assumes that you are installing each component of the AgilePoint BPMS Suite on a computer that does not have any version of that component already installed. If you do already have any version of a component installed on the target computer, see Upgrade Guide. Pre-Installation Complete Before installing any of the components of the AgilePoint BPMS Suite, please ensure you have read and completed the checklist items in the AgilePoint Pre-Installation Guide, this is a requirement and will ensure a successful installation. For more information, refer to Pre-Installation in the Documentation Library. Local Installation Files Before installing any AgilePoint component, ensure the installation files are located on one of the machine's local drives. If you attempt to run the installation directly from a network, the installation may fail. If you do attempt to install when the installation file(s) are located on a network drive (or some other remote location), the setup application may fail to run with an error message similar to the following: "An exception 'System.Security.Policy.PolicyException' has occurred in Setup." Installing AgilePoint Server Use the procedures in this section to set up an AgilePoint Server machine for your environment. This section provides instructions for installing and configuring all the core components on the AgilePoint Server machine. Installing AgilePoint Server, Genesis Edition To install AgilePoint Server for AgilePoint BPMS Genesis Edition, do the following.
Installing AgilePoint Genesis Edition for SharePoint 2010 10 Your system meets the minimum system requirements for this component. For more information, see the System Requirements Guide. You have completed all of the pre-installation instructions for this component. Login to Windows using a user login that belongs to the local system's Administrators group. Note: On some versions of Windows, such as Windows Server 2012, you may need to also rightclick the Setup.exe installation file, and click Run as Administrator. Download the AgilePoint Installation Package for your solution to your local machine. How to Start 1. Open the AgilePoint installation package. 2. On the Software License Agreement window, review the license agreement, and click Accept. 3. On the Destination Folder window, select the folder where you want to extract the installation files. 4. Click Install. 5. On the Welcome window, create your custom Preparing for Installation guide, if required. 1. On the AgilePoint installer, click Install AgilePoint. 2. Click AgilePoint Server. 3. On the Welcome window, click Next. 4. On the License Agreement window: a. Review the license agreement. b. Click I accept the terms of the license agreement. c. Click Next. 5. On the Verify Manual window, review the items on the screen, and complete any required tasks. For more information, see the Pre-Installation guide. 6. Click Next. 7. On the Verify Installation Requirements window: If there are any errors, correct them. Once you have resolved the issue, click Recheck. Issue Supported Operating system is installed IIS is available Resolution Install a supported operating system on this machine. For more information, refer to AgilePoint Server Requirements. Install and/or start IIS 6 or higher.
Installing AgilePoint Genesis Edition for SharePoint 2010 11 Issue IIS 6 Management Compatibility Role Service is active Supported.NET Framework installed Current user has administrator privilege User Account Control (UAC) is turned off Windows Identify Foundation is installed Resolution Activate Management Compatibility Role Service on IIS 6 or higher. For more information, refer to Verifying the IIS 6 Management Compatibility Role Service. Install the.net Framework version that is supported for your installation. For more information, refer to AgilePoint Server Requirements. Log on to this machine as a user with administrator privileges. Turn user access control (UAC) off. For more information, refer to Turning Off User Account Control (UAC). Install Windows Identity Foundation on this machine. For more information, refer to Windows Identity Foundation on the Microsoft Download Center. If there are no errors, click Next. 8. On the AgilePoint Server Installation window, complete the following fields: Field Name Install location Name Organization License Key Definition The folder where you want to install the AgilePoint component. Your first and last name. The name of your organization, or company. Your AgilePoint Server license key. 9. Click Next. 10. Once the installation completes, click Next. 11. On the Server Configuration screen, enter the credentials for your AgilePoint Service account. Field Name Username Definition Specifies the user name for your AgilePoint service account. This account serves as your AgilePoint service account, your AgilePoint
Installing AgilePoint Genesis Edition for SharePoint 2010 12 Field Name Definition administrator account, and the account that AgilePoint uses to communicate with SharePoint. This account must be set up before entering the account information here. The AgilePoint installer cannot create this account for you. A valid user name for an account with the required privileges detailed in Setting Up the AgilePoint Service Account. Domain The authentication domain for the AgilePoint service account. A valid domain. Password The password for the AgilePoint service account. A valid password. 12. On the Server Configuration screen, enter the following information for your SMTP email server. Field Name SMTP Server Definition The URL for your SMTP email server. A valid SMTP server URL. Administrator Email The email address for your SMTP server administrator. This email address will be used to send email notifications to participants in AgilePoint processes. You can change this email address after installation if desired. A valid SMTP server administrator email address. 13. On the Server Connections screen, enter the following information for your AgilePoint database.
Installing AgilePoint Genesis Edition for SharePoint 2010 13 Once you enter the Database Server, click the Retrieve database name button to populate the names of the databases on your database server. Field Name Database Server Definition Specifies the server name and domain for the AgilePoint workflow database. A valid database server name (or service name in Oracle) Example: mydatabase mydatabase/sharepoint Database Name Specifies the name of your AgilePoint workflow database. A valid database name. 14. On the Server Connections screen, if desired you can change the port numbers AgilePoint Server uses to communicate using various protocols. The default port numbers are verified as available for your system. Note: Once the installation is complete, you will need to create a firewall rule to allow AgilePoint Server to open these ports. Field Name WSHttp Port Definition A free, unique port AgilePoint Server can use for WSHttp binding. This field is required. Specifies a valid WSHttpPort number. Default Value: None TCP Port Specifies a free, unique port AgilePoint Server can use for TCP binding.
Installing AgilePoint Genesis Edition for SharePoint 2010 14 Field Name Definition This field is required. A valid TCP port number. Default Value: None BasicHttp Port A free, unique port AgilePoint Server can use for BasicHttp binding. This field is required. 15. Click Next. 16. On the Installation Complete window, click Next. A valid port number. Default Value: 17. On the Completed window, take note of the important information about your environment. You will need this information later. 18. Click Finish. 19. A text file appears with the summary information for your installation. Save this file where you can find it. You will need this information later, especially when you install SharePoint Integration. None Note: If the following message appears, run the Client Utility Tool from the AgilePoint installation program: "Failed to add Service model information in [path]\web.config. Please use SVCClient Utility tool to update it before using." For more information, refer to Run the Windows Service Client Utility Tool. Setting Firewall Rules to Open AgilePoint Server Ports To set up firewall rules for the AgilePoint Server ports, do the following. AgilePoint Server installed on premises in Windows Service mode. This includes most current AgilePoint Server installations, including Genesis Edition. You can find your ports in the AgilePoint Server Manager. 1. On the AgilePoint Server machine, click Start > All Programs > AgilePoint > AgilePoint Server Manager. 1. On your firewall, set up a firewall rule to allow communication for the following AgilePoint Server ports:
Installing AgilePoint Genesis Edition for SharePoint 2010 15 Field Name WSHttp Port Definition A free, unique port AgilePoint Server can use for WSHttp binding. This field is required. Specifies a valid WSHttpPort number. Default Value: None TCP Port Specifies a free, unique port AgilePoint Server can use for TCP binding. This field is required. A valid TCP port number. Default Value: None BasicHttp Port A free, unique port AgilePoint Server can use for BasicHttp binding. This field is required. A valid port number. Default Value: None Verify the AgilePoint Server Installation Windows Service installation is verified by opening Enterprise Manager. In a Windows Service installation, Enterprise Manager is installed in the background along with AgilePoint Server. To verify a Windows Service AgilePoint Service installation, open Enterprise Manager from the AgilePoint Server Manager for the AgilePoint Server instance you want to test. Ensure you can log on to Enterprise Manager successfully without errors. If Enterprise Manager does not open properly, or you cannot log in, please verify the installation steps.
Installing AgilePoint Genesis Edition for SharePoint 2010 16 Check the AgilePoint Monitor Service in Windows Service Mode To ensure the AgilePoint Monitor Service is running properly in a Windows Service environment, do the following. AgilePoint Server installed in Windows Service mode. AgilePoint Server is configured. Verify the pre-installation steps How to Start 1. Click Start > Run, and enter services.msc. 1. In the Services window, ensure the AgilePoint Monitor Service is started. In a Windows Service environment, the name is the name of the service you created in AgilePoint Server Manager. 2. If the service is not started, right-click on the AgilePoint service name, and click Start. Troubleshooting AgilePoint Server Installation This section provides information about some common issues people encounter while installing AgilePoint Server, and help finding information you may need during installation. AgilePoint Server Requirements This section provides information about the minimum system requirements for the AgilePoint Server for AgilePoint BPMS Genesis Edition. The recommended requirements for this component can vary based on the intended usage of the product. The general recommendation for all types of production servers is that they should have as much processing power and memory as possible. Processor (CPU) Memory (RAM) Dual-processor server 4 GB Available Hard Disk Space 150 MB Other Hardware or Devices A network connection NIC 1 GB or higher Operating System One of the following: Microsoft Windows 2003 Server 32 bit Microsoft Windows 2003 Server 64 bit
Installing AgilePoint Genesis Edition for SharePoint 2010 17 Microsoft Windows 2008 Server 32 bit Microsoft Windows 2008 Server 64 bit Microsoft Windows 2008 Server R2 64 bit Locally Installed Software All of the following: Microsoft IIS 6.0 or higher Microsoft IIS 6.0 or higher Microsoft.NET Framework 3.5 SP1 Windows Identify Foundation (WIF). For more information, refer to Windows Identity Foundation on the Microsoft Download Center. Note: There is no Microsoft installer for WIF on Windows XP. Therefore, AgilePoint installs this DLL automatically for Windows XP users only. For all other supported Windows versions, use the official Microsoft installers. Microsoft Windows PowerShell This is used to restart on premises Windows services for AgilePoint for example, AgilePoint Server running in Windows Service mode on premises, or the AgilePoint Service Bus for AgilePoint BPMS for Azure. It is possible to use the Windows command line, but PowerShell is recommended because it provides more sophisticated functionality. For example, it waits for one command to complete before executing the next command. Database This component requires a database installed on a machine with the following minimum requirements. For stability and performance, AgilePoint recommends installing the database on a remote server within the same network domain. However, the database can be installed on the same machine as this component. Other database requirements beyond those listed here are at the discretion of your database administrator. One of the following: Microsoft SQL Server 2005 SP1 Microsoft SQL Server 2008 Microsoft SQL Server 2008 R2 Microsoft SQL Server 2012 Microsoft SQL Server 2014 Oracle 9i, 10g, 11g
Installing AgilePoint Genesis Edition for SharePoint 2010 18 On the AgilePoint Server machine, download and install Oracle Database 11g Client (Release 1 or Release 2) that is appropriate for the system for which you are installing on (i.e. 32 bit or 64 bit). Note: Microsoft SharePoint and AgileForms do not support Oracle database. If you are using SharePoint Integration or AgileForms, AgilePoint strongly recommends using Microsoft SQL Server. Minimum hard disk space 1 GB database 1 GB for archive data and log files Configuring AgilePoint Server Manager Description The AgilePoint Server Manager is a sever management application that enables you to start, stop, add, delete, configure, and manage AgilePoint Server instances in a Windows Service environment.
Installing AgilePoint Genesis Edition for SharePoint 2010 19 How to Start 1. On the AgilePoint Server machine, click Start > All Programs > AgilePoint > AgilePoint Server Manager. Field Definitions Field Name Service Name Definition Specifies the name you want to use to identify the Windows service associated with the AgilePoint Server instance. A single line of text. Default Value:
Installing AgilePoint Genesis Edition for SharePoint 2010 20 Field Name Display Name Definition None Specifies the name you want to display to users to identify the AgilePoint Server instance. A single line of text. Default Value: None Location Specifies the path to the AgilePoint Windows Service instance. A valid absolute file path. Default Value: None WSHttp Port A free, unique port AgilePoint Server can use for WSHttp binding. This field is required. Specifies a valid WSHttpPort number. Default Value: None TCP Port Specifies a free, unique port AgilePoint Server can use for TCP binding. This field is required. A valid TCP port number. Default Value: None BasicHttp Port
Installing AgilePoint Genesis Edition for SharePoint 2010 21 Field Name Definition A free, unique port AgilePoint Server can use for BasicHttp binding. This field is required. A valid port number. Default Value: None Web HTTP Port Specifies a free, unique port AgilePoint Server can use for REST API calls. To Access This Field: Click the Rest Port Information tab. A valid HTTP port number that can be used for REST API calls. Default Value: None Service Factory Binding Opens the Following Window: Global Extended Module Window Purpose of this Window: Specifies the authentication scheme for your REST endpoint. To Access This Field: Click the Rest Port Information tab. Use Secure Connection (SSL) The common name (CN) or domain name or fully qualified domain name associated with your SSL certificate. To Access This Field: Click the SSL Settings tab. An appsettings key in the following format: Selected - SSL encryption is enabled. Deselected - SSL encryption is disabled.
Installing AgilePoint Genesis Edition for SharePoint 2010 22 Field Name Domain Name Definition Default Value: Deselected The common name (CN) or domain name or fully qualified domain name associated with your SSL certificate. To Access This Field: Click the SSL Settings tab. An appsettings key in the following format: A text string representing your common name or domain name. Default Value: None Example: mydomain.com Check Availability of Ports UserName Action: Tests the specified ports to ensure they are free. Specifies the user name for the AgilePoint service account. A valid user name in the format domain\username. Default Value: None Example: MYDOMAIN\APServiceUser Password The password for the authentication account. A valid password. Default Value:
Installing AgilePoint Genesis Edition for SharePoint 2010 23 Field Name Site Definition None Specifies the web site from the list you created for AgilePoint during pre-installation. A valid web site name. Default Value: AgilePointWebsite Virtual Directory Specifies the name you want to use for the virtual directory that contains the files for the Enterprise Manager web application. A valid virtual directory name. The name EnterpriseManager is suggested. Default Value: None Application Pool Specifies the IIS application pool for the Enterprise Manager web application you want to run. A valid application pool. Default Value: AgilePointAppPool Add ( ) Creates a new AgilePoint Windows Service instance. Start ( ) Action: Starts the selected AgilePoint Windows Service instance. Stop ( ) Action: Stops the selected AgilePoint Windows Service instance. Delete ( ) Action:
Installing AgilePoint Genesis Edition for SharePoint 2010 24 Field Name Definition Deletes the selected AgilePoint Windows Service instance. Refresh ( ) Action: Refreshes the selected AgilePoint Windows Service instance. Server Configuration ( ) Action: Opens the AgilePoint Server Configuration window for the selected AgilePoint Windows Service instance. Enterprise Manager ( ) Action: Opens Enterprise Manager for the selected AgilePoint Windows Service instance. Update Action: Saves changes to an AgilePoint Windows Service instance configuration. Creating the AgilePoint Service Account Before you install AgilePoint BPMS, you must create a user account that uses the same domain, user name, and password on AgilePoint Server, SharePoint, and your database. This user account serves the following functions: AgilePoint Server administrator SharePoint administrator Application pool identity for AgilePoint Server Service identity for AgilePoint Server Create and modify AgilePoint databases After installation is complete, you can change the credentials for some of these actions, so they use different accounts. However, for initial setup they must be the same. Most AgilePoint customers choose to keep these accounts the same after installation because it simplifies configuration and maintenance. 1. On the AgilePoint Server machine, create a user account to serve as the AgilePoint service user account. If you are installing AgilePoint Server on a Domain Controller, this cannot be a local administrator account. 2. Once you have created the account on the AgilePoint Server machine, ensure this has the following access: Log on as a service Membership in the following groups: Administrators
Installing AgilePoint Genesis Edition for SharePoint 2010 25 Performance Monitor Users IIS_IUSRS - Windows Server 2008 IIS_WPG - Windows Server 2003 3. On the AgilePoint database, grant the AgilePoint service user account the following privileges: Read Write db_owner - This is only needed to create the database tables during AgilePoint installation. You can remove this privilege once installation is complete. 4. On SharePoint, create a user account with the same domain, user name, and password as the AgilePoint service account. 5. On SharePoint, grant the AgilePoint service user account the following privileges: Site collection administrator for the site collection you want to integrate with AgilePoint BPMS. Verify the IIS 6 Management Compatibility Role Service To Verify the IIS 6 Management Compatibility Role Service, do the following. This is required for all web applications, but needs to be completed only once per machine where the web applications are running. These instructions do not apply to the following installation scenarios: AgilePoint BPMS for Azure Windows Server 2003 Good to Know The instructions in this topic describe the procedure in Windows Server 2008. These instructions vary slightly for Windows Server 2008 and 2012, but the concepts are the same. How to Start 1. On the AgilePoint Server machine, open Windows Server Manager. 1. In Windows Server Manager, click Roles > Add Roles, and select the roles Application Server and Web Server (IIS). 2. Click Roles > Web Server (IIS) > Add Role Services, and ensure the Role Service for IIS 6 Management Compatibility (and its children) is added. Turning Off User Account Control (UAC) To turn off User Account Control (UAC), do the following. This procedure must be completed on the following machines, as applicable for your installation:
Installing AgilePoint Genesis Edition for SharePoint 2010 26 All AgilePoint Server machines. AgileForms Server machine. All AgilePoint Envision machines. All AgilePoint Developer machines. These instructions apply to all installation scenarios. 1. On each machine where an AgilePoint component is installed, turn off UAC. The procedure for this varies based on your version of Windows. As an example, in Windows 7 do the following: a. Click Start > Control Panel > User Accounts > Change User Account Control Settings. b. On the slider, select Never notify, and click OK. 2. Restart the machine. Installing AgilePoint Envision, Genesis Edition To install AgilePoint Envision for AgilePoint BPMS Genesis Edition, do the following. Your system meets the minimum system requirements for this component. For more information, see the System Requirements Guide. You have completed all of the pre-installation instructions for this component. If AgilePoint Server is not installed on the same computer that you will be installing on, it should be installed and running on a server that you can access via the internet from the computer where you are installing. How to Start 1. Open the AgilePoint installation package. 2. On the Software License Agreement window, review the license agreement, and click Accept. 3. On the Destination Folder window, select the folder where you want to extract the installation files. 4. Click Install. 5. On the Welcome window, create your custom Preparing for Installation guide, if required. 1. On the AgilePoint installer, click Install AgilePoint. 2. Click AgilePoint Envision. 3. Click Next in the AgilePoint Envision window. 4. Again, click Next in the AgilePoint Envision window.
Installing AgilePoint Genesis Edition for SharePoint 2010 27 5. Click the I Agree radio button after reading the license agreement. 6. Click Next. 7. On the AgilePoint Envision Installation window, enter the following information: Field Name Install location Name Organization License Key Definition The folder where you want to install the AgilePoint component. Your first and last name. The name of your organization, or company. Your AgilePoint Envision license key. 8. Click Next. 9. Once the installation has completed, click Next. 10. Once the Installation Complete message is displayed, click Finish. 11. Restart the machine. This is optional, but recommended. Rarely AgilePoint users have reported an issue with shortcuts not displaying if the machine is not restarted. There are no other known issues if you do not restart the machine. Windows sometimes prompts to restart, and sometimes not. This is determined by the operating system. 12. To open AgilePoint Envision click Start > Programs > AgilePoint > AgilePoint Envision. Note: The first time you run the application after installing it, you will be prompted to activate it. This step is required. For more information, refer to Activating AgilePoint Licenses. Installing AgilePoint SharePoint Integration This section provides instructions for installing the AgilePoint SharePoint Integration component of the AgilePoint BPMS Suite. The AgilePoint SharePoint Integration v2 consists of three main components: AgilePoint Configuration List Stores the AgilePoint configuration data in a custom list. AgilePoint Process Launcher Associates a SharePoint entity with an AgilePoint process. AgilePoint Web Parts Provides the following specialized Web Parts: The AgilePoint Task List Web Part displays any process tasks assigned to the user viewing the SharePoint site, and provides tools for managing those tasks. The AgilePoint Process Instance List displays all running process instances. You can filter, sort, and group to display the required process instances. The AgilePoint Process Template List displays all process templates deployed on the AgilePoint Server. The AgilePoint ListForm Web Part allows you to use a SharePoint List as the form UI for manual tasks. On SharePoint, the ListForm Web Part operates in the background, managing the display settings
Installing AgilePoint Genesis Edition for SharePoint 2010 28 (show/hide, enable/disable) for ListForms that are defined in an AgilePoint process. The ListForm Web Part is not visible to the end user. Note: If problems occur during the installation of the AgilePoint SharePoint Integration, log files are generated and can be found at [AgilePoint Integration for SharePoint installation folder]\installer.log. Installing SharePoint Integration, Genesis Edition To install SharePoint Integration for AgilePoint BPMS Genesis Edition, do the following. AgilePoint BPMS Genesis Edition environment. AgilePoint Server installed on the AgilePoint Server machine. Your system meets the minimum system requirements for this component. For more information, see the System Requirements Guide. You have completed all of the pre-installation instructions for this component. If you are installing AgilePoint SharePoint Integration in a SharePoint server farm, you must select a SharePoint server you want to designate as the primary AgilePoint integration server. Document your decision. You will need to use the same machine for all AgilePoint SharePoint Integration installations and upgrades. You need only apply installation and upgrade procedures on this one primary server. The SharePoint software will propagate the changes to the other servers in your SharePoint farm. Login to Windows using a user login that belongs to the local system's Administrators group. Note: On some versions of Windows, such as Windows Server 2012, you may need to also rightclick the Setup.exe installation file, and click Run as Administrator. Download the AgilePoint Installation Package for your solution to your local machine. How to Start 1. Open the AgilePoint installation package. 2. On the Software License Agreement window, review the license agreement, and click Accept. 3. On the Destination Folder window, select the folder where you want to extract the installation files. 4. Click Install. 5. On the Welcome window, create your custom Preparing for Installation guide, if required. 1. On the AgilePoint installer, click Install AgilePoint. 2. Click AgilePoint Integration for SharePoint. 3. On the Welcome to AgilePoint Installation window, click Next. 4. Review the license agreement. 5. Click I accept the terms of the license agreement. 6. On the SharePoint Integration Configuration window, enter the following information:
Installing AgilePoint Genesis Edition for SharePoint 2010 29 Field Name AgilePoint Service URL Username Definition Specifies the AgilePoint Service URL for your AgilePoint BPMS environment. For more information, refer to Finding Your AgilePoint Service URL on Premises. Specifies the user name for your AgilePoint service account. This account serves as your AgilePoint service account, your AgilePoint administrator account, and the account that AgilePoint uses to communicate with SharePoint. This account must be set up before entering the account information here. The AgilePoint installer cannot create this account for you. A valid user name for an account with the required privileges detailed in Setting Up the AgilePoint Service Account. Domain The authentication domain for the AgilePoint service account. A valid domain. Password The password for the AgilePoint service account. 7. Click Next. A valid password. 8. On the Verifying System Requirements window: If there are any errors, correct them. Once you have resolved the issue, click Recheck. Issue Microsoft SharePoint Server Microsoft Forms Server Resolution Install and activate Microsoft SharePoint Server. The AgilePoint installation program always checks for this because Microsoft Forms Server is required for InfoPath forms. However, InfoPath support is a paid add-on component that may not
Installing AgilePoint Genesis Edition for SharePoint 2010 30 Issue SharePoint Administration Windows Service SharePoint Timer Windows Service SharePoint Command Line Administration Tool. Resolution be included in your AgilePoint license. If you want to use InfoPath forms, ensure Microsoft Forms Server is up and running. If you are not using InfoPath forms, no action is required. Start the Windows service SharePoint Administration. Start the Windows Service SharePoint Timer. This tool is installed with SharePoint. Reinstall SharePoint. SharePoint Web Application Available Ensure at least one SharePoint web application is created. Ensure the SharePoint web application is up and running. Ensure the SharePoint web site can be browsed in Internet Explorer with no errors Ensure the AgilePoint Service account is a member of the the SharePoint Farm Administrators group, and the SharePoint Farm Administrator account has access to the SharePoint database. To ensure access, run the following PowerShell command on the primary SharePoint machine: Get-SPDatabase Add-SPShellAdmin [domain]\[agilepoint Service Account user name] SharePoint Farm Administrator Permissions Add the SharePoint user (the AgilePoint service account) to the SharePoint Farm Administrators group. This is required only for SharePoint server farms. If there are no errors, click Next. 9. On the AgilePoint Integration for SharePoint Installation window, enter the following information: Field Name Install location Definition The folder where you want to install the AgilePoint component. 10. Click Next. 11. Once the installation has completed, click Next. 12. Select your SharePoint deployment type, and click Next:
Installing AgilePoint Genesis Edition for SharePoint 2010 31 Automatic Deployment - Installs AgilePoint SharePoint Integration with no intervention required from you. This option only applies when SharePoint is installed on a single server with a single web application. If you select this option, a list appears with all the SharePoint web applications on your machine. Select the SharePoint web application where you want to install AgilePoint components. Manual Deployment - Does not install SharePoint. If you have more than one SharePoint web application and/or server, you will need to install SharePoint manually later. For more information, see Manual SharePoint Installation 13. If you deployed SharePoint Integration automatically, a status window appears. When this is complete, click Next. 14. Read the information on the summary window, and click Finish. Finding Your AgilePoint Service URL on Premises To find the URL for your on-premises AgilePoint Service, do the following. AgilePoint Server installed in Windows Service mode on the AgilePoint Server machine. How to Start 1. On the AgilePoint Server machine, click Start > All Programs > AgilePoint > AgilePoint Server Manager. 1. On the AgilePoint Server Manager, click the name of your AgilePoint instance. 2. Find your WsHttp Port. Field Name WSHttp Port Definition A free, unique port AgilePoint Server can use for WSHttp binding. This field is required. Specifies a valid WSHttpPort number. Default Value: None 3. Build your AgilePoint service URL as shown in the following table. Format http://[agilepoint Server host name]:[wshttp Port]/ AgilePointServer
Installing AgilePoint Genesis Edition for SharePoint 2010 32 Example http://myapserverhost:1234/agilepointserver Manual SharePoint Installation Use the instructions in this section to install SharePoint Integration using the PowerShell command line tool. This topic is required for manual SharePoint Integration installation only. If you installed SharePoint Integration automatically, you can skip this topic. Run the SharePoint Integration installer. Log on to the SharePoint machine using a user account that belongs to the local system's Administrators group. Add, Deploy, and Activate the SharePoint Solution Files To install the solution files for AgilePoint BPMS using the SharePoint STSADM command line tool, do the following. This topic is required for manual SharePoint Integration installation only. If you installed SharePoint Integration automatically, you can skip this topic. Run the SharePoint Integration installer. Log on to the SharePoint machine using a user account that belongs to the local system's Administrators group. How to Start 1. Open the stsadm command line tool. SharePoint 2007 - C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\BIN \stsadm.exe SharePoint 2010 - C:\Program Files\Common Files\Microsoft Shared\web server extensions\14\bin \stsadm.exe 1. On the primary SharePoint front-end web server, in the stsadm command line tool, add the solution files to SharePoint. SharePoint Integration for AgilePoint: stsadm o addsolution filename "[AgilePoint SharePoint Integration installation]\ Ascentn.SharePoint.SettingsList.wsp" stsadm o addsolution filename "[AgilePoint SharePoint Integration installation]\ Ascentn.SharePoint.WebParts.wsp" stsadm o addsolution filename "[AgilePoint SharePoint Integration installation]\
Installing AgilePoint Genesis Edition for SharePoint 2010 33 Ascentn.SharePoint.WFIntegration.wsp" stsadm o addsolution filename "[AgilePoint SharePoint Integration installation]\ Ascentn.SharePoint.ListForm.wsp" SharePoint Integration for AgileXRM only: stsadm -o addsolution -filename "[AgilePoint SharePoint Integration installation]\ Ascentn.SharePoint.WebParts_XRM.wsp" This copies the wsp files from the installation folder (The default location is [AgilePoint installation]\agilepoint Integration for SharePoint.) to the home folder of the stsadm tool. You can specify a different path in the command. 2. On the primary SharePoint front-end web server, in the stsadm tool, deploy the solution files to SharePoint. SharePoint Integration for AgilePoint: stsadm -o deploysolution -name ascentn.sharepoint.settingslist.wsp -immediate -allowgacdeployment -url "[Site Collection URL]" stsadm -o deploysolution -name Ascentn.SharePoint.ListForm.wsp -immediate -allowgacdeployment -url "[Site Collection URL]" stsadm -o deploysolution -name Ascentn.SharePoint.WebParts.wsp -immediate -allowgacdeployment -url "[Site Collection URL]" stsadm -o deploysolution -name Ascentn.SharePoint.WFIntegration.wsp -immediate -allowgacdeployment -url "[Site Collection URL]" SharePoint Integration for AgileXRM only: stsadm -o deploysolution -name Ascentn.SharePoint.WebParts_XRM.wsp -immediate allowgacdeployment 3. On each SharePoint machine that is a front-end web server, in the stsadm tool, execute the following command: stsadm o copyappbincontent 4. On the primary SharePoint front-end web server, in the stsadm tool, activate the features. SharePoint Integration for AgilePoint: stsadm -o activatefeature -name Agilepointsettingslistfeature -url "[Site Collection URL]" force stsadm -o activatefeature -name agilepointlistform -url "[Site Collection URL]" -force stsadm -o activatefeature -name agilepointwebparts -url "[Site Collection URL]" -force stsadm -o activatefeature -name agilepointwfintegration -url "[Site Collection URL]" -force Run the Windows Service Client Utility Tool If you are installing an ASP.NET web application in a Windows Service environment, you must run the Windows Service Client Utility Tool to configure the binding with the AgilePoint Server. For most web applications, the AgilePoint installation software attempts to run this utility in the background automatically. However, you must run this utility for SharePoint Integration.
Installing AgilePoint Genesis Edition for SharePoint 2010 34 You are using an ASP.NET web application in an on-premises Windows Service environment. This includes SharePoint or AgileForms. Create a backup copy of the configuration file for the application you are configuring before using this utility. If you are using SharePoint or AgileForms Server on a machine that is not the AgilePoint Server machine (typically the case), copy the web.config file from the SharePoint or AgileForms machine to AgilePoint Server machine. The following are the default locations of the target web.config files: SharePoint - c:\inetpub\wwwroot\wss\virtualdirectories\[port number] AgileForms - [AgileForms Server installation folder]\webroot How to Start Do one of the following: 1. On the AgilePoint Server machine, navigate to [AgilePoint Server Installation]\SVCUtilityTool \AgilePointWindowsServiceClientUtilityTool.exe 2. Open the AgilePoint installation file, and click Utilities and Other Support Files > AgilePoint Windows Service Client Utility Tool. 1. In the AgilePoint Windows Service Client Utility Tool dialog box, complete the following fields: Service Address The URI for the Windows Service for which you are creating the binding. The information required to build this URI is provided in the AgilePoint Server Manager window. HTTP - http://[apserver Machine Name]: [Http Port]/AgilePointServer Target Config The file name and location of the configuration file for the application you are configuring. This is required for SharePoint Integration. For other applications, you only need to run this utility if you are prompted. SharePoint Integration The web.config for the SharePoint web application you want to bind. Enterprise Manager The web.config for the Enterprise Manager web application. Data Services DataServicesWindowsService.exe.config in the Data Services installation folder. The default location is C:\Program Files\AgilePoint\AgilePoint Data Services\ AgileForms - The web.config file in the AgileForms installation folder. The default location is C: \Program Files\AgilePoint\AgileForms Server\Webroot Deployment Service - apds.exe.config file in the Deployment Service installation folder. The default location is C:\Program Files (x86)\agilepoint\agilepoint Deployment Service\ 2. Click Settings to configure the following fields: Max Buffer Size Max Buffer Pool Size Max Received Message Size Max String Content Length Max Array Length Guidance for modifying these values can be found at the following articles on MSDN: