Quantcast
Channel: Ephesoft Docs
Viewing all 478 articles
Browse latest View live

Known Issue: SharePoint Configuration Error in Ephesoft Transact

$
0
0

Known Issue:

An error occurs when configuring the SHAREPOINT_365_EXPORT_PLUGIN that requires updated authentication.

Solution:

Perform the following steps to create a new App password for your SharePoint account to configure the SHAREPOINT_365_EXPORT_PLUGIN in Ephesoft Transact.

  1. Navigate to your Office 365 My account page.


Figure 1. Office 365

  1. Select Manage security & privacy > Additional security verification.


Figure 2. Additional security verification Option

  1. Click Create and Manage app passwords


Figure 3. Security & privacy Screen

  1. Click Create.


Figure 4. Application Passwords Screen

  1. Enter a name for your app and click next.


Figure 5. App Name Example

  1. A generated password displays. Copy this password.

Note: The password will not display again after closing this window.


Figure 6. Generated Password Example

  1. Navigate to the SharePoint Configuration screen in Ephesoft Transact.
  2. Enter the connection details in the SharePoint Configuration screen along with the generated password from step 6.


Figure 7. Enter Generated Password from Office 365

You can now view the document libraries in your SharePoint site.


Figure 8. Export Settings Fields

Note: You can enter a specific SharePoint URL to filter the Document Library list to view specific document locations.


Figure 9. View the Document Library List

The post Known Issue: SharePoint Configuration Error in Ephesoft Transact appeared first on Ephesoft Docs.


KB00007629 Combined Realm for AD/LDAP

$
0
0

Applicable version: All versions of Ephesoft Transact

Issue

In some cases the group and users search in LDAP can’t find users and groups unless there are specific context paths entered in the configuration. This required listing all organizational units (OU) that contain the authorized users and groups.

Combined realms are used particularly when you have multiple OUs that need to be looked at to authenticate your users. Because the Global Catalog port (Port 3268) in Active Directory is only used for following referrals to the common name (CN) description of a user account, the normal LDAP port (Port 389) could cause issues later on.

Root Cause

Limitations to the service which is not able to follow referrals down to the lowest sub-organizational unit.

Solution

To resolve this issue, you will need to set up combined realms in Apache Tomcat.

  1. Open the server.xml file located at <Ephesoft_Directory>\JavaAppServer\conf\server.xml.
  2. Add the following to the server.xml file around the current realm configuration for LDAP, in order for the role base to match any group membership:
<Realm class Name="org.apache.catalina.realm.CombinedRealm"></Realm>
  1. Then add another realm configuration after the already existing realm setting. In the second realm setting, add the secondary OU location you would like Apache Tomcat to identify and authenticate both your users and groups.

Example:

<Realm class Name="org.apache.catalina.realm.CombinedRealm">
<Realm className="org.apache.catalina.realm.JNDIRealm"
connectionURL="ldap://<AD ServerName/IP>:389"
connectionName="cn=User,OU=Service Accounts,DC=Test,DC=Ephesoft,DC=com"
connectionPassword="P@ssw0rd" userPattern="cn={0},OU=DomainUsersLocation1,DC=Test,DC=Ephesoft,DC=com
roleBase="OU=SecurityGroupsLocation1,DC=Test,DC=Ephesoft,DC=com"
roleSubtree="true"
roleName="cn"
roleSearch="uniqueMember={0}"
/>

<Realm className="org.apache.catalina.realm.JNDIRealm"
connectionURL="ldap://<AD ServerName/IP>:389"
connectionName="cn=User,OU=Service Accounts,DC=Test,DC=Ephesoft,DC=com"
connectionPassword="P@ssw0rd"
userPattern="cn={0},OU=DomainUsersLocation2,DC=Test,DC=Ephesoft,DC=com
roleBase="OU=SecurityGroupsLocation2,DC=Test,DC=Ephesoft,DC=com"
roleSubtree="true"
roleName="cn"
roleSearch="uniqueMember={0}"
/>
</Realm>

This configuration only needs to be used if you are not able to use the Global Catalog Port in Active Directory. You will need to follow the instructions for setting up AD at the OU level. Refer to How to Configure Active Directory using the Standard LDAP Port for more information.

The post KB00007629 Combined Realm for AD/LDAP appeared first on Ephesoft Docs.

Ephesoft’s Linux Command Line Tool

$
0
0

This page lists the Linux command-line options for most applications included in Ephesoft Transact.

Jump to:

Nuance Commands

OCR

<path_to_NuanceOCR_executable> <path_to_input_image> <path_to_output_HOCR.xml_file> <path_to_Nuance_Iczx_license_file> <page_number_identifier (used to assign page ID value in HOCR)> <path_to_Nuance_Settings.sts_file> <auto_rotate_switch> <OCR_confidence_switch> <optional_zon_file_if_nuance_extraction_should_be_used> <optional_nuance_extraction_switch>

Example:

./NuanceOCR ./a-0001.tif NuanceOCR.xml ./lcxz PG0 ./SETTINGS.STS ON ON
A
Figure 1. Nuance OCR Command

Extraction

<path_to_NuanceOCR_executable> <path_to_input_image> <path_to_output_HOCR.xml_file> <path_to_Nuance_Iczx_license_file> <page_number_identifier (used to assign page ID value in HOCR)> <path_to_Nuance_Settings.sts_file> <auto_rotate_switch> <OCR_confidence_switch> <zon_file_if_Nuance_extraction_should_be_used> <Nuance_extraction_switch>

Example:

./NuanceOCR ./a-0001.tif NuanceExtraction.xml ./lcxz PG0 ./SETTINGS.STS ON ON ./docsample.zon ON
B
Figure 2. Nuance Extraction Command

Ghostscript Commands

PDF to TIFF Conversion

gs -dNOPAUSE -r300 -sDEVICE=tiff24nc -sCompression=lzw -dBATCH -sOutputFile=”<output_tiff_filename>-%04d.tif” “<input_pdf_file_path>

Note: In Linux, Ephesoft uses -sDEVICE as tiff24nc instead of tiffscaled24, as Ghostscript in Linux does not support tiffscaled24.

Example:

gs -dNOPAUSE -r300 -sDEVICE=tiff24nc -sCompressionlzw -dBATCH -sOutputFile="a-%04d.tif" ./multipage-pdf.pdf
3
Figure 3. Ghostscript PDF to TIFF

PDF Optimization

PDF optimization is not supported by Ghostscript on Linux.

ImageMagick Commands

convert <conversion_param> <input_file_path>” “<output_file_path>

TIFF to TIFF Conversion

Example:

convert -limit area 100mb .\multipage-tif.tif -compress LZW a-%04d.tif"
4
Figure 4. ImageMagick TIFF to TIFF

TIFF to PNG Conversion

convert .\multipage-tif.tif -colorspace gray -alpha off a-%04d.png
5
Figure 5. ImageMagick TIFF to TIFF

TIFF to PNG Thumbnail Conversion

convert .\sample.tif -colorspace rgb -thumbnail 200x150 a-%04d.png
6
Figure 6. ImageMagick TIFF to PNG

Colored TIFF to PDF Conversion

convert test.tif -quality 100.0 -compress LZW out.pdf
7
Figure 7. ImageMagick Colored TIFF to PDF

Non-colored TIFF to PDF Conversion

convert test.tif -quality 100.0 -monochrome -compress LZW out.pdf
8
Figure 8. ImageMagick Non-colored TIFF to PDF

PDF to TIFF Conversion

convert -limit area 100mb sample.pdf -compress LZW a-%04d.tif
9
Figure 9. ImageMagick PDF to TIFF

Tesseract HOCR Command

tesseract "<input_TIFF_file_path>" "<output_html_file_path_without_.html_extension>" "-l eng" +"<hocr.txt_file_path>"

Example:

tesseract ./a.tif out –l eng +./hocr.txt

ZXing Command to Extract Barcode Value

java -cp zxing-1.6.0.jar:.: com.google.zxing.client.j2se.CommandLineRunner “<png_file_path>

The post Ephesoft’s Linux Command Line Tool appeared first on Ephesoft Docs.

Batch Class with Global Document Type Failing Import

$
0
0

Applies to:

  • Ephesoft Transact 2020.1
  • Ephesoft Transact 2020.1.02

Issue:

If you are importing a batch class that creates or updates global document types in the global batch class, the import process will fail if there is a local document type in the Global Batch Class (BC0).

The following error message will display:

“The import process has been aborted because the existing global batch class contains a local document type with the same name as an imported global document type. To fix this problem, change the local document type in the global batch class to a global document type, or use the Import as Local Batch Class option.”

Important: This error message is incorrect. Perform the following steps to resolve the error.

Figure 1. Error Message

Solution:

Importing will succeed if all local document types are changed to global for BC0.

  1. In BC0, set any existing local or draft document types to Global.
  2. Import your batch class.

Note: If you do not want to keep your local or draft document types as Global, perform steps 3 and 4.

  1. Create copies of the document types you set to Global in step 1.
  2. Delete the original document types you set to Global in step 1.

The post Batch Class with Global Document Type Failing Import appeared first on Ephesoft Docs.

Error in dcma Logs When Exporting a Batch Class

$
0
0

Applies to:

  • Ephesoft Transact 2020.1
  • Ephesoft Transact 2020.1.02

Issue:

The following error occurs in the dcma logs when exporting a batch class, even though the batch class exports successfully.

“2020.1.02 Windows Server 2016 2020-06-16T09:46:04,412 ERROR http-nio-8080-exec-4 com.ephesoft.gxt.admin.server.ExportBatchClassDownloadServlet – unable to export CHE plugin configuration file while exporting BC5org.springframework.web.client.HttpClientErrorException: 404 null”

We encountered this error during our testing. This had no impact on the performance or data that was returned.

 

The post Error in dcma Logs When Exporting a Batch Class appeared first on Ephesoft Docs.

Batch Class Fields Missing After Import

$
0
0

Applies to:

  • Ephesoft Transact 2020.1
  • Ephesoft Transact 2020.1.02

Issue:

When exporting a batch class that has Batch Class Fields, importing that batch class does not import the Batch Class Fields.

Solution:

If you are adding the batch class to the same environment, copying the batch class will retain the Batch Class Fields. Otherwise, manually add the Batch Class Fields after import.

 

The post Batch Class Fields Missing After Import appeared first on Ephesoft Docs.

Additional Configuration for Chrome 80

$
0
0

Issue

When using Google Chrome version 80 or later, you may be unable to sign out of Ephesoft Transact if you are signed in using single sign-on (SSO). Additionally, you may face issues if Transact is embedded in an external application using an iframe element.

This issue can occur in a cross-domain configuration scenario and can affect all versions of Transact.

Cause

Starting with Chrome 80, Chrome has made the following changes regarding cookies:

  • All cookies that do not have the SameSite attribute specified are treated by default as if they have SameSite set to Lax.
  • Chrome will only deliver cookies with SameSite set to None if they are also marked as Secure.

What is the SameSite Attribute?

The SameSite attribute is configured when a cookie is set and is used to describe the contexts in which the cookie is available for reading.

There are three possible values for this attribute:

Value Description
Strict When SameSite=“Strict”, the cookie is only available in requests where the request host shares the public suffix of the request origin.

Cross-site cookies are not allowed. For example, if a page on domain.com requested a resource from www.domain.com, the SameSite=”Strict” cookie would send the resource. But if the page on domain.com requested a resource from example.com, any SameSite=”Strict” cookies written on example.com would not be included in the request.

This applies to navigation as well.

Lax When SameSite=”Lax”, the cookie behaves similar to Strict cookies, but does allow for top-level navigation to include the cookie in the HTTP headers.

For example, if you navigate from domain.com to example.com, the SameSite=”Lax” cookies written on example.com would be included in the request.

Note: This is the default value for cookies without an explicitly set SameSite attribute.

None When SameSite=”None”, cookies can be accessed in first-party and third-party contexts without restrictions. This attribute should be used if you have a cookie that must be distributed to multiple domains in HTTP headers.

Important: When the SameSite attribute is set to None, the cookie must also have the Secure flag. Chrome will not accept the Secure flag unless the connection is HTTPS, otherwise the cookie will be blocked.

Solution

Most major SSO providers have adjusted their solutions to reflect this change. If you encounter any issues with iframe or SSO authentication, contact your SSO provider or configure your external web application and ensure that:

  • Authentication and authorization-related cookies have SameSite=”None” and the Secure flag is set. Refer to the workaround listed below.
  • SSO communication is using HTTPS.

Note: Ephesoft Transact currently uses the following four cookies:

  1. sessionExpiry
  2. serverTime
  3. authType
  4. JSESSIONID

Figure 1. Transact Cookies

Workaround

We recommend not embedding Transact as an external web application in an iframe. Instead, consider using a pop-out option to launch Transact. If you are unable to do so, you can manually configure the cookies on your instance of Chrome as another workaround.

Note: This should be done for each user’s instance of Chrome that is facing iframe or SSO issues with Ephesoft Transact.

  1. Open the Chrome browser.
  2. Enter the following in the browser’s location bar: chrome://flags/#same-site-by-default-cookies

Figure 2. Navigate to Flags

This will jump to the SameSite by default cookies entry.

  1. From the drop-down to the right side of this setting, select Disabled.

Figure 3. Disable Selected Cookies

  1. You will be prompted to relaunch the browser. Click Relaunch.

Figure 4. Relaunch Chrome

  1. After the browser relaunches, enter the following in the browser’s location bar: chrome://flags/#cookies-without-same-site-must-be-secure

Figure 5. Navigate to Flags

This will jump to the Cookies without SameSite must be secure entry.

  1. From the drop-down to the right side of this setting, select Disabled.

Figure 6. Disable Selected Cookies

  1. You will be prompted to relaunch the browser. Click Relaunch.

Figure 7. Relaunch Chrome

Conclusion

This completes an overview of potential workarounds to the interoperability issues caused by Chrome 80’s new security features, described above.

The post Additional Configuration for Chrome 80 appeared first on Ephesoft Docs.

Importing Windows Batch Class to Linux Environment

$
0
0

The following instructions describe how to migrate batch classes from Windows to Linux. Before proceeding, export your batches from the Windows environment and import them into the Linux one. The following changes should be made after importing the batch class to Linux.

After Importing the Batch Class to Linux

Follow the instructions below for each imported batch class.

Page Process Module

  1. Remove the RECOSTAR_HOCR plugin from the module.
  2. Add either the NUANCE_HOCR or TESSERACT_HOCR plugin to the Page Process module, along with any dependencies.
  3. Click Apply.

Extraction Module

  1. Remove the RECOSTAR_EXTRACTION plugin.
  2. Add the NUANCE_EXTRACTION_PLUGIN in the Extraction module, along with any dependencies.
  3. Click Apply.

  1. Edit the batch class to use Nuance ZON files in place of corresponding RSP files. This is configured on the Document Types page for each document type in the batch class. Nuance uses the configured ZON files for extraction.
  2. Click Apply.

Folder Import Module

  1. In the IMPORT_MULTIPAGE_FILES plugin, edit the GhostScript Image Parameters:
    • Remove “-sDEVICE=tiffscaled24”
    • Replace it with “-sDEVICE=tiff24nc”
  2. Click Apply

Export Module

  1. In the CREATEMULTIPAGE_FILES plugin, set the PDF Optimization switch to OFF.
  2. Change the Multipage File Export Process to use any of the following options (Do not select RECOSTAR):
    • IMAGE_MAGICK
    • HOCRtoPDF
    • GHOSTSCRIPT
    • ITEXT
    • ITEXT-SEARCHABLE

Note: The default option is IMAGE_MAGICK. 

  1. In the COPY_BATCH_XML plugin, edit the Final Export Folder with the desired path.
  2. In the same file, update the Multipage File Name.
  3. Click Apply.

  1. Click Deploy to deploy the changes to the workflow.

The post Importing Windows Batch Class to Linux Environment appeared first on Ephesoft Docs.


What is the Difference Between the Document Assembler and Advanced Document Assembler?

$
0
0

Applies to: Ephesoft Transact 4.5.0.0 and above

When the Advanced DA Switch is enabled in the DOCUMENT_ASSEMBLER plugin, the plugin will run using the ADVANCED_DOCUMENT_ASSEMBLER algorithm. So what are the differences between the two algorithms?

Separation Method

The main difference between the two algorithms is their separation method:

  • Document Assembler Algorithm: Looks at the highest confidence value for each page. When it finds a “first page”, it starts a new document.
  • Advanced Document Assembler Algorithm:  Forward and reverse page-level look-aheads and look-behinds to all alternate values are applied to a proprietary algorithm. Decision making is based on every permutation of pages and alternate value information in the xml.

Note: Both algorithms use the same weighting factors and classification method to generate document classification confidence scores. This is as follows:

  • DA Rule first-middle-last page: 100
  • DA Rule first-page: 50
  • DA Rule middle-page: 25
  • DA Rule last-page: 50
  • DA Rule first-last page: 75
  • DA Rule first-middle page: 50
  • DA Rule middle-last page: 50

For more information on this topic, refer to the Document Assembler Plugin

The post What is the Difference Between the Document Assembler and Advanced Document Assembler? appeared first on Ephesoft Docs.

How Do I Add a New Translation to Transact?

$
0
0

Applies to: All versions of Ephesoft Transact

If a language you’re looking for is not supported by Ephesoft, you can add your own translations to the Transact UI by editing the locale files.

What are locale files?

A locale file is a JavaScript (.js) file that contains a set of translations for the text strings used in Transact. In the Ephesoft file structure, there are separate locale files for each UI screen. The locale files contain an entry for each language.

Where are the locale files?

The locale files are located at [Ephesoft_Directory]\Application\i18n. The i18n folder contains the following folders, each of which contains their respective locale.js file:

  • batchClassManagement
  • batchInstance
  • batchlist
  • common
  • customWorkflow
  • folderManager
  • licenseGenerator
  • login
  • report
  • rv
  • systemConfig
  • theme
  • uploadbatch
  • webscanner

How do I add a new translation?

To add a new translation, perform the following steps or each respective locale.js file:

  1. Before making any changes, make a copy of the locale.js file as a backup.
  2. Copy the var statement from the English (default) messages.

Note: English var statements don’t have any language suffixes. For example, in the screenshots below, figure 1 shows the English variable with no language suffix while figure 2 shows the French translation variable in the same file with the _fr suffix:

Figure 1. English Variable (default)

Figure 2. French Variable

  1. Paste the copied variable at the end of the locale.js file.
  2. Add a suffix for the language you’re adding a translation for. We recommend using ISO language codes for consistency.
  3. Replace each message in the variable with their respective translations.

Note: As this is a JavaScript file, do not make any changes to the formatting or alignment of the script. Any syntax errors will prevent Transact from accessing the translations.

 

The post How Do I Add a New Translation to Transact? appeared first on Ephesoft Docs.

How to Change the Ephesoft Logo

$
0
0

This page contains steps for how to replace the Ephesoft logo within Ephesoft Transact with your own company logo. These instructions are intended for partners and customers who are looking to white-label Transact.

Prerequisites

  • You will need administrator permissions.
  • You will need a basic understanding of HTML and CSS.

The instructions for this procedure vary by version:

Ephesoft Transact 2019.1 and Above

To upload your customized logo, perform the following steps:

  1. Navigate to the images folder at [Ephesoft_Directory]\Application\custom\images.
Figure 1. Images Folder
  1. Add or copy your image file to the images folder. The filename should be unique. Supported file types are:
    • SVG
    • PNG

Edit the Logo File Paths

After you have uploaded the new logo image, you will need to change the file path in the affected files to direct to the new image.

The following files are affected, which are located in [Ephesoft_Directory]\Application:

Note: You do not need to restart Transact after making changes to the above files. To view your changes, refresh your browser.

Edit the Login.html File

The Login.html changes the logo on the Login screen.

Figure 2. Login Screen

By default, the file will point to the Ephesoft logo. To point to the new file, edit the img src attribute.

  1. Open the Login.html file, at [Ephesoft_Directory]\Application.
Figure 3. Application Folder
  1. Search for “company_login_logo.svg”.
Figure 4. Login.html File
  1. Duplicate the “img src” line.
Figure 5. Duplicate img src
  1. Comment out the original line.
Figure 6. Comment Out Original
  1. Edit the new line to point to the new image file by replacing the “company_login_logo.svg” with the name of the new image file.
Figure 7. Update Filename
  1. Adjust the height and width of the img src attribute as needed.
  2. Save and close the file.

Edit the home.html File

The home.html changes the logo on the Home screen.

Figure 8. Home Screen
  1. Open the home.html file, at [Ephesoft_Directory]\Application.
Figure 9. home.html File
  1. Repeat steps 2-7 from the Login.html section above.

Note: The img src attribute in the home.html file does not contain default height or width tags. Depending on the size and dimensions of your new file, you may need to add and customize these tags.

Figure 10. Edit Height and Width

Edit the common.css File

The common.css changes the logo on each Administrator and Operator page within Transact.

Figure 11. Batch Class Management Screen
  1. Open the common.css file, located at [Ephesoft_Directory]\Application.
Figure 12. common.css File
  1. Search for “company_login_logo”.
Figure 13. Locate “company_login_logo.svg”
  1. Duplicate the .logoPanel .iconImage element and its properties.
Figure 14. Duplicate the Element
  1. Comment out the original element.
Figure 15. Comment Out Original
  1. Edit the new element to point to the new image file by replacing the “company_login_logo.svg” with the name of the new image file.
Figure 16. Update Filename
  1. Adjust the width and height properties as needed.
  2. Save and close the file.

Ephesoft Transact 4.0.0.0 to 4.5.0.0

To upload your customized logo, add or copy your image file to the following folders.

  • [Ephesoft_Directory]\Application\custom\images
  • [Ephesoft_Directory]\Application\themes\default_theme\images

Note: The filename should be unique. Supported file types are:

  • SVG
  • PNG

Edit the Logo File Paths

After you have uploaded the new logo image, you will need to change the file path in the affected files to direct to the new image.

The following files are affected, which are located in [Ephesoft_Directory]\Application:

Note: You do not need to restart Transact after making changes to the above files. To view your changes, refresh your browser.

Edit the home.html

  1. Open the home.html file, at [Ephesoft_Directory]\Application.
Figure 17. home.html File
  1. Search for “logo_login.svg”.
Figure 18. Edit home.html File
  1. Replace “logo_login.svg” with the new file name.
  2. Adjust the width and height properties as needed.
  3. Save and close the file.

Edit the Login.html File

  1. Open the home.html file, at [Ephesoft_Directory]\Application.
  2. Repeat steps 2-5 from home.html above.

Edit the common.css File

  1. Open the common.css file, at [Ephesoft_Directory]\Application.
  2. Repeat steps 2-5 from home.html above.

The post How to Change the Ephesoft Logo appeared first on Ephesoft Docs.

How to Modify the Custom Column Names

$
0
0

Applies to: Ephesoft Transact 4.0.4.0 and above

This article describes how to modify the Custom1, Custom2, Custom3, & Custom4 names.

Modifying Column Names

You can rename the custom column names by editing the custom column key in the locale.js file.

  1. Open the locale.js file, located at [Ephesoft_Directory]\Application\i18n\<UI Page>\locale.js.
  2. Search for “Custom1”.
screenshot1
Figure 1. locale.js File
  1. Update the custom column names as desired.
  2. Clear the browser cache and verify the column names in Transact. The new names should be visible now.
screenshot2
Figure 2. New Column Names

The post How to Modify the Custom Column Names appeared first on Ephesoft Docs.

Understanding ImageMagick Compression Parameters

$
0
0

Applies to: All versions of Ephesoft Transact

This article will help you understand the recommended compression parameters when configuring the IMPORT_MULTIPAGE_FILES plugin. For more information on the plugin and its use, refer to Import Multipage Files Plugin.

Important: The following parameters are only applicable when the Image Conversion Process is set to IMAGE_MAGICK.

Compression Parameters

ImageMagick provides various compression parameters to compress an image, which varies depending on the quality and size of your original image file:

Uncompressed images

Use a suitable ImageMagick compression parameter that will reduce the size of the image.

  • Colored images: “-compress LZW” or “-compress JPEG”
  • Black and white images: “-compress Group4”

Compressed images

Use the same compression parameter that was previously used to compress the original image.

For example, already compressed images with JPEG compression should use the “-compress JPEG” parameter.

Note: This may increase the size of the image by a small delta, but will maintain the consistency in quality.

Good quality, single-page TIF files

Use any of the following parameters to reduce the size of the image—depending on your specific use case:

  • “-quality”
  • “-depth”
  • “-scale”

Note: In cases where compression is done with image depth, “-depth 1” can be used, which creates black and white images. This is faster than applying compression on black and white images using “-compress Group4”

High-resolution images

If an image resolution is above a particular threshold, then it can be resized to the threshold resolution to reduce the file size and potentially speed up the OCR process.


For more information on ImageMagick compression parameters, refer to the following reference list from ImageMagick.

 

The post Understanding ImageMagick Compression Parameters appeared first on Ephesoft Docs.

KB0014970: ImageMagick Files Quickly Fill temp Folder

$
0
0

Applies to: Ephesoft Transact 4.0.5.2 and above

Issue

ImageMagick files fill up the temp folder when processing large TIF files.

Root Cause

By default, if any module is unable to complete its processing within 2 hours (120 minutes), the module restarts. If any files are still in processing mode, the batch may move into error when it restarts.

Solution

There are two possible ways to resolve this issue:

  • Option A: Enable optimized TIF conversion
  • Option B: Increase the module timeout

Option A

To resolve this issue, you can use the LibTiff library to process TIF files. This process is significantly faster than ImageMagick. We recommend using this switch when your TIF files size exceeds 15 MB, and have higher resolution and bit depth.

  1. From the Batch Class Management screen, select your batch class and click Open.
  2. Go to Modules > Folder Import > IMPORT_MULTIPAGE_FILES.
  3. Set the Optimized Tiff Conversion Switch to ON.
ephe-14970
Figure 1. Enable Optimized TIF Conversion Switch

Option B

To increase the module timeout:

  1. Open the dcma-workflows.properties file, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF.
  2. Locate the activity.restart.time property.
  3. Set the restart time to a higher number that better suits your workflow needs.

Note: This property is set in minutes.

The post KB0014970: ImageMagick Files Quickly Fill temp Folder appeared first on Ephesoft Docs.

Understanding LibTiff

$
0
0

Applies to: Ephesoft Transact 4.0.5.2 and above

LibTiff is an additional utility for creating and optimizing the output TIFF files generated in a batch instance. LibTiff also supports splitting multi-page TIFF files into single TIFF files quickly and efficiently.

Use Cases

Use #1: More efficient handling of multi-page TIFF conversion.

Use #2: Normalization off Single Page TIFF. LibTiff substitutes ImageMagick and creates efficient files that are accurate and light, improving processing and maximizing your output.

Enabling LibTiff

To enable conversion using LibTiff, set the Optimized Tiff Conversion Switch to ON. This is located in Modules > Folder Import > IMPORT_MULTIPAGE_FILES for each batch class.

  • When set to ON: Enables LibTiff to address TIFF conversion for single or multi-page files.
  • When set to OFF: Uses existing approach for TIFF files, as set in the Image Conversion Process property.
2017-01-24_1447
Figure 1. Optimized Tiff Conversion Switch

Note: Using this switch will bypass the ImageMagick output parameters and will not provide control of color or black and white options.

The post Understanding LibTiff appeared first on Ephesoft Docs.


How to Install Checkinstall on RHEL

$
0
0

Applies to: All Linux versions of Ephesoft Transact

This page provides instructions for how to install checkinstall on RedHat Enterprise Linux (RHEL). Checkinstall files are included in the installation zip file from Ephesoft, however Transact does not install checkinstall by default.

If you find an error while installing Ephesoft where it was unable to install ImageMagick or Ghostscript. Check the /var/log/install-ephesoft.log. Scroll up above the Ephesoft ASCII graphics and if you see a mention of the install unable to find checkinstall, you will need to follow the instructions below in order to install checkinstall.

Prerequisites

  • You must be the root user.
  • All required packages must be installed prior to following the instructions listed here. If you need to install the required packages, enter the following command:
sudo yum install unzip rpmdevtools gcc*

Instructions

  1. Download the Ephesoft installer zip file.
  2. Unzip the Ephesoft installer to its own directory.
unzip <zip file name>.zip -d Ephesoft
  1. Change directory to the Ephesoft install directory.
cd Ephesoft
  1. In that directory, you will see a tar.gz file which contains all of the files that will be installed. Extract the checkinstall files from that tar.gz.
tar -xvf ./<tar file name>.tar.gz Ephesoft/Dependencies/checkinstall.tar.gz
  1. Change directory to the newly created Dependencies directory.
cd ./Ephesoft/Dependencies
  1. Decompress the checkinstall.tar.gz file.
tar xzvf ./checkinstall.tar.gz
  1. Change the directory to the newly installed checkinstall directory.
cd checkinstall
  1. Prepare the source code for installation.
make
  1. Compile and install checkinstall.
make install
  1. Verify the installation path of checkinstall is at /usr/local/sbin.
which checkinstall
  1. Verify that /usr/local/sbin is in the path for the root user.
echo $PATH
  1. If the $PATH return does not include /usr/local/sbin, you will need to add it to the path temporarily.
export PATH=$PATH:/usr/local/sbin
  1. Now that you have installed checkinstall, you will have to tell Ephesoft that it is already installed. Start the installation, you may receive an error and close the application.
  2. Once that happens, open the file /etc/Ephesoft/ephesoft.conf and change the value in it for checkinstall from 0 to 1.
  3. Save the file and start the installation over.

Troubleshooting

  1. If you receive the following error when running the “make” command in step 8, then you have not installed gcc first:
[root@localhost checkinstall]# make
for file in locale/checkinstall-*.po ; do \
case ${file} in \
locale/checkinstall-template.po) ;; \
*) \
out='echo $file | sed -s 's/po/mo/'' ; \
msgfmt -o ${out} ${file} ; \
if [ $? != 0 ] ; then \
exit 1 ; \
fi ; \
;; \
esac ; \
done
make -C installwatch
make[1]: Entering directory /path/to/folder/checkinstall/installwatch'
./create-localdecls
Checking truncate argument type... off_t
Checking readlinkat result type... ssize_t
Checking libc version... ./create-localdecls: line 47: gcc: command not found
ldd: ./libctest: No such file or directory
rm: cannot remove 'libctest': No such file or directory
gcc -Wall -c -D_GNU_SOURCE -DPIC -fPIC -D_REENTRANT -DVERSION=\"0.7.0beta7\" installwatch.c
make[1]: gcc: Command not found
make[1]: *** [installwatch.0] Error 127
make[1]: Leaving directory '/path/to/folder/checkinstall/installwatch'
make: *** [1ll] Error 2

2. If you receive the following error when running the “make” command, you will have to modify the /checkinstall/installwatch/installwatch.c file at the lines mentioned in the fix below and then start at step 8 again.

installwatch.c:2942: error: conflicting types for 'readlink'
/usr/include/unistd.h:828: note: previous declaration of 'readlink' was here
installwatch.c:3080: error: conflicting types for 'scandir'
/usr/include/dirent.h:252: note: previous declaration of 'scandir' was here
installwatch.c:3692: error: conflicting types for 'scandir64'
/usr/include/dirent.h:275: note: previous declaration of 'scandir64' was here

Note: When you edit the installwatch.c file, there will be an “if-then” statement for a static int on each item listed. You want them to match, which is what we are doing here.

Make the following changes to the ./checkinstall/installwatch/installwatch.c file:

    1. At line 110, change the “static int” to match the previous “static int”:

Original:

static int (*true_scandir)( const char *,struct dirent ***,
int (*)(const struct dirent *),
int (*)(const void *,const void *));

Edited:

static int (*true_scandir)( const char *,struct dirent ***,
int (*)(const struct dirent *),
int (*)(const struct dirent **,const struct dirent **));
    1. At line 138, change the “static int” to match the previous “static int”:

Original:

static int (*true_scandir64)( const char *,struct dirent64 ***,
int (*)(const struct dirent64 *),
int (*)(const void *,const void *));

Edited:

static int (*true_scandir64)( const char *,struct dirent64 ***,
int (*)(const struct dirent64 *),
int (*)(const struct dirent64 **,const struct dirent64 **));
    1. At line 2959, change:

Original:

#if (GLIBC_MINOR <= 4)

Edited:

#if (0)
    1. At line 3103, change the “static int” to match the previous “static int”:

Original:

int scandir( const char *dir,struct dirent ***namelist,
int (*select)(const struct dirent *),
int (*compar)(const void *,const void *) ) {

Edited:

int scandir( const char *dir,struct dirent ***namelist,
int (*select)(const struct dirent *),
int (*compar)(const struct dirent **,const struct dirent **) ) {[/code]
at line 3719, change the static int to match the previous static int:

Original:

int scandir64( const char *dir,struct dirent64 ***namelist,
int (*select)(const struct dirent64 *),
int (*compar)(const void *,const void *) ) {

Edited:

int scandir64( const char *dir,struct dirent64 ***namelist,
int (*select)(const struct dirent64 *),
int (*compar)(const struct dirent64 **,const struct dirent64 **) ) {

The post How to Install Checkinstall on RHEL appeared first on Ephesoft Docs.

How to Remove a Custom Plugin

$
0
0

Applies to: All versions of Ephesoft Transact

This article provides steps on how to remove a custom plugin from Ephesoft Transact. Custom plugins must be removed from all batch classes. Refer to the section that applies to your version of Transact below.

Note: Take a backup of the database before removing a custom plugin from your workflow.

Ephesoft Transact 2019.1 and Above

  1. Remove the custom plugin folders located at [Ephesoft_Directory]\SharedFolders\export-batch-folder.
  2. Open the server.xml file located at [Ephesoft_Directory]\JavaAppServer\conf.
  3. Verify the location of the customPluginJars folder. A sample location is provided below:
<PostResources base="$
{shared.folders}
\customPluginJars"
className="org.apache.catalina.webresources.DirResourceSet" readOnly="true"
webAppMount="/WEB-INF/lib"/>
  1. Navigate to the customPluginJars folder, the default location is [Ephesoft_Directory]\SharedFolders\customPluginJars.
  2. Remove the customPlugin.jar file from the customPluginJars folder.
  3. Restart Ephesoft Transact.

You have successfully removed a custom plugin from Ephesoft Transact.

Ephesoft Transact 4.5.0.0 and Below

  1. Execute the following queries using your Ephesoft Transact directory <Ephesoft DB Name>.
  2. Select the ID as PLUGIN_ID from the custom plugin where the plugin_name is ‘%PLUGIN_NAME%’;
  3. From the PLUGIN_ID, delete from plugin_dependency where plugin_id = PLUGIN_ID;
  4. Select ID as PLUGIN_CONFIG_ID from plugin_config where plugin_id = PLUGIN_ID;
    • Delete the ID from plugin_config_sample_value where plugin_config_id = PLUGIN_CONFIG_ID;
    • Delete the ID from plugin_config where plugin_id = PLUGIN_ID;
  1. Delete from plugin where id = PLUGIN_ID;
  2. Delete the plugin configurations from the application-Context.xml file in the Ephesoft installation directory sample: <import resource=”classpath:/META-INF/applicationContext-XXX-plugin.xml”/>
  3. Remove the custom plugin .jar file from the lib folder located at [Ephesoft_Directory]\Application\WEB-INF\lib.
  4. Remove the added plugin configuration file from the plugins folder located at [Ephesoft_Directory}\SharedFolders\workflows\plugins.
  5. Restart Ephesoft Transact.

You have successfully removed a custom plugin from Ephesoft Transact.

The post How to Remove a Custom Plugin appeared first on Ephesoft Docs.

Issue with Ephesoft Transact and Chrome 85.0.4183.121

$
0
0

Applies to: All versions of Ephesoft Transact on Google Chrome 85.0.4183.121

Issue

When accessing Ephesoft Transact on Google Chrome version 85.0.4183.121, you may receive the following error message when trying to use the Web Scanner module:

“Ephesoft Transact Scanner Service is not running. Please run the service or install the Ephesoft Transact Scanner Service.”

Figure 1. Web Scanner Error Message

This error message may appear even if the scanner service is currently running.

Additionally, you may have issues with broken display images on the Review and Validate screens.

Solution

To resolve this issue, perform the following steps.

  1. In Google Chrome, go to chrome://flags.
  2. Search for “Reduce default ‘referer’ header granularity”.

Figure 2. Search for Flag

  1. Set the Reduce default ‘referer’ header granularity flag to “Disabled”.

Figure 3. Disable Flag

  1. Click Relaunch in the bottom-right of the page. The flag will be updated after relaunching Google Chrome.

Figure 4. Relaunch Chrome

The post Issue with Ephesoft Transact and Chrome 85.0.4183.121 appeared first on Ephesoft Docs.

Error Uploading Images Remotely

$
0
0

To resolve this issue, you will need administrator permissions.

Issue

When uploading supported images (PDF or TIFF) to KV Extraction or KV Page Process remotely (from the web interface), you may receive the following error, “Error while uploading image. Please try again.” This issue only occurs when accessing Ephesoft Transact remotely and does not occur on the localhost.


Figure 1. Error Message

While the documents are uploaded correctly and can be found in the test-advanced-extraction folder for the batch class (located in Folder Management > SharedFolders > [batch_class] > test-advanced-extraction), they do not load in the browser.


Figure 2. test-advanced-extraction Folder

Root Cause

This issue occurs due to an unreachable URL in the dcma-batch.properties file.

Solution

To resolve this issue, you will need to edit the URL mentioned in the dcma-batch.properties file.

  1. Log in to the localhost as the administrator.

Note: If you do not have Ephesoft Transact installed on your localhost, you will need to run the RDP (Remote Desktop Protocol) client.

  1. Navigate to \Ephesoft\Application\WEB-INF\classes\META-INF\dcma-batch\.


Figure 3. Navigate to dcma-batch Folder

  1. Right-click on the dcma-batch.properties file.
  2. Select Edit with Notepad++.


Figure 4. Edit with Notepad++

  1. Find the following line:
batch.base_http_url=http\://{resolvable_URL}\:8080/dcma-batches

Figure 5. Add to dcma-batch.properties File

  1. Replace {resolvable_URL} with a URL, IP address, or computer name and port reachable from a remote host.
  2. Select File > Save.
  3. Restart the Ephesoft Transact service.

The post Error Uploading Images Remotely appeared first on Ephesoft Docs.

Issue with ImageMagick Filling Temp Folders on Linux

$
0
0

Applies to: All versions of Ephesoft Transact on Linux

Issue

When processing large batch instances, the drive may run out of space. This can cause ImageMagick processes to slow, lockup, or fail.

Root Cause

By default, ImageMagick uses the Linux default temp (/tmp) defined by Linux system environment variables.

Solution

Change the ImageMagick temporary location to a preferred location.

  1. Navigate to [Ephesoft_Directory]/Ephesoft/JavaAppServer/bin.
  2. Locate and backup the setenv.sh file.
  3. Open the setenv.sh file with your editor.
  4. Add the following line at the end of the file:
export MAGICK_TEMPORARY_PATH=<new file path>

For example, if you want to move the ImageMagick path to /opt/Ephesoft/ImageMagickTest, then enter:

export MAGICK_TEMPORARY_PATH=/opt/Ephesoft/ImageMagickTest

Figure 1. setenv.sh File

  1. Restart Transact.
  2. Create a new batch instance and confirm the new ImageMagick location. New ImageMagick conversions will appear in the updated path.

Figure 2. New ImageMagick Location

The post Issue with ImageMagick Filling Temp Folders on Linux appeared first on Ephesoft Docs.

Viewing all 478 articles
Browse latest View live


<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>