Benchmark HRMS Integration Service
- Andrea Felder
Overview
A Windows service that reads an HRMS extract file and uses cCaseParty to set the case party to confidential when the employee is in a protected class.
Solution
$/Court/Dev/Dev/source/Service/Benchmark.Integration.HRMS/ Benchmark.Integration.HRMS.sln
Main Project
Benchmark.Integration.HRMS
Deployment Project
BenchmarkHRMSImportService
Build Repository
\\ptg-server1\Software\Downloads\Product\Benchmark\Services\BenchmarkHRMSImportService
Logging
Logs to tblServiceLog with ServiceName “HRMS Import Service”.
May log to the Event Log on the hosting machine for errors that do not make it to the database.
select top 100 * from tblServiceLog (nolock)
where ServiceName = 'HRMS Import Service'
order by ServiceLogID desc
Script Source Control
The SQL scripts related to the HRMS integration are included in the project.
Building and Packaging a Release
None of the Benchmark Windows services are being built by the build server due to complications with the setup project being used there. Follow the directions below to prepare, build, and package an HRMS Import Service release.
Update the Service and Installer Versions
Update the Service’s Assembly Info Version
Locate the “AssemblyInfo.cs” file in the “Properties” folder of the “Benchmark.Integration.HRMS” project.
Open the “AssemblyInfo.cs” file for editing.
It is a good idea to check that the copyright company and year in the file are current when you’re updating for a forthcoming build. If necessary, update the company and copyright details.
Locate the “AssemblyVersion” and “AssemblyFileVersion” fields at the end of the file and update the version as appropriate. Remember that with our Windows services, we’re leaving the last version identifier field as “0” as the installer will only reflect three levels of version identification.
Update the WhatsNew.txt File
Update the version and date in the WhatsNew.txt file.
Update the Setup Project Version
Locate the “BenchmarkHRMSImportService” setup project.
Right-click on the project and select the “Check Out for Edit…” option from the menu. The setup project will not allow you to update the version information without checking out the project first.
With “BenchmarkHRMSImportService” still selected in the Solution menu, click on the “Properties” tab at the bottom of the “Solution Explorer” panel.
The Properties panel should update and look like the following screenshot.
In the listed properties, locate and update the “Version” value to the desired value.
Visual Studio will prompt you asking if you would like to update the “ProductCode” automatically too. Agree to update the “ProductCode” value, which Visual Studio will update to a new GUID value.
Be sure to check in your version update changes.
Building the Release
Be sure that the build mode in Visual Studio is set to “Release”.
Locate the “BenchmarkHRMSImportService” setup project.
Right-click on the project and select the “Build” option from the menu.
After the build completes and packages successfully, right-click on the project again and select the “Open Folder in File Explorer” option.
Open the “Release” folder.
The “Release” folder will contain the .msi and setup.exe files to be packaged in the service release.
Packaging the Release
Navigate to the build repository or “Downloads” folder for HRMS releases.
\\ptg-server1\Software\Downloads\Product\Benchmark\Services\BenchmarkHRMSImportService
******************************************************************************
It’s usually easiest to start by making a copy of the most recent release to use as a template.
Package the Service Release Files
Within the release folder, we’ll include the .msi and setup.exe files in a “2_ServiceUpdate” folder.
Place the updated .msi and setup.exe files in this “2_ServiceUpdate” folder.
Package Scripts for the Release
Within the release folder, we have a “1_SQLScripts” folder that contains script updates including Benchmark schema changes, stored procedures, functions, triggers, and more.
