Introduction
Scope
The purpose of this manual is to guide the user through the eCASE Portal installation process. Information presented in this document presumes the following:
Windows 2016 R2/Windows 2019 Server is installed on the application server.
eCASE is installed and configured on the application server.
Overview
eCASE is a comprehensive web-based case management platform that allows users to implement business applications that can automate business process, workflows, and interactions between case workers and employees/public.
eCASE Portal is a website that provides eCASE users the ability to access and submit forms which are generated as folders in eCASE for further processing. eCASE Portal is built by using Microsoft .NETāconnected technologies so that it is easy to deploy, customize, and use.
Getting Started
Prerequisites
Before proceeding with the installation, it is necessary to:
Create and configure the SQL 2016/17/19 database server.
Install Microsoft .NET Framework 4.8 on the application server.
Configure the SMTP Server to relay email to the email server when using eCASE Portal.
The SMTP server must be configured to relay email messages to other domains.
Portal Sync is a feature of the eCASE Scheduler service and runs on 4.8 with ADO.NET Data Services Update for .NET Framework 4.8.
eCASE Portal Database Account Requirements
There are three accounts the administrator must provision to configure the application and database servers. The table below outlines the type of accounts, their purpose, and requirements.
Account | Purpose | Requirement |
Application Setup User | This user installs and configures the eCASE Portal application. | This account is setup as a Domain/Local User and is a member of the Administrators Server Groups. |
eCASE Portal Database Creation User | This user creates the eCASE database user account and grants the required permissions. | This account is added to the following SQL Server security roles for the user that creates the database either in SQL Server (Window User) or Windows Authentication Mode (NT User):
|
eCASE Portal Database User | This user performs all eCASE Portal application database actions. | This account must be assigned as a member of the db_owner database role for the eCASE Portal SQL Server database. |
Create the eCASE Portal Database
The purpose of the eCASE Portal database is to collect, store, and organize data in a way that eCASE Portal user can access. This section outlines the procedures to create a database for use with the eCASE Portal application, specifically the SQL Server database type.
NOTES:
Please review the database server requirements prior to setting up the database. If the requirements are not met, the database will not function.
Make sure to run the Setup.exe file from the application server.
Install Microsoft .NET Framework 4.8 on the application server.
Open the eCASE Portal 11.2.0 folder and right-click the Setup.exe file.
Select Run as administrator. The eCASE Portal Setup wizard appears.
Select Create eCASE Portal Database > SQL Server for the database type.
The eCASE Portal Database Server window appears.
Ensure the Set up new eCASE Portal 11.2.0 database radio button is selected and click Continue. The eCASE Portal Database Setup window appears.
Enter the required information outlined in the table below and click Next.
NOTE: If Windows Mode is selected as the Authentication Mode, enter the Server Name only. The Domain and Windows User fields are automatically populated based on the current user.
Field Name | Description |
Server Name | The name given to the eCASE Portal database server. |
Login Name | The unique identifier for the database owner that manages the database. |
Password | The security credential associated with the database owner Login Name used to gain access to the database. |
Domain | The name of the IP resource used to access the database server. |
Windows User | A user with dbcreator and security admin privileges. |
Enter the required information outlined in the table below and click Next.
Field Name | Description |
Database Name | The name given to the eCASE Portal database during creation. |
Login ID | The unique identifier for a user who has access to the eCASE Portal database. |
Password | The security credential associated with the above user to gain access to the database. |
Enforce Password Policy | Click this checkbox to enforce the password policy for SQL Server. |
The Database Name and Login ID fields are automatically populated as PortalDB and PortalUser, respectively. Users can accept the preset or change the database and login names, if desired. Enter the Password for the user account in the Password field and click Next.
The Setup Progress window appears and displays a list of components to configure. Click Finish to continue setting up the eCASE Portal database.
A confirmation message appears after the database has been created. Click OK to close the message and return to the eCASE Portal Setup wizard.
Application Installation
The purpose of the application server is to handle all eCASE Portal application operations between users and the eCASE Portal database. This section provides instructions on how to install the eCASE Portal on the application server.
NOTE: Begin Step 3 if continuing from the previous section (Create the eCASE Portal Database).
Set up the eCASE Portal Application
Open the eCASE Portal 11.2.0 folder.
Right-click the Setup.exe file and select Run as administrator. The eCASE Portal Setup wizard launches.
Click Install eCASE Portal Application Server. The eCASE Portal Application Server window appears.
Click Continue.
The eCASE Portal Setup window appears.
Click Next. The License Agreement window appears.
Read the License Agreement carefully and select the I accept the license agreement radio button.
Click Next to continue the setup process.
Click the Back button to return to the Welcome window.
Click Cancel to abort the eCASE Portal installation.
NOTE:
The Next button remains disabled until the option to accept the license agreement is selected.
The Reset button sets the selection to the default option of I do not Accept the License Agreement.
Enter the name of the user and organization, then click Next.
Ensure that the Anyone Who Uses This Computer radio button is selected.
Select the eCASE features to include in the installation by clicking the drop-down arrow next to a feature and selecting one of the following options:
Will be installed on the local drive: Installs the selected feature only.
Entire feature will be installed on local hard drive: Installs everything associated with the selected feature.
Entire feature will be unavailable: Excludes installation of a feature.
Review the instructions for setting up the default folder location. Click Browse to change the destination folder.
Click Next to accept the destination folder and to continue with the installation. The Ready to Install window appears.
Click Next to proceed with the installation. The Updating System window appears. The eCASE Portal Setup wizard begins the process of copying files and configuring the system. (This may take several minutes.)
NOTE: It is highly recommended not to interrupt the Update process. Refer to Appendix A for uninstall procedures.
Once the eCASE Portal application is installed, the eCASE Portal Configuration window opens.
Users can close this window and enter the database and authentication details later or enter the required information outlined in the table below.
NOTES:
The Database Type field is automatically populated and disabled. SQL Server is the only database type supported at this time.
The user is automatically logged in to the database when Windows is selected as the Portal Login Mode.
Field Name | Description |
Database Server Name | The title of the server where the database is stored. |
Database Name | The name given to the eCASE Portal database during creation. |
Windows Authentication | Clicking this checkbox enables Windows Authentication. |
Login ID | The unique identifier for the user having access to the eCASE Portal database. |
Password | The security credential associated with the user to gain access to the database. |
Enforce Password Policy | Select this checkbox to enforce the password policy for SQL Server. |
Login Name | The unique identifier for the user who has administrative privileges for the database server. |
Password | The security credential associated with the admin user. |
Complete the Authentication details.
The Portal Login Mode selection may open additional fields, and the available selections include:
Selection | Definition |
Forms | The standard level of access to the eCASE application, Username and Password. |
SAML | Allows the user to automatically log into eCASE without being prompted for login credentials. |
Windows | An authentication service provided by one remote server to other distributed servers, on the Internet or an intranet; users must submit requests to obtain login/logout credentials. |
NOTE: If the Forms portal login mode is selected, enter the password for Admin account and complete the authentication details.
Enter the database details described in the table above and click Save. A confirmation message appears. Click OK to close the message window.
Click Close to exit the eCASE Portal Configuration window.
The following screen is displayed informing users that the application has been installed successfully. Click Finish to return to the setup wizard.
Continue with the next section to install eCASE Portal components.
eCASE Portal Database Configuration
If the eCASE Portal database was not configured during the Installation procedure, administrators can configure it using the configuration utility.
Navigate to Start > All Programs > eCASE Portal.
Right-click Database Configuration and select Run as administrator. The eCASE Portal Configuration window appears.
Enter the required information.
Click Test Connection to verify the information entered enables a successful connection.
Click Save to accept the configuration details. A message window appears. Click OK to close the message window.
Click Close to exit the eCASE Portal Configuration window.
Verify Access to eCASE Portal
After the eCASE Portal application and its components are installed and configured, it is recommended to verify access to the application. By verifying access administrators can resolve any issues or problems encountered in the event the application is inaccessible.
Select Start > All Programs > Administrative Tools > Internet Information Services (IIS) Manager.
Select Start Page > Sites > Default Web Site.
Select eCASEPortal.
Select Manage Applications > Browse Application.
Click Browse *:80 (http). The eCASE Portal Login Screen appears.
Repeat steps 3 ā 5, however, select eCasePortalDataServices instead of eCasePortal.
NOTE: If a server error page appears, enable Directory Browsing in IIS Manager by double-clicking Directory Browsing, selecting Enable from the Actions pane, and refreshing the browser.Click the PortalDataServices.svc link. The Portal Web Service URL appears with XML coding.
Make note of the Portal Data Services URL. It is required in the Configuring Portal Settings in the eCASE Application section.
Close both browser windows.
Configuring Portal Settings in the eCASE Application
This section details how to setup the eCASE Portal for use in the eCASE application. Before performing these procedures, ensure that the eCASE application and the eCASE Portal are installed and configured on the application server.
Login to the eCASE application.
Click Administration > Connectors. The Connectors screen appears.
Select Portal row and click on Edit or click the portal link.
Ensure the Enable eCASE Portal checkbox is checked.
Enter the Portal Web Service URL in the Portal Web Service URL field.
Complete the fields outlined in the table below and click Next.
Click Save or click the Back button to return to the Administration screen.
Click Scheduled Job > Portal Sync and make sure the Inactive checkbox is blank.
Set the Refresh time to 1 minute.
Click Save.
On the Scheduled Jobs screen, click Portal Update Folder Data Sync and make sure the Inactive checkbox is blank.
Set the Repeat for every time to 1 minute.
Click Save and return to the Administration page by clicking the Back button.
NOTE: For the Portal to function, ensure that the HTTP Activation Service in the eCASE Application Server Manager is enabled:
Navigate to the Application Server where the eCASE Portal is installed.
Select to Start > Server Manager > Add Roles and Features.
The Add Roles and Features wizard appears. Click Features.
Ensure the HTTP Activation Protocol checkbox is selected.
Navigate to http://[ServerName]/eCasePortal.
Click Sign-Up. The registration form appears. Complete the fields outlined in the table below and click Next.
Field Name | Description |
First Name | The first name of the user whom is registering. |
Last Name | The last name of the user whom is registering. |
Email ID | The email which belongs to the registering user. |
Password | The password which will authenticate the login credentials of the registering user. |
The following screenshot is for demonstration use only. The administrative user can create and customize forms.
The following message appears. Click the link to return to the Login page.
After receiving the Registration Confirmation email, return to http://[ServerName]/eCasePortal and login with the User ID and Password in the email you received.
The Create New Password form appears. Enter a new password in the New Password and Confirm Password fields.
Select a question from each of the Security Questions drop down lists.
Enter an answer to each Security Question in the Security Answer fields.
Click Save New Password. A confirmation message will appear.
Main Form Templates
To create a folder for the Case Type Form template, enable the Portal flag for the corresponding template.
Click Administration > Case Types.
Select a case type.
Select Actions > Main Form Template. The Main Form Template screen appears.
Click the Enable for Portal check box. The Portal Display Name, Portal Group Name, and Portal User Role fields appear.
Enter a name in the Portal Display Name field.
Select a group name from the Portal Group Name drop down list.
Enter the user role in the Portal User Role field.
NOTE: The Portal Group Name field displays option(s) corresponding to the case type form template.
To create a new Portal Group Name, click New or edit an existing group name click Edit. The result appears in the Portal Group Name drop-down list. If a group name was deleted, it is removed from the drop-down list.
Click Save to accept the settings.
Other Form Templates
Enabling the Portal flag for other form templates uses the same procedures as in the previous section.
Click Administration > Case Types > Actions > Other Form Template. The Other Form Template screen appears.
Select a Form Template from the Form Template drop-down list.
Click Add. The screen corresponding to the selection appears. (e.g. Telework)
Click the Enable For Portal checkbox. The Portal Display Name, Portal Group Name and Portal User Role fields appear.
Enter a name in the Portal Display Name field.
Select a group name from the Portal Group Name drop-down list.
NOTE: The Portal Group Name field displays option(s) corresponding to the case type form template.
Enter the user role in the Portal User Role field.
To create a new Portal Group Name, click New or edit an existing group name click Edit. The result appears in the Portal Group Name drop-down list. If a group name was deleted, it is removed from the drop-down list.
Click Save.
After the Portal settings are configured in eCASE, a sync service job transfers the form template to the eCASE Portal. As a result, users in eCASE Portal can see the form template, thus enabling the submission of forms from the Portal.
Open Internet Explorer and type the eCASE Portal URL in the address field. For example, http://localhost:80/ecaseportal. The eCASE Portal Login screen should appear.
Enter the User Name and Password.
Click Login. The eCASE Portal Home screen appears.
If users submit requests via the eCASE Portal, a corresponding case folder is created in eCASE and made available in the userās eCASE inbox after initiating an assignment. The form status is updated in the eCASE Portal.
The eCASE user and the corresponding user in the eCASE Portal can communicate with each other through the Portal Messages feature.
eCASE Portal Uninstallation
This section provides instructions on uninstalling eCASE Portal from the application server.
Uninstall the eCASE Portal Application
The eCASE Portal application can be uninstalled manually or by using the eCASE Portal Setup Wizard. If uninstalling the application using the setup wizard, it automatically detects the previous installation and redirect users to uninstall the application. The uninstall process occurs on the application server.
Note: To manually uninstall the application click Start > All Programs > Control Panel > Programs and Features. Select eCASE Portal then click Uninstall. The application is removed from the server.
Expand the eCASE Portal 11.2.0 folder.
Right-click on the Setup.exe file and select Run As administrator. The eCASE Portal Setup window appears.
Click Install eCASE Portal Application Server. The Windows Installer window appears briefly. After several seconds the Application Maintenance window opens with Modify selected as the default radio button.
Select Remove and click Next. The eCASE Uninstall window appears.
Click Next. The Updating System window appears.
The uninstallation process may take several minutes. Once complete the Successful Uninstallation window appears.
Click Finish to close the eCASE Setup window once the application is uninstalled.
NOTES:
It is highly recommended not to interrupt the Updating System process. To interrupt, click the Cancel button. The eCASE Portal Setup window appears. Review the information before proceeding then click Exit Setup to stop the uninstall process or Resume to continue with the uninstallation.
Exiting the uninstall process while the system is updating does not remove the entire application. Users must restart the entire uninstallation sequence to completely remove the application from the server.