Skip to main content

How to Publish Zonal OCR

Preparation

  1. You need to create the following directory: C:\Deploy\Zonal
  2. Make sure that the ZonalOCR project builds on your machine

Publish Staging Build

  1. Open the ZonalOCR.sln and right click on the ZonalOCR project and select properties, opening the publish tab
  2. Make sure that the Publishing Folder is C:\Deploy\Zonal and that that directory exists on your machine (see step 1 of Preparation)
  3. Make sure the installation Folder URL is is http://downloads.efilecabinet.com/Stg-ZonalOCR/  
  4. Update the Assembly and File Version of the ZonalOCR project (right click -> Properties -> Application -> Assembly Information)
  5. The Install Mode and Settings should be set at "The application is available offline as well (launchable from Start menu)"
  6. Increment the version number by adding 1 to whatever the current "Build" number is. Don't worry about the Major, Minor, or Revision numbers.
  7. Click Publish Now - here's an image of the settings described above.
    image.png
  8. Save All, then restart visual studio. You need to do this every time you update the installation folder url
  9. Once the publish succeeds, go to C:\Deploy\Zonal and open the ZonalOCR.application file in a text editor. Verify that the xml tag tag <deploymentProvider>  has a a codebase  attribute that matches the Installation Folder URL. If it does not, then the build is no good. See the troubleshooting section at the bottom of this page.
  10. Zip all of contents of C:\Deploy\Zonal into a single file.
  11. Get the zip file to Dev Management and they will upload the file for QA to download!

Publish Release or Production Build

In the recent past, when releasing, our OPs team has not invalidated cloudfront on the files they put in S3, if there are issues or weirdness right after a release, this is the first things you should check to make sure happened

Obfuscating the Release

Assembly AccusoftFormsApi.dll is obfuscated because it contains Accusoft license keys. ConfuserEx is used to obfuscate it.

  1. Update the build number by right clicking the ZonalOCR project and clicking properties and the publish tab. Also update the assembly and file version of the Zonal OCR project (right click -> Properties -> Application -> Assembly Information) It may be necessary to repeat the process for the following projects:
    • AccusoftFormsApi
    • AccusoftOCR
    • BarcodeReader
    • BusinessLogic
    • DataAccess
    • DataTransmission
    • efcOnlineApiClient
    • UtopiaAPIClient
    • Pdf2ZonalOcr
    • RegistryAndPathUtils
    • UpdateDbTool
    • ZonalOcrLogger
    • ZonalOcrPrinterInstall

  2. Change the configuration to ReleaseObfuscated
    image.png

  3. To check that obfuscation works correctly, build the AccusoftFormsApi project

  4. Build the solution

Publishing the Release

  1. Right click on the ZonalOCR project and select properties and open the publish tab
  2. Make sure that the Publishing Folder is C:\Deploy\Zonal and that that directory exists on your machine (see step 1 of Preparation)
  3. Make sure the installation Folder URL is is http://downloads.efilecabinet.com/ZonalOCR/  
  4. The Install Mode and Settings should be set at "The application is available offline as well (launchable from Start menu)"
  5. The version number should have already been incremented
  6. Click Publish Now - here's an image of the settings described above.
    image.png
  7. Once the publish succeeds, go to C:\Deploy\Zonal and open the ZonalOCR.application file in a text editor. Verify that the xml tag tag <deploymentProvider>  has a a codebase  attribute that matches the Installation Folder URL. If it does not, then the build is no good. See the troubleshooting section at the bottom of this page.
  8. Zip all of contents of C:\Deploy\Zonal into a single file.
  9. Save All, then restart visual studio. You need to do this every time you update the installation folder url
  10. Get the zip file to Dev Management and they will upload the file for QA to download!

Create an MSI installer for support
After publishing a new version of ZonalOCR, we need to create an MSI installer for it and provide it to Support.

See See How to Create Zonal OCR MSI Installer   for directions.

Troubleshooting

ZonalOCR.application file has the wrong wrong <deploymentProvider>
After publishing a ZonalOCR build, the ZonalOCR.application file should contain an xml tag called called <deploymentProvider>  with an attribute called called codebase  that matches the Installation Folder URL. If it does not match, the build is no good. DO NOT just edit the value in the file because it needs to be set correctly as part of the publish process.

Try this:

  1. Right click the ZonalOCR project in the Solution Explorer and click Unload Project
  2. Right click the ZonalOCR project and click Edit Project File
  3. Make sure both both <InstallUrl> and  and <UpdateUrl>  contain the Installation Folder URL. Save the file.
  4. Right click the ZonalOCR project and click Reload Project.
  5. Publish again

Old Publish Instructions
ZOCR build process.docx

Back to top