<\/a>Introduction<\/h2>\nThis document describes how to configure the Ephesoft Cloud HyperExtender plugin for Ephesoft Transact.<\/p>\n
The Ephesoft Cloud HyperExtender plugin addresses the heaviest processing needs of the Transact workflow by offloading document splitting and optical character recognition (OCR) processing to the Ephesoft Cloud. This allows the customer to manage temporary spikes in workload without having to add new hardware to on-premise or cloud computing environments.<\/p>\n
Note<\/strong>: An Ephesoft Cloud account is required to use the Ephesoft Cloud HyperExtender plugin.<\/p>\nThis document describes how to register for an Ephesoft Cloud account, how to configure Transact to connect to the Ephesoft Cloud, and how to configure Ephesoft Transact to use the Cloud HyperExtender plugin.<\/p>\n
<\/a>Technical Notes and Limitations<\/h3>\n\n- The plugin is only available in the USA.<\/li>\n
- Ephesoft Transact and cloud account creation must be complete, with proper licensing, to configure and use the plugin.<\/li>\n
- The plugin is allotted 1,000 images to be processed per month at no cost for the first 12 months after registration.\n
\n- If further image processing per month is required, please contact our sales team at: sales@ephesoft.com<\/a>.<\/li>\n<\/ul>\n<\/li>\n
- PDF and TIFF are the only document formats supported.<\/li>\n
- EText extraction is not supported with the Ephesoft Cloud HyperExtender plugin.<\/li>\n
- Web services such as uploadBatch and advancedUploadBatch can be used to upload batches into batch classes that have been configured to use the Cloud HyperExtender plugin.<\/li>\n
- Web services that directly communicate with the OCR process (such as OcrClassify, OcrClassifyExtract, v2\/ocrClassifyExtract, v2\/ocrClassifyExtractBase64, initiateOcrClassifyExtract, etc.) cannot interact with a batch class that has been configured to use the Cloud HyperExtender plugin.
\nFor additional information about Ephesoft Transact web services, refer to the following document:<\/p>\n\n- Web Service Definitions and Code Samples<\/a><\/li>\n<\/ul>\n<\/li>\n
- The plugin only supports Oracle 11g (11.2.0) and 12c (12.1.0). Configurations must be made to the property file for Oracle to work as expected. Refer to Using Cloud HyperExtender Plugin with Oracle 11g and 12c<\/a> to perform this workaround. For additional information refer to Platform Configuration and Third-Party Integrations – Transact 2019.1<\/a>.<\/li>\n
- Although the plugin configuration setting displays a list of languages under\u00a0OCR Languages,\u00a0the plugin\u00a0only supports English documents for\u00a0OCR\u00a0processing.<\/li>\n
- The plugin only supports file sizes up to 250MB.<\/li>\n
- The plugin is compatible with Ephesoft Transact servers that are configured with HTTPS when manually configured for Ephesoft Transact. Refer to HTTPS Not Applied to Property Files<\/a>.<\/li>\n
- If you\u2019re importing a Cloud HyperExtender batch class after you\u2019ve imported it, you must then return to the Cloud HyperExtender plugin and resave your settings.<\/li>\n
- The plugin only supports the following PDF types from an import workflow perspective:\n
\n- Searchable<\/li>\n
- Tabbed<\/li>\n
- PDF\/A-1B<\/li>\n
- PDF\/A-2b<\/li>\n
- PDF\/E<\/li>\n
- PDF\/X-4<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
<\/a>Registering for and Configuring Ephesoft Cloud<\/h2>\nThis section describes how to register for an account with Ephesoft Cloud, and how to configure Ephesoft Transact to use the Ephesoft Cloud.<\/p>\n
An Ephesoft Cloud account is required to use the Cloud HyperExtender plugin. Only one Ephesoft Cloud account can be associated with an Ephesoft Transact environment, but that same Ephesoft Cloud account can be used for multiple batch classes.<\/p>\n
Perform the following steps to configure Ephesoft Transact to use the Cloud HyperExtender plugin:<\/p>\n
1. Log in to Transact as an administrator and hover on the menu control on the left side of the application to display the Administrator<\/strong> menu:<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-59.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-2.png\")
<\/p>\n
Administrator menu in navigation pane<\/em><\/span><\/p>\n2. Select System Configuration <\/strong>from the Administrator<\/strong> menu. This displays the Application<\/strong> navigation on the left side of the screen.<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-60.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-3.png\")
<\/p>\n
Ephesoft Cloud component of the Application menu<\/span><\/em><\/p>\n3. Select and expand the Ephesoft Cloud<\/strong> component.<\/p>\nThis displays the Register<\/strong> and Configure<\/strong> components.<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-61.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-4.png\")
<\/p>\n
Ephesoft Cloud<\/strong> components<\/em><\/span><\/p>\n4. Click Register<\/strong>.<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-62.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-5.png\")
<\/p>\n
Register in the Ephesoft Cloud<\/em><\/span><\/p>\nThe Registration<\/strong> screen appears. Complete the registration.<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-63.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-6.png\")
<\/p>\n
Ephesoft Cloud Registration screen<\/span><\/em><\/p>\nThis screen has the following fields:<\/p>\n
\n- \n
\n- \n
\n- First Name<\/strong> \u2014 Enter your first name.<\/li>\n
- Last Name<\/strong> \u2014 Enter your last name.<\/li>\n
- Email Address<\/strong> \u2014 Enter your email address.<\/li>\n
- Company Name<\/strong> \u2014 Enter the company name on record with Ephesoft.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
5. Select Register<\/strong>.<\/p>\na. An email containing a temporary password will be sent to you.<\/p>\n
![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-64.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-7.png\")
<\/p>\n
Click Complete Registration<\/em><\/span><\/p>\nb. Click the Complete Registration<\/strong> link in the email and follow the instructions to select a permanent password.<\/p>\nNote:<\/strong> Your new password must be at least 10 characters long, include both uppercase and lowercase letters, include at least one digit, and one special character (i.e., ^ $ * . [ ] { } ( ) ? – ” ! @ # % & \/ \\ , > < ‘ : ; | _ ~ `).<\/p>\nc. After you choose a new password, an email is sent to you containing all the information necessary to configure your connection to the Ephesoft Cloud.<\/p>\n
![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-65.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-8.png\")
<\/p>\n
Account ID, User Name and Application Key dialog<\/em><\/span><\/p>\n<\/a>Configuring the Ephesoft Cloud Connection<\/h3>\nOnce you have received your Ephesoft Cloud credentials, perform the following steps to configure Ephesoft Transact to communicate with Ephesoft Cloud.<\/p>\n
1. In Transact, navigate to System Configuration > Ephesoft Cloud > Configure<\/strong>. The Cloud Connection Details<\/strong> screen appears.<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-66.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-9.png\")
<\/p>\n
Ephesoft Cloud HyperExtender Connector screen<\/span><\/em><\/p>\n2. Complete the fields in the Cloud Connection Details<\/strong> screen using the credentials sent to you via email.<\/p>\nImportant<\/strong>: Note that Tenant ID<\/strong> may be referred to as Account ID<\/strong> in the email that was sent to you in the previous section.<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-67.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-10.png\")
<\/p>\n
Ephesoft Cloud HyperExtender Connector screen (complete the fields shown)<\/span><\/em><\/p>\n3. Click Save<\/strong>.<\/p>\n4. Click the Edit<\/strong> button if additional changes are needed.<\/p>\n<\/a>Configuring Ephesoft Transact to use the Ephesoft Cloud HyperExtender Plugin<\/h2>\nOnce you have used your Ephesoft Cloud credentials to configure your Ephesoft Transact instance to communicate with Ephesoft Cloud, you can configure Transact to use the Ephesoft Cloud HyperExtender plugin.<\/p>\n
Important<\/strong>: All document types, index fields, and extraction rule configurations must be completed with the existing plugins before you configure the batch class to use the Ephesoft Cloud HyperExtender plugin.<\/p>\nIf you want to configure additional document types, index fields or extraction rules after the Cloud HyperExtender plugin has been configured for a batch class, you will have to turn off the Cloud HyperExtender plugin from your batch class and replace the original plugins before doing any additional document type, index field or extraction rule configuration.<\/p>\n
The Cloud HyperExtender plugin is placed in the Folder Import module and replaces the functionality from a number of existing plugins in the Folder Import and Page Processing modules. To configure a batch class to use the Cloud HyperExtender plugin, you will remove those existing plugins and replace them with the new Cloud HyperExtender plugin.<\/p>\n
Perform the following steps to configure your batch class to work with the Cloud HyperExtender plugin:<\/p>\n
1. Log in to Ephesoft Transact and navigate to the Batch Class Management screen.<\/strong><\/p>\n2. Open the desired batch class for editing.<\/p>\n
3. Edit the Folder Import and Page Process modules as follows:<\/p>\n
a. Remove the following two plugins from the Folder Import module:<\/p>\n
\n- \n
\n- \n
\n- IMPORT_MULTIPAGE_FILES<\/li>\n
- IMPORT_BATCH_FOLDER<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
![](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/word-image-184.png\")
<\/p>\n
Folder Import Module<\/strong> plugins<\/span><\/em><\/p>\nb. Remove the following plugins from the Page Process module:<\/p>\n
\n- \n
\n- \n
\n- CREATE_OCR_INPUT<\/li>\n
- RECOSTAR_HOCR, NUANCE_HOCR or TESSERACT_HOCR (your OCR engine plugin will depend on how your batch class is configured)<\/li>\n
- CREATE_DISPLAY_IMAGE<\/li>\n
- CREATE_THUMBNAILS<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
![](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/word-image-185.png\")
<\/p>\n
Page Process Module<\/strong> plugins<\/span><\/em><\/p>\n4. Add the CLOUD_HYPEREXTENDER_PLUGIN to the Folder Import module.<\/p>\n
![](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/word-image-186.png\")
<\/p>\n
CLOUD_HYPEREXTENDER_PLUGIN<\/em><\/span><\/p>\n5. Save and deploy your changes by clicking the Apply<\/strong> button, then clicking the Deploy<\/strong> button.<\/p>\n6. Select and expand the CLOUD_HYPEREXTENDER_PLUGIN<\/strong> node and click Configure<\/strong>. The Ephesoft Cloud HyperExtender<\/strong> configuration screen is displayed.<\/p>\n![](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/word-image-187.png\")
<\/p>\n
Ephesoft Cloud HyperExtender <\/strong>> Configure<\/strong> Screen<\/em><\/span><\/p>\nUSA is the only option available in the Data Center<\/strong> list, and OCR+ is the only option available in the Product<\/strong> list.<\/p>\n<\/a> English is selected by default in the OCR Languages<\/strong> list <\/a>and is the only language supported for OCR processing despite the other languages that are displayed in this list. Once English is selected, click Save<\/strong>.<\/p>\nNote:<\/strong> The plugin auto-rotates images upon importing to a batch class.<\/p>\nYour batch class is now ready to start processing documents using the Ephesoft Transact Cloud HyperExtender plugin. Create a batch instance using this batch class and verify that the batch is processed successfully.<\/p>\n
<\/a>Optimizing Property Files<\/h3>\nThe following two properties files in Ephesoft Transact contain settings that can be adjusted to achieve higher performance and increase throughput.<\/p>\n
Important<\/strong>: If you make any changes to either of these following two properties files, you must restart the Ephesoft Transact service.<\/p>\n\n- dcma-workflows.properties<\/a><\/li>\n
- application.properties <\/a><\/li>\n<\/ul>\n
Note<\/strong>: Ephesoft Transact contains two files by the name of application.properties. This document only discusses the application.properties file for the Cloud HyperExtender plugin.<\/p>\n<\/a><\/a>dcma-workflows.properties File<\/h4>\nThis file is located in the following path:<\/p>\n
<Installation Directory><\/em>\/Application\/WEB-INF\/classes\/META-INF\/dcma-workflows\/dcma-workflows.properties<\/strong><\/p>\nThis file contains properties that allow you to increase the number of parallel batch processing for optimizing cloud operations:<\/p>\n
#server.instance.max.process.capacity.mode governs the calculation of server.instance.max.process.capacity value.\r\n#0 means calculation will be dynamic that depends on system configurations and results of performance testing.\r\n#1 means calculation will static and value will be picked from the property server.instance.max.process.capacity\r\nserver.instance.max.process.capacity.mode=0\r\nserver.instance.max.process.capacity=5<\/pre>\nChanging the server.instance.max.process.capacity.mode<\/strong> from 0 <\/strong>(default) to 1<\/strong> and setting the service.instance.max.process.capacity<\/strong> can increase the number of parallel batches processing that can occur.<\/p>\n\n- For smaller batches (roughly 100 pages per batch) Ephesoft recommends setting the server.instance.max.process.capacity<\/strong> value between 15 and 20 for maximum performance. This number should be reduced to 5 (the default setting) when you are only processing on-premise.<\/li>\n
- For mid-range or larger batches (roughly 1000 pages per batch), Ephesoft recommends that you keep the default setting for server.instance.max.process.capacity<\/strong>.<\/li>\n<\/ul>\n
<\/a><\/a><\/a>application.properties File<\/h4>\nThis file is located in the following path:<\/p>\n
C:\\Ephesoft\\JavaAppServer\\webapps\\ephesoft-cloud-client\\WEB-INF\\classes\\application.properties<\/strong><\/p>\nThis properties file has the following configuration that can improve performance in cloud operations:<\/p>\n
# Upload\/Download Action\r\ncloud.action.upload-download.thread-count=10<\/pre>\nThis value can be used to increase or decrease the number of pages or files that can be downloaded or uploaded at a time, from the cloud onto a Transact instance. If you encounter any decrease in performance, you can decrease this thread-count number to be less than 10.<\/p>\n
<\/a>Ephesoft Cloud Portal<\/h2>\nYou can log in to the Ephesoft Cloud portal (https:\/\/transact.us.ephesoftcloud.com<\/a>) to view how many images you have processed with the Cloud HyperExtender plugin.<\/p>\n![\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/sites\/11\/2019\/01\/word-image-80.png\"](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/https-ephesoft-com-docs-wp-content-uploads-sites-11.png\")
<\/p>\n
Ephesoft Cloud Portal<\/em><\/span><\/p>\n<\/a>Troubleshooting<\/h2>\n<\/a>Log File<\/h3>\nThe log file for the Ephesoft Cloud HyperExtender plugin is available in the following location:<\/p>\n
<Ephesoft Installation Folder>\/<\/em>JavaAppServer\/webapps\/ephesoft-cloud-client\/WEB-INF\/classes\/log\/cloud-client.log<\/strong><\/p>\n<\/a>Incomplete Registration<\/h3>\nIf you attempt to configure the Cloud HyperExtender plugin with invalid connection details, the following error message appears:<\/p>\n
Ephesoft Cloud registration is incomplete. Please ask your system administrator to register first. <\/strong><\/p>\nIf this problem occurs, contact your Transact system administrator.<\/p>\n
<\/a>Test Classification and Extraction<\/h3>\nWhen the Ephesoft Cloud HyperExtender plugin is configured and enabled within a batch class, the Test Classification and Test Extraction actions will not work in that batch class. The following error message will be displayed:<\/p>\n
Error occurred while breaking multipage tiff or pdf. <\/strong><\/p>\nThis error is expected, as these actions are not supported in batch classes that are configured to use the Ephesoft Cloud HyperExtender plugin.<\/p>\n
<\/a>Saving the Cloud HyperExtender Configuration<\/h3>\nIf a cloud-enabled batch fails, ensure that you have saved the Ephesoft Transact Cloud HyperExtender configuration in the respective batch class.<\/p>\n
1. Open the batch class.<\/p>\n
2. Navigate to Modules > Folder Import > CLOUD_HYPEREXTENDER_PLUGIN > Configure<\/strong>.<\/p>\nThe Ephesoft Cloud HyperExtender<\/strong> configuration screen is displayed.<\/p>\n![](\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/10\/word-image-188.png\")
<\/p>\n
Ephesoft Cloud HyperExtender <\/strong>> Configure<\/strong> Screen<\/span><\/em><\/p>\n3. Ensure that the plugin is configured and enabled and that you click Save<\/strong> to retain changes.<\/p>\n<\/a><\/a>HTTPS Not Applied to Property Files<\/h3>\nIf your Cloud HyperExtender batches fail with error message, \u201cI\/O error on POST request for \u201chttp:\/\/…\u201d (via the Batch Execution<\/strong> details pane in the Batch Instance<\/strong> screen), and Ephesoft Transact is installed as HTTPS, perform the workaround below to correct the error and change the property files. The same error can be seen in greater detail in the dcma-all.log <\/strong>(located in the following path:<Transact-Installation-Folder><\/em><\/strong>\/Application\/logs\/).<\/p>\n\n- Open the application.properties<\/strong> file in the following path:<\/li>\n<\/ol>\n
<Transact Installation Folder><\/em>\/JavaAppServer\/webapps\/ephesoft-cloud-client\/WEB-INF\/classes<\/strong><\/p>\n\n- Locate the following property: cloud.notification.transact-hybrid url.<\/strong><\/li>\n
- Change the property from http:\/\/localhost:8080\/dcma\/ws\/hybridplugin\/status\/notify to https:\/\/localhost:<port number><\/em>\/dcma\/ws\/hybridplugin\/status\/notify.<\/strong><\/li>\n
- Open the cloud-plugin.properties<\/strong> file in the following path:<\/li>\n<\/ol>\n
<Transact Installation Folder><\/em>\/Application\/WEB-INF\/classes\/META-INF\/cloud-plugin\/<\/strong><\/p>\n\n- Locate the following property: cloud.client.url <\/strong><\/li>\n
- Change the property from http:\/\/localhost:8080\/ephesoft-cloud-client to https:\/\/localhost:
This document describes how to register for an Ephesoft Cloud account, how to configure Transact to connect to the Ephesoft Cloud, and how to configure Ephesoft Transact to use the Cloud HyperExtender plugin.<\/p>\n
<\/a>Technical Notes and Limitations<\/h3>\n\n- The plugin is only available in the USA.<\/li>\n
- Ephesoft Transact and cloud account creation must be complete, with proper licensing, to configure and use the plugin.<\/li>\n
- The plugin is allotted 1,000 images to be processed per month at no cost for the first 12 months after registration.\n
\n- If further image processing per month is required, please contact our sales team at: sales@ephesoft.com<\/a>.<\/li>\n<\/ul>\n<\/li>\n
- PDF and TIFF are the only document formats supported.<\/li>\n
- EText extraction is not supported with the Ephesoft Cloud HyperExtender plugin.<\/li>\n
- Web services such as uploadBatch and advancedUploadBatch can be used to upload batches into batch classes that have been configured to use the Cloud HyperExtender plugin.<\/li>\n
- Web services that directly communicate with the OCR process (such as OcrClassify, OcrClassifyExtract, v2\/ocrClassifyExtract, v2\/ocrClassifyExtractBase64, initiateOcrClassifyExtract, etc.) cannot interact with a batch class that has been configured to use the Cloud HyperExtender plugin.
\nFor additional information about Ephesoft Transact web services, refer to the following document:<\/p>\n\n- Web Service Definitions and Code Samples<\/a><\/li>\n<\/ul>\n<\/li>\n
- The plugin only supports Oracle 11g (11.2.0) and 12c (12.1.0). Configurations must be made to the property file for Oracle to work as expected. Refer to Using Cloud HyperExtender Plugin with Oracle 11g and 12c<\/a> to perform this workaround. For additional information refer to Platform Configuration and Third-Party Integrations – Transact 2019.1<\/a>.<\/li>\n
- Although the plugin configuration setting displays a list of languages under\u00a0OCR Languages,\u00a0the plugin\u00a0only supports English documents for\u00a0OCR\u00a0processing.<\/li>\n
- The plugin only supports file sizes up to 250MB.<\/li>\n
- The plugin is compatible with Ephesoft Transact servers that are configured with HTTPS when manually configured for Ephesoft Transact. Refer to HTTPS Not Applied to Property Files<\/a>.<\/li>\n
- If you\u2019re importing a Cloud HyperExtender batch class after you\u2019ve imported it, you must then return to the Cloud HyperExtender plugin and resave your settings.<\/li>\n
- The plugin only supports the following PDF types from an import workflow perspective:\n
\n- Searchable<\/li>\n
- Tabbed<\/li>\n
- PDF\/A-1B<\/li>\n
- PDF\/A-2b<\/li>\n
- PDF\/E<\/li>\n
- PDF\/X-4<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
<\/a>Registering for and Configuring Ephesoft Cloud<\/h2>\nThis section describes how to register for an account with Ephesoft Cloud, and how to configure Ephesoft Transact to use the Ephesoft Cloud.<\/p>\n
An Ephesoft Cloud account is required to use the Cloud HyperExtender plugin. Only one Ephesoft Cloud account can be associated with an Ephesoft Transact environment, but that same Ephesoft Cloud account can be used for multiple batch classes.<\/p>\n
Perform the following steps to configure Ephesoft Transact to use the Cloud HyperExtender plugin:<\/p>\n
1. Log in to Transact as an administrator and hover on the menu control on the left side of the application to display the Administrator<\/strong> menu:<\/p>\n<\/p>\n
Administrator menu in navigation pane<\/em><\/span><\/p>\n2. Select System Configuration <\/strong>from the Administrator<\/strong> menu. This displays the Application<\/strong> navigation on the left side of the screen.<\/p>\n<\/p>\n
Ephesoft Cloud component of the Application menu<\/span><\/em><\/p>\n3. Select and expand the Ephesoft Cloud<\/strong> component.<\/p>\nThis displays the Register<\/strong> and Configure<\/strong> components.<\/p>\n<\/p>\n
Ephesoft Cloud<\/strong> components<\/em><\/span><\/p>\n4. Click Register<\/strong>.<\/p>\n<\/p>\n
Register in the Ephesoft Cloud<\/em><\/span><\/p>\nThe Registration<\/strong> screen appears. Complete the registration.<\/p>\n<\/p>\n
Ephesoft Cloud Registration screen<\/span><\/em><\/p>\nThis screen has the following fields:<\/p>\n
\n- \n
\n- \n
\n- First Name<\/strong> \u2014 Enter your first name.<\/li>\n
- Last Name<\/strong> \u2014 Enter your last name.<\/li>\n
- Email Address<\/strong> \u2014 Enter your email address.<\/li>\n
- Company Name<\/strong> \u2014 Enter the company name on record with Ephesoft.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
5. Select Register<\/strong>.<\/p>\na. An email containing a temporary password will be sent to you.<\/p>\n
<\/p>\n
Click Complete Registration<\/em><\/span><\/p>\nb. Click the Complete Registration<\/strong> link in the email and follow the instructions to select a permanent password.<\/p>\nNote:<\/strong> Your new password must be at least 10 characters long, include both uppercase and lowercase letters, include at least one digit, and one special character (i.e., ^ $ * . [ ] { } ( ) ? – ” ! @ # % & \/ \\ , > < ‘ : ; | _ ~ `).<\/p>\nc. After you choose a new password, an email is sent to you containing all the information necessary to configure your connection to the Ephesoft Cloud.<\/p>\n
<\/p>\n
Account ID, User Name and Application Key dialog<\/em><\/span><\/p>\n<\/a>Configuring the Ephesoft Cloud Connection<\/h3>\nOnce you have received your Ephesoft Cloud credentials, perform the following steps to configure Ephesoft Transact to communicate with Ephesoft Cloud.<\/p>\n
1. In Transact, navigate to System Configuration > Ephesoft Cloud > Configure<\/strong>. The Cloud Connection Details<\/strong> screen appears.<\/p>\n<\/p>\n
Ephesoft Cloud HyperExtender Connector screen<\/span><\/em><\/p>\n2. Complete the fields in the Cloud Connection Details<\/strong> screen using the credentials sent to you via email.<\/p>\nImportant<\/strong>: Note that Tenant ID<\/strong> may be referred to as Account ID<\/strong> in the email that was sent to you in the previous section.<\/p>\n<\/p>\n
Ephesoft Cloud HyperExtender Connector screen (complete the fields shown)<\/span><\/em><\/p>\n3. Click Save<\/strong>.<\/p>\n4. Click the Edit<\/strong> button if additional changes are needed.<\/p>\n<\/a>Configuring Ephesoft Transact to use the Ephesoft Cloud HyperExtender Plugin<\/h2>\nOnce you have used your Ephesoft Cloud credentials to configure your Ephesoft Transact instance to communicate with Ephesoft Cloud, you can configure Transact to use the Ephesoft Cloud HyperExtender plugin.<\/p>\n
Important<\/strong>: All document types, index fields, and extraction rule configurations must be completed with the existing plugins before you configure the batch class to use the Ephesoft Cloud HyperExtender plugin.<\/p>\nIf you want to configure additional document types, index fields or extraction rules after the Cloud HyperExtender plugin has been configured for a batch class, you will have to turn off the Cloud HyperExtender plugin from your batch class and replace the original plugins before doing any additional document type, index field or extraction rule configuration.<\/p>\n
The Cloud HyperExtender plugin is placed in the Folder Import module and replaces the functionality from a number of existing plugins in the Folder Import and Page Processing modules. To configure a batch class to use the Cloud HyperExtender plugin, you will remove those existing plugins and replace them with the new Cloud HyperExtender plugin.<\/p>\n
Perform the following steps to configure your batch class to work with the Cloud HyperExtender plugin:<\/p>\n
1. Log in to Ephesoft Transact and navigate to the Batch Class Management screen.<\/strong><\/p>\n2. Open the desired batch class for editing.<\/p>\n
3. Edit the Folder Import and Page Process modules as follows:<\/p>\n
a. Remove the following two plugins from the Folder Import module:<\/p>\n
\n- \n
\n- \n
\n- IMPORT_MULTIPAGE_FILES<\/li>\n
- IMPORT_BATCH_FOLDER<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
<\/p>\n
Folder Import Module<\/strong> plugins<\/span><\/em><\/p>\nb. Remove the following plugins from the Page Process module:<\/p>\n
\n- \n
\n- \n
\n- CREATE_OCR_INPUT<\/li>\n
- RECOSTAR_HOCR, NUANCE_HOCR or TESSERACT_HOCR (your OCR engine plugin will depend on how your batch class is configured)<\/li>\n
- CREATE_DISPLAY_IMAGE<\/li>\n
- CREATE_THUMBNAILS<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
<\/p>\n
Page Process Module<\/strong> plugins<\/span><\/em><\/p>\n4. Add the CLOUD_HYPEREXTENDER_PLUGIN to the Folder Import module.<\/p>\n
<\/p>\n
CLOUD_HYPEREXTENDER_PLUGIN<\/em><\/span><\/p>\n5. Save and deploy your changes by clicking the Apply<\/strong> button, then clicking the Deploy<\/strong> button.<\/p>\n6. Select and expand the CLOUD_HYPEREXTENDER_PLUGIN<\/strong> node and click Configure<\/strong>. The Ephesoft Cloud HyperExtender<\/strong> configuration screen is displayed.<\/p>\n<\/p>\n
Ephesoft Cloud HyperExtender <\/strong>> Configure<\/strong> Screen<\/em><\/span><\/p>\nUSA is the only option available in the Data Center<\/strong> list, and OCR+ is the only option available in the Product<\/strong> list.<\/p>\n<\/a> English is selected by default in the OCR Languages<\/strong> list <\/a>and is the only language supported for OCR processing despite the other languages that are displayed in this list. Once English is selected, click Save<\/strong>.<\/p>\nNote:<\/strong> The plugin auto-rotates images upon importing to a batch class.<\/p>\nYour batch class is now ready to start processing documents using the Ephesoft Transact Cloud HyperExtender plugin. Create a batch instance using this batch class and verify that the batch is processed successfully.<\/p>\n
<\/a>Optimizing Property Files<\/h3>\nThe following two properties files in Ephesoft Transact contain settings that can be adjusted to achieve higher performance and increase throughput.<\/p>\n
Important<\/strong>: If you make any changes to either of these following two properties files, you must restart the Ephesoft Transact service.<\/p>\n\n- dcma-workflows.properties<\/a><\/li>\n
- application.properties <\/a><\/li>\n<\/ul>\n
Note<\/strong>: Ephesoft Transact contains two files by the name of application.properties. This document only discusses the application.properties file for the Cloud HyperExtender plugin.<\/p>\n<\/a><\/a>dcma-workflows.properties File<\/h4>\nThis file is located in the following path:<\/p>\n
<Installation Directory><\/em>\/Application\/WEB-INF\/classes\/META-INF\/dcma-workflows\/dcma-workflows.properties<\/strong><\/p>\nThis file contains properties that allow you to increase the number of parallel batch processing for optimizing cloud operations:<\/p>\n
#server.instance.max.process.capacity.mode governs the calculation of server.instance.max.process.capacity value.\r\n#0 means calculation will be dynamic that depends on system configurations and results of performance testing.\r\n#1 means calculation will static and value will be picked from the property server.instance.max.process.capacity\r\nserver.instance.max.process.capacity.mode=0\r\nserver.instance.max.process.capacity=5<\/pre>\nChanging the server.instance.max.process.capacity.mode<\/strong> from 0 <\/strong>(default) to 1<\/strong> and setting the service.instance.max.process.capacity<\/strong> can increase the number of parallel batches processing that can occur.<\/p>\n\n- For smaller batches (roughly 100 pages per batch) Ephesoft recommends setting the server.instance.max.process.capacity<\/strong> value between 15 and 20 for maximum performance. This number should be reduced to 5 (the default setting) when you are only processing on-premise.<\/li>\n
- For mid-range or larger batches (roughly 1000 pages per batch), Ephesoft recommends that you keep the default setting for server.instance.max.process.capacity<\/strong>.<\/li>\n<\/ul>\n
<\/a><\/a><\/a>application.properties File<\/h4>\nThis file is located in the following path:<\/p>\n
C:\\Ephesoft\\JavaAppServer\\webapps\\ephesoft-cloud-client\\WEB-INF\\classes\\application.properties<\/strong><\/p>\nThis properties file has the following configuration that can improve performance in cloud operations:<\/p>\n
# Upload\/Download Action\r\ncloud.action.upload-download.thread-count=10<\/pre>\nThis value can be used to increase or decrease the number of pages or files that can be downloaded or uploaded at a time, from the cloud onto a Transact instance. If you encounter any decrease in performance, you can decrease this thread-count number to be less than 10.<\/p>\n
<\/a>Ephesoft Cloud Portal<\/h2>\nYou can log in to the Ephesoft Cloud portal (https:\/\/transact.us.ephesoftcloud.com<\/a>) to view how many images you have processed with the Cloud HyperExtender plugin.<\/p>\n<\/p>\n
Ephesoft Cloud Portal<\/em><\/span><\/p>\n<\/a>Troubleshooting<\/h2>\n<\/a>Log File<\/h3>\nThe log file for the Ephesoft Cloud HyperExtender plugin is available in the following location:<\/p>\n
<Ephesoft Installation Folder>\/<\/em>JavaAppServer\/webapps\/ephesoft-cloud-client\/WEB-INF\/classes\/log\/cloud-client.log<\/strong><\/p>\n<\/a>Incomplete Registration<\/h3>\nIf you attempt to configure the Cloud HyperExtender plugin with invalid connection details, the following error message appears:<\/p>\n
Ephesoft Cloud registration is incomplete. Please ask your system administrator to register first. <\/strong><\/p>\nIf this problem occurs, contact your Transact system administrator.<\/p>\n
<\/a>Test Classification and Extraction<\/h3>\nWhen the Ephesoft Cloud HyperExtender plugin is configured and enabled within a batch class, the Test Classification and Test Extraction actions will not work in that batch class. The following error message will be displayed:<\/p>\n
Error occurred while breaking multipage tiff or pdf. <\/strong><\/p>\nThis error is expected, as these actions are not supported in batch classes that are configured to use the Ephesoft Cloud HyperExtender plugin.<\/p>\n
<\/a>Saving the Cloud HyperExtender Configuration<\/h3>\nIf a cloud-enabled batch fails, ensure that you have saved the Ephesoft Transact Cloud HyperExtender configuration in the respective batch class.<\/p>\n
1. Open the batch class.<\/p>\n
2. Navigate to Modules > Folder Import > CLOUD_HYPEREXTENDER_PLUGIN > Configure<\/strong>.<\/p>\nThe Ephesoft Cloud HyperExtender<\/strong> configuration screen is displayed.<\/p>\n<\/p>\n
Ephesoft Cloud HyperExtender <\/strong>> Configure<\/strong> Screen<\/span><\/em><\/p>\n3. Ensure that the plugin is configured and enabled and that you click Save<\/strong> to retain changes.<\/p>\n<\/a><\/a>HTTPS Not Applied to Property Files<\/h3>\nIf your Cloud HyperExtender batches fail with error message, \u201cI\/O error on POST request for \u201chttp:\/\/…\u201d (via the Batch Execution<\/strong> details pane in the Batch Instance<\/strong> screen), and Ephesoft Transact is installed as HTTPS, perform the workaround below to correct the error and change the property files. The same error can be seen in greater detail in the dcma-all.log <\/strong>(located in the following path:<Transact-Installation-Folder><\/em><\/strong>\/Application\/logs\/).<\/p>\n\n- Open the application.properties<\/strong> file in the following path:<\/li>\n<\/ol>\n
<Transact Installation Folder><\/em>\/JavaAppServer\/webapps\/ephesoft-cloud-client\/WEB-INF\/classes<\/strong><\/p>\n\n- Locate the following property: cloud.notification.transact-hybrid url.<\/strong><\/li>\n
- Change the property from http:\/\/localhost:8080\/dcma\/ws\/hybridplugin\/status\/notify to https:\/\/localhost:<port number><\/em>\/dcma\/ws\/hybridplugin\/status\/notify.<\/strong><\/li>\n
- Open the cloud-plugin.properties<\/strong> file in the following path:<\/li>\n<\/ol>\n
<Transact Installation Folder><\/em>\/Application\/WEB-INF\/classes\/META-INF\/cloud-plugin\/<\/strong><\/p>\n\n- Locate the following property: cloud.client.url <\/strong><\/li>\n
- Change the property from http:\/\/localhost:8080\/ephesoft-cloud-client to https:\/\/localhost:
- \n
- If further image processing per month is required, please contact our sales team at: sales@ephesoft.com<\/a>.<\/li>\n<\/ul>\n<\/li>\n
- PDF and TIFF are the only document formats supported.<\/li>\n
- EText extraction is not supported with the Ephesoft Cloud HyperExtender plugin.<\/li>\n
- Web services such as uploadBatch and advancedUploadBatch can be used to upload batches into batch classes that have been configured to use the Cloud HyperExtender plugin.<\/li>\n
- Web services that directly communicate with the OCR process (such as OcrClassify, OcrClassifyExtract, v2\/ocrClassifyExtract, v2\/ocrClassifyExtractBase64, initiateOcrClassifyExtract, etc.) cannot interact with a batch class that has been configured to use the Cloud HyperExtender plugin.
\nFor additional information about Ephesoft Transact web services, refer to the following document:<\/p>\n- \n
- Web Service Definitions and Code Samples<\/a><\/li>\n<\/ul>\n<\/li>\n
- The plugin only supports Oracle 11g (11.2.0) and 12c (12.1.0). Configurations must be made to the property file for Oracle to work as expected. Refer to Using Cloud HyperExtender Plugin with Oracle 11g and 12c<\/a> to perform this workaround. For additional information refer to Platform Configuration and Third-Party Integrations – Transact 2019.1<\/a>.<\/li>\n
- Although the plugin configuration setting displays a list of languages under\u00a0OCR Languages,\u00a0the plugin\u00a0only supports English documents for\u00a0OCR\u00a0processing.<\/li>\n
- The plugin only supports file sizes up to 250MB.<\/li>\n
- The plugin is compatible with Ephesoft Transact servers that are configured with HTTPS when manually configured for Ephesoft Transact. Refer to HTTPS Not Applied to Property Files<\/a>.<\/li>\n
- If you\u2019re importing a Cloud HyperExtender batch class after you\u2019ve imported it, you must then return to the Cloud HyperExtender plugin and resave your settings.<\/li>\n
- The plugin only supports the following PDF types from an import workflow perspective:\n
- \n
- Searchable<\/li>\n
- Tabbed<\/li>\n
- PDF\/A-1B<\/li>\n
- PDF\/A-2b<\/li>\n
- PDF\/E<\/li>\n
- PDF\/X-4<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
<\/a>Registering for and Configuring Ephesoft Cloud<\/h2>\n
This section describes how to register for an account with Ephesoft Cloud, and how to configure Ephesoft Transact to use the Ephesoft Cloud.<\/p>\n
An Ephesoft Cloud account is required to use the Cloud HyperExtender plugin. Only one Ephesoft Cloud account can be associated with an Ephesoft Transact environment, but that same Ephesoft Cloud account can be used for multiple batch classes.<\/p>\n
Perform the following steps to configure Ephesoft Transact to use the Cloud HyperExtender plugin:<\/p>\n
1. Log in to Transact as an administrator and hover on the menu control on the left side of the application to display the Administrator<\/strong> menu:<\/p>\n
<\/p>\nAdministrator menu in navigation pane<\/em><\/span><\/p>\n
2. Select System Configuration <\/strong>from the Administrator<\/strong> menu. This displays the Application<\/strong> navigation on the left side of the screen.<\/p>\n
<\/p>\nEphesoft Cloud component of the Application menu<\/span><\/em><\/p>\n
3. Select and expand the Ephesoft Cloud<\/strong> component.<\/p>\n
This displays the Register<\/strong> and Configure<\/strong> components.<\/p>\n
<\/p>\nEphesoft Cloud<\/strong> components<\/em><\/span><\/p>\n
4. Click Register<\/strong>.<\/p>\n
<\/p>\nRegister in the Ephesoft Cloud<\/em><\/span><\/p>\n
The Registration<\/strong> screen appears. Complete the registration.<\/p>\n
<\/p>\nEphesoft Cloud Registration screen<\/span><\/em><\/p>\n
This screen has the following fields:<\/p>\n
- \n
- \n
- \n
- \n
- \n
- First Name<\/strong> \u2014 Enter your first name.<\/li>\n
- Last Name<\/strong> \u2014 Enter your last name.<\/li>\n
- Email Address<\/strong> \u2014 Enter your email address.<\/li>\n
- Company Name<\/strong> \u2014 Enter the company name on record with Ephesoft.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
5. Select Register<\/strong>.<\/p>\n
a. An email containing a temporary password will be sent to you.<\/p>\n
<\/p>\nClick Complete Registration<\/em><\/span><\/p>\n
b. Click the Complete Registration<\/strong> link in the email and follow the instructions to select a permanent password.<\/p>\n
Note:<\/strong> Your new password must be at least 10 characters long, include both uppercase and lowercase letters, include at least one digit, and one special character (i.e., ^ $ * . [ ] { } ( ) ? – ” ! @ # % & \/ \\ , > < ‘ : ; | _ ~ `).<\/p>\n
c. After you choose a new password, an email is sent to you containing all the information necessary to configure your connection to the Ephesoft Cloud.<\/p>\n
<\/p>\nAccount ID, User Name and Application Key dialog<\/em><\/span><\/p>\n
<\/a>Configuring the Ephesoft Cloud Connection<\/h3>\n
Once you have received your Ephesoft Cloud credentials, perform the following steps to configure Ephesoft Transact to communicate with Ephesoft Cloud.<\/p>\n
1. In Transact, navigate to System Configuration > Ephesoft Cloud > Configure<\/strong>. The Cloud Connection Details<\/strong> screen appears.<\/p>\n
<\/p>\nEphesoft Cloud HyperExtender Connector screen<\/span><\/em><\/p>\n
2. Complete the fields in the Cloud Connection Details<\/strong> screen using the credentials sent to you via email.<\/p>\n
Important<\/strong>: Note that Tenant ID<\/strong> may be referred to as Account ID<\/strong> in the email that was sent to you in the previous section.<\/p>\n
<\/p>\nEphesoft Cloud HyperExtender Connector screen (complete the fields shown)<\/span><\/em><\/p>\n
3. Click Save<\/strong>.<\/p>\n
4. Click the Edit<\/strong> button if additional changes are needed.<\/p>\n
<\/a>Configuring Ephesoft Transact to use the Ephesoft Cloud HyperExtender Plugin<\/h2>\n
Once you have used your Ephesoft Cloud credentials to configure your Ephesoft Transact instance to communicate with Ephesoft Cloud, you can configure Transact to use the Ephesoft Cloud HyperExtender plugin.<\/p>\n
Important<\/strong>: All document types, index fields, and extraction rule configurations must be completed with the existing plugins before you configure the batch class to use the Ephesoft Cloud HyperExtender plugin.<\/p>\n
If you want to configure additional document types, index fields or extraction rules after the Cloud HyperExtender plugin has been configured for a batch class, you will have to turn off the Cloud HyperExtender plugin from your batch class and replace the original plugins before doing any additional document type, index field or extraction rule configuration.<\/p>\n
The Cloud HyperExtender plugin is placed in the Folder Import module and replaces the functionality from a number of existing plugins in the Folder Import and Page Processing modules. To configure a batch class to use the Cloud HyperExtender plugin, you will remove those existing plugins and replace them with the new Cloud HyperExtender plugin.<\/p>\n
Perform the following steps to configure your batch class to work with the Cloud HyperExtender plugin:<\/p>\n
1. Log in to Ephesoft Transact and navigate to the Batch Class Management screen.<\/strong><\/p>\n
2. Open the desired batch class for editing.<\/p>\n
3. Edit the Folder Import and Page Process modules as follows:<\/p>\n
a. Remove the following two plugins from the Folder Import module:<\/p>\n
- \n
- \n
- \n
- \n
- \n
- IMPORT_MULTIPAGE_FILES<\/li>\n
- IMPORT_BATCH_FOLDER<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/p>\n
Folder Import Module<\/strong> plugins<\/span><\/em><\/p>\n
b. Remove the following plugins from the Page Process module:<\/p>\n
- \n
- \n
- \n
- \n
- \n
- CREATE_OCR_INPUT<\/li>\n
- RECOSTAR_HOCR, NUANCE_HOCR or TESSERACT_HOCR (your OCR engine plugin will depend on how your batch class is configured)<\/li>\n
- CREATE_DISPLAY_IMAGE<\/li>\n
- CREATE_THUMBNAILS<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/p>\n
Page Process Module<\/strong> plugins<\/span><\/em><\/p>\n
4. Add the CLOUD_HYPEREXTENDER_PLUGIN to the Folder Import module.<\/p>\n
<\/p>\nCLOUD_HYPEREXTENDER_PLUGIN<\/em><\/span><\/p>\n
5. Save and deploy your changes by clicking the Apply<\/strong> button, then clicking the Deploy<\/strong> button.<\/p>\n
6. Select and expand the CLOUD_HYPEREXTENDER_PLUGIN<\/strong> node and click Configure<\/strong>. The Ephesoft Cloud HyperExtender<\/strong> configuration screen is displayed.<\/p>\n
<\/p>\nEphesoft Cloud HyperExtender <\/strong>> Configure<\/strong> Screen<\/em><\/span><\/p>\n
USA is the only option available in the Data Center<\/strong> list, and OCR+ is the only option available in the Product<\/strong> list.<\/p>\n
<\/a> English is selected by default in the OCR Languages<\/strong> list <\/a>and is the only language supported for OCR processing despite the other languages that are displayed in this list. Once English is selected, click Save<\/strong>.<\/p>\n
Note:<\/strong> The plugin auto-rotates images upon importing to a batch class.<\/p>\n
Your batch class is now ready to start processing documents using the Ephesoft Transact Cloud HyperExtender plugin. Create a batch instance using this batch class and verify that the batch is processed successfully.<\/p>\n
<\/a>Optimizing Property Files<\/h3>\n
The following two properties files in Ephesoft Transact contain settings that can be adjusted to achieve higher performance and increase throughput.<\/p>\n
Important<\/strong>: If you make any changes to either of these following two properties files, you must restart the Ephesoft Transact service.<\/p>\n
- \n
- dcma-workflows.properties<\/a><\/li>\n
- application.properties <\/a><\/li>\n<\/ul>\n
Note<\/strong>: Ephesoft Transact contains two files by the name of application.properties. This document only discusses the application.properties file for the Cloud HyperExtender plugin.<\/p>\n
<\/a><\/a>dcma-workflows.properties File<\/h4>\n
This file is located in the following path:<\/p>\n
<Installation Directory><\/em>\/Application\/WEB-INF\/classes\/META-INF\/dcma-workflows\/dcma-workflows.properties<\/strong><\/p>\n
This file contains properties that allow you to increase the number of parallel batch processing for optimizing cloud operations:<\/p>\n
#server.instance.max.process.capacity.mode governs the calculation of server.instance.max.process.capacity value.\r\n#0 means calculation will be dynamic that depends on system configurations and results of performance testing.\r\n#1 means calculation will static and value will be picked from the property server.instance.max.process.capacity\r\nserver.instance.max.process.capacity.mode=0\r\nserver.instance.max.process.capacity=5<\/pre>\n
Changing the server.instance.max.process.capacity.mode<\/strong> from 0 <\/strong>(default) to 1<\/strong> and setting the service.instance.max.process.capacity<\/strong> can increase the number of parallel batches processing that can occur.<\/p>\n
- \n
- For smaller batches (roughly 100 pages per batch) Ephesoft recommends setting the server.instance.max.process.capacity<\/strong> value between 15 and 20 for maximum performance. This number should be reduced to 5 (the default setting) when you are only processing on-premise.<\/li>\n
- For mid-range or larger batches (roughly 1000 pages per batch), Ephesoft recommends that you keep the default setting for server.instance.max.process.capacity<\/strong>.<\/li>\n<\/ul>\n
<\/a><\/a><\/a>application.properties File<\/h4>\n
This file is located in the following path:<\/p>\n
C:\\Ephesoft\\JavaAppServer\\webapps\\ephesoft-cloud-client\\WEB-INF\\classes\\application.properties<\/strong><\/p>\n
This properties file has the following configuration that can improve performance in cloud operations:<\/p>\n
# Upload\/Download Action\r\ncloud.action.upload-download.thread-count=10<\/pre>\n
This value can be used to increase or decrease the number of pages or files that can be downloaded or uploaded at a time, from the cloud onto a Transact instance. If you encounter any decrease in performance, you can decrease this thread-count number to be less than 10.<\/p>\n
<\/a>Ephesoft Cloud Portal<\/h2>\n
You can log in to the Ephesoft Cloud portal (https:\/\/transact.us.ephesoftcloud.com<\/a>) to view how many images you have processed with the Cloud HyperExtender plugin.<\/p>\n
<\/p>\nEphesoft Cloud Portal<\/em><\/span><\/p>\n
<\/a>Troubleshooting<\/h2>\n
<\/a>Log File<\/h3>\n
The log file for the Ephesoft Cloud HyperExtender plugin is available in the following location:<\/p>\n
<Ephesoft Installation Folder>\/<\/em>JavaAppServer\/webapps\/ephesoft-cloud-client\/WEB-INF\/classes\/log\/cloud-client.log<\/strong><\/p>\n
<\/a>Incomplete Registration<\/h3>\n
If you attempt to configure the Cloud HyperExtender plugin with invalid connection details, the following error message appears:<\/p>\n
Ephesoft Cloud registration is incomplete. Please ask your system administrator to register first. <\/strong><\/p>\n
If this problem occurs, contact your Transact system administrator.<\/p>\n
<\/a>Test Classification and Extraction<\/h3>\n
When the Ephesoft Cloud HyperExtender plugin is configured and enabled within a batch class, the Test Classification and Test Extraction actions will not work in that batch class. The following error message will be displayed:<\/p>\n
Error occurred while breaking multipage tiff or pdf. <\/strong><\/p>\n
This error is expected, as these actions are not supported in batch classes that are configured to use the Ephesoft Cloud HyperExtender plugin.<\/p>\n
<\/a>Saving the Cloud HyperExtender Configuration<\/h3>\n
If a cloud-enabled batch fails, ensure that you have saved the Ephesoft Transact Cloud HyperExtender configuration in the respective batch class.<\/p>\n
1. Open the batch class.<\/p>\n
2. Navigate to Modules > Folder Import > CLOUD_HYPEREXTENDER_PLUGIN > Configure<\/strong>.<\/p>\n
The Ephesoft Cloud HyperExtender<\/strong> configuration screen is displayed.<\/p>\n
<\/p>\nEphesoft Cloud HyperExtender <\/strong>> Configure<\/strong> Screen<\/span><\/em><\/p>\n
3. Ensure that the plugin is configured and enabled and that you click Save<\/strong> to retain changes.<\/p>\n
<\/a><\/a>HTTPS Not Applied to Property Files<\/h3>\n
If your Cloud HyperExtender batches fail with error message, \u201cI\/O error on POST request for \u201chttp:\/\/…\u201d (via the Batch Execution<\/strong> details pane in the Batch Instance<\/strong> screen), and Ephesoft Transact is installed as HTTPS, perform the workaround below to correct the error and change the property files. The same error can be seen in greater detail in the dcma-all.log <\/strong>(located in the following path:<Transact-Installation-Folder><\/em><\/strong>\/Application\/logs\/).<\/p>\n
- \n
- Open the application.properties<\/strong> file in the following path:<\/li>\n<\/ol>\n
<Transact Installation Folder><\/em>\/JavaAppServer\/webapps\/ephesoft-cloud-client\/WEB-INF\/classes<\/strong><\/p>\n
- \n
- Locate the following property: cloud.notification.transact-hybrid url.<\/strong><\/li>\n
- Change the property from http:\/\/localhost:8080\/dcma\/ws\/hybridplugin\/status\/notify to https:\/\/localhost:<port number><\/em>\/dcma\/ws\/hybridplugin\/status\/notify.<\/strong><\/li>\n
- Open the cloud-plugin.properties<\/strong> file in the following path:<\/li>\n<\/ol>\n
<Transact Installation Folder><\/em>\/Application\/WEB-INF\/classes\/META-INF\/cloud-plugin\/<\/strong><\/p>\n
- \n
- Locate the following property: cloud.client.url <\/strong><\/li>\n
- Change the property from http:\/\/localhost:8080\/ephesoft-cloud-client to https:\/\/localhost:
- Change the property from http:\/\/localhost:8080\/dcma\/ws\/hybridplugin\/status\/notify to https:\/\/localhost:<port number><\/em>\/dcma\/ws\/hybridplugin\/status\/notify.<\/strong><\/li>\n
- Locate the following property: cloud.notification.transact-hybrid url.<\/strong><\/li>\n
- For mid-range or larger batches (roughly 1000 pages per batch), Ephesoft recommends that you keep the default setting for server.instance.max.process.capacity<\/strong>.<\/li>\n<\/ul>\n
- application.properties <\/a><\/li>\n<\/ul>\n
- dcma-workflows.properties<\/a><\/li>\n
- \n
- \n
- \n
- Last Name<\/strong> \u2014 Enter your last name.<\/li>\n
- First Name<\/strong> \u2014 Enter your first name.<\/li>\n
- \n
- \n
- The plugin only supports Oracle 11g (11.2.0) and 12c (12.1.0). Configurations must be made to the property file for Oracle to work as expected. Refer to Using Cloud HyperExtender Plugin with Oracle 11g and 12c<\/a> to perform this workaround. For additional information refer to Platform Configuration and Third-Party Integrations – Transact 2019.1<\/a>.<\/li>\n