How to install the Finance Services
This How-to applies to: Any version.
Purpose
Administrators and Safedocs Support will use this information to install, setup and start the the services for Finance. It will also address the Unistall step for the Mailer Service, in case an older version was installed previously.
Prerequisities
Finance database must be installed. The Safedocs Finance application should have been setup for Admin password. Changes to the Admin password requires a change to the service configuration file as well.
Step by step
Safedocs will provide a .zip file with the services required by the Finance application: Mailer Service, Package Status Service and eDisclosure Report Service.
* After installing and configuring MailerService, the two other services just need to be scheduled.
Eventhough the Services are not required to run on the server application server as the Finance application, most installations have application and services running together.
|
Tier |
Software Pre-requisites |
|
Front End
|
1. Windows 2003 server (recommended) or XP |
|
DB Tier |
1. MySql 5.xx or MS SQL Server. Database should be already setup for the Finance application. |
The three services are:
- MailerService. This is a service that runs in the background and is responsible for managing all the email communication in the system.
- PackageStatusAgent. This application updates package status and need to be executed daily after midnight.
- EDsiclosureReportService. This application creates daily reports to be sent to the administrators in the system. This application also needs to be in a schedule and executed daily after midnight
Configuring Connectivity with Database
Finance system and services use hibernate and MySql or MS SQL Server as default backend technology. On this step, we will change hibernate configuration file to point to the server and database created for the application (configuration steps are the same as defined for the application):
1. Edit {Apache_Tomcat}\webapps\finance\WEB-INF\classes\hibernate.cfg.xml using your preferred ASCII editor. Change the property connection.url in order to point to your server/database. <property name="connection.url">jdbc:mysql://{database_server}:3306/finance</property>
2. Change the connection.username element and add the database user defined for the Finance database: <property name="connection.username">{database_user}</property>
3. Change the connection.password element in order to contain the user database password. <property name="connection.password">{user_database_password}</property>
4. <property name="show_sql">false</property> defines if the log should contain all sql executions (true) or not (false)
5. Save the file
Configuring Finance System
1. Edit {Apache_Tomcat}\webapps\finance\WEB-INF\classes\finance.cfg.xml using your preferred ASCII editor.
2. Configure the mailer section in order to point to finance external Url. <app-url>http://{external_Finance_Url}/finance</app-url>
3. In the service section configure the following keys:
a. <login>{ Admin_User}</login>. The login for an user administrator.
b. <password>{Admin_password}</password>. Password for the user specified in the login element.
c. <smtp-host>{Smtp_Email_Server}</smtp-host>. Define a SMTP where the system has access.
d. <from-user>{System email}</from-user>. Email account used to send all the communications in the system.
e. <from-password>{SMTP Password}</from-password>. If your system requires authentication you can use this field to specify the password for the email in the <from-address> element. If no authentication is required leave this element blank.
f. <from-address>{System email}</from-address>. Email account that will appear in the From box when email is received.
g. <ssl>false</ssl>. If your SMTP requires SSL encryption assign true to this element else false.
4. Run UninstallMailerService.bat if an older version of MailerService was already installed. Run InstallMailerService.bat if the service is running for the first time or has been removed as a service. Go to Windows Services and star Finance Mailer Service.
5. Schedule the PackageStatusAgent and EDisclosurePackageReport application to run in a schedule. If you are installing in Windows use the Schedule task and the .bat files in order to schedule the services..sh
5. Restart Tomcat
6. Start the email service (Finance Mailer Service).
Further information
Contact support@safedocsus.com.
see also:
-
How to configure the Mailer Service log
- Como configurar o log do Mailer Service: