Kyocera Cloud Information Manager User Guide

Kyocera Cloud Information Manager

Product Information

Specifications

• User Interface: English
• Supported Languages: English, German, Italian,French, Dutch, Polish, Spanish, Swedish

Product Usage Instructions

Chapter 1: Product Information

Conventions:
The guide may use conventions like text boxes or specific formatting to indicate important information.

System Requirements:
The ScannerVision Cloud Information Manager Connector supports multiple languages including English, German, Italian, French,Dutch, Polish, Spanish, and Swedish.

Chapter 2: Introduction

Chapter 3: Connector Installation

Install the Connector:
Follow the provided steps to install the Connector on your system.

Update the Connector:
Learn how to update the Connector to ensure optimal performance.

Uninstall the Connector:
If needed, follow the instructions to properly uninstall the Connector.

Chapter 4: Connector Configuration

Output Format Settings:
Adjust the output format settings as needed for your specific requirements.

Chapter 5: Appendix

Third-party Notices:
Refer to this section for important third-party notices related to the ScannerVision Cloud Information Manager Connector components.

FAQ

Q: Can I change the language settings of the ScannerVision Cloud Information Manager Connector?
A: Yes, you can change the language settings to English, German, Italian, French, Dutch, Polish, Spanish, or Swedish based on your preference.

Legal notes
Unauthorized reproduction of all or part of this guide is prohibited.
The information in this guide is subject to change without notice.
We cannot be held liable for any problems arising from the use of this product,regardless of the information herein.

© 2023 KYOCERA Document Solutions Inc.

Regarding trademarks
ScannerVision™ is a trademark of Ubunye Holdings.
All other brand and product names herein are registered trademarks or trademarks of their respective companies.

Product information

Conventions
The following conventions may be used in this guide:

• Bold text is used for menu items and buttons

• Screen, text box, and drop-down menu titles are spelled and punctuated exactly as they are displayed on the screen

• Italics are used for document titles

• Text or commands that a user enters are displayed as text in a different font or in a text box as shown in these examples:

  1. On the command line, enter net stop program
  2. Create a batch file that includes these commands:
     net stop program
     gbak -rep -user PROGRAMLOG.FBK

• Icons are used to draw your attention to certain pieces of information.
  Examples:

This indicates information that is useful to know.

This indicates important information that you should know,including such things as data loss if the procedure is not done properly.

System requirements

• ScannerVision Server version 9.5.0.1211 or later
• NET Framework version 4.8 installed
• ScannerVision Cloud Information Manager Connector installer version 1.1
• Cloud Information Manager version 2.3 or later

Supported languages
The table below displays the languages supported in the ScannerVision Cloud
Information Manager Connector.

•  Configure Connection setting

•  Configure Connector setting

| English
•  String of Document class / Metadata on Configure Connector setting| English
German
Italian
French
Dutch

ScannerVision supports English (United States), Dutch, French, German, Italian,Polish, Spanish, and Swedish. If the ScannerVision language setting is Polish,Spanish or Swedish, the “String of Document class / Metadata on Configure Connector” setting always is displayed in English.

Introduction

This document describes the ScannerVision Cloud Information Manager Connector (Connector) requirements and provides instructions on configuring the Connector.
The focus of this document is on Connector configuration, so the document does not cover basic ScannerVision features such as installation, user, network server, OCR settings, Zone Recognition Settings, and Expression editor.
This Connector can be used for both Kyocera Cloud Information Manager and Cloud Information Manager.

About the ScannerVision Cloud Information Manager Connector

Once installed and properly configured, the ScannerVision Cloud Information Manager Connector (Connector) uploads a single document with metadata to Cloud Information Manager as Indexed, based on the connector settings.

The Connector checks to see if the user has accepted the CIM EULA / Privacy legal agreement. The uploading process fails if the user has not accepted the EULA / Privacy legal agreement by logging in to CIM on a web browser before scanning.
Note the following information, which differs if your organization is using a license or subscription model.

There are two billing modes in CIM, which are License mode and Subscription mode.

• The Connector checks the billing mode used for a tenant.
  • If billing mode is license, the Connector validates the contract information. If any of following conditions are met, the uploading process fails:
  • The CIM contract is expired
  • The CIM document count is exceeded
  • The CIM data usage is exceeded
  • The OCR usage is exceeded
  • If the billing mode is subscription, the Connector validates the subscription status. The uploading process fails if the subscription status is invalid.
• CIM has a 30 MB limit to upload a document using a web browser, the HyPAS application, and the mobile application. The Connector does not have this limit. Uploading document more than 30 MB should be OCRed by ScannerVision to avoid a performance issue since it takes a while for CIM to OCR a large document.
• Usage count:
  • License model:
  • If a document is already OCRed by ScannerVision, the OCR counter on CIM is not incremented.
  • Data storage on CIM is counted, based on file size.
  • Number of documents are counted based on the number of uploaded documents.
  • Subscription model:
  • Data storage on CIM is counted based on file size.

Connector installation

This chapter covers the following:

• Installing the Connector on the ScannerVision server
• Updating the Connector
• Uninstalling the Connector

Install the Connector

To install the ScannerVision Cloud Information Manager Connector on the ScannerVision server, follow these steps:

1. Copy the CIM Connector.msi installer to the ScannerVision server.

2. Double-click CIM Connector.msi to open the installer.
   Administrator privileges are required to install the Connector on the ScannerVision server.

3. Read and accept the End-User License Agreement.

4. Select Next.

5. Select Install.

6. After the installation finishes, select Finish.

Update the Connector
If you need to install an updated version of the ScannerVision Cloud Information Manager Connector, copy the updated CIM Connector.msi installer to the ScannerVision server. Follow the steps in the Connector installation topic to install the update.

Uninstall the Connector
If you need to uninstall the ScannerVision Cloud Information Manager Connector from the ScannerVision server, follow these steps:

1. Locate the CIM Connector.msi installer on the ScannerVision server.
2. Double-click CIM Connector.msi to open the installer.
3. On the Welcome page, select Next.
4. Select Remove.
5. After the uninstall finishes, select Finish.

Connector configuration

This chapter covers the following:

• Configuring the Connector connections in the ScannerVision application
• Configuring the Connector settings in the ScannerVision application

Connections

Add the ScannerVision Cloud Information Manager Connector in ScannerVision.

1. On the ScannerVision server, select Start > ScannerVision >ScannerVision.
   The ScannerVision Processing Engine window displays.

2. In the General area, select Connections (1).

3. Select Cloud Information Manager (2) and then select Add (3).
   The New Connection window displays.

General

1. On the New Connection windows, make sure that Active is selected (1).
2. Enter the Connection name. Enter a name that identifies the customer with whom the connection is associated. For example, if you create this Connector for an organization named Customer A, enter a Connection name like “CIM Connection for Customer A.”
3. (Optional) Enter a description for the connection.
4. Set an Admin user that is used for the Connector configuration.

Permissions

1. Select the group or user that should be allowed to upload a document to Cloud Information Manager.
2. Select the check box for the user or group in the Selected column until a check mark displays. The check mark allows the user to see the connection.

Property definitions

1. Enter the domain name, organization name, and user credentials for Cloud Information Manager.
   For example, if the Customer portal of the Cloud Information Manager tenancy has a URL like this example:
   https://mycompany.dms-test.dev the Domain name is dms-test.dev (1) and the Organization name is mycompany (2).
   Enter the information as shown below, substituting the information for the Cloud Information Manager server and the Organization name of the customer you are adding.

2. In the Credential area (3), enter the credentials of a Cloud Information Manager user. The user you enter must have all the permissions of the document class the customer wants to upload to CIM. As you type the Password, dots replace the characters you entered. Domain is not used, so you can leave it empty.

If you reopen this window, the password field appears blank. The password is saved correctly and does not need to be re-entered.

Connector

1. In the General area, select Templates (1), and then from the Modules View, select Document Store Settings (2).
2. Drag and drop Cloud Information Manager (3) from the Available connections area to the Connectors to execute area.

Connector connection setup

1. Make sure the Cloud Information Manager Connector check box is selected (1)

2. Select Configure (2).

3. Select Connection.
   The Cloud Information Manager Connector Setup window displays the connection name set up earlier in step 2 of the Connections > General topic.
   “My tenant” (3), shown below, is the example connection name used earlier in this guide. The Name menu will display the name you set up.

4. Select Login (4).
   After successfully logging in, the Cloud Information Manager Connector Setup window displays.

Connector configuration: Document title and Document class
In this setup window, configure both the document title and document class.

1. Document title (1) is a required field. You cannot select Save without an entry.

   • You can type a document title manually (2) or use the Expression editor (3). The example image above used the Expression editor to insert a tag.
     The document title will be the original file name.

   • Both “with file extension” and “without file extension” are supported.
     For example, when typing a title manually, you can enter either of the following filenames since they are both supported: sample-document.pdf or sample-document. When using Expression editor,
     you can use either of the following tags since they are both supported:
     [ORIGINALFILENAME] or [ORIGINALFILENAMEWITHOUTEXTENSION]

2. From the Document class menu (4), select the document class you want to configure.
   The image below is provided as an example. The Document class, target folders, and attributes will be different for your organization.

3. In the Choose target folder area, select the destination folder (5) where you want to upload documents for this Document class.
   Expand My folders to see the Cloud Information Manager subfolders.
   The target folders displayed are the folders currently in Cloud Information Manager.
   The target folder you chose is displayed under Store to (6).
   If you do not select a destination folder, My folders is used as the default destination folder for the document class.

4. Next, in the “Attributes” area, you need to match the Cloud Information
   Manager attributes with ScannerVision metadata.
   Select a row (7) and then select […] (8).
   The ScannerVision Expression Editor opens.

5. From the “Available Tags” column, select the ScannerVision tag that will extract the information for the attribute you selected, and then select Save.
   You can also type a value directly into the Attributes table without using the ScannerVision Expression Editor if the value is not a variable.
   The Connector Setup window displays, and the tag you selected displays in the Value column.

6. Repeat steps 4 and 5 until all the Attributes have a value associated with them.

7. Select Save.

8. Check the configured settings by selecting Settings. An example of the settings is shown below.

9. Make sure you select Apply settings after all configuration settings are finished.
   If you do not select Apply settings and exit the window, all your configuration settings are lost.

This completes the installation and configuration of the Connector. Test the connector to make sure that it delivers documents to Cloud Information
Manager as expected.

Supported data types

You can configure attributes based on the Document class you selected when configuring the Connector. Use the ScannerVision Expression Editor to map ScannerVision metadata to Cloud Information Manager’s attributes.

The following table describes the supported data types.

converts datatime format sent by ScannerVision to YYYY-MM-DD.
integer| –
decimal| Two decimal places are supported. For example, 55.0, 55.00, 100.99, 298.12

A comma (,) is not allow in place of a decimal (.)

boolean| Acceptable boolean attributes:

•         true

•         false

Note the capitalization of the attributes. Do not use quotation marks.

Output Format Settings

The “Output Format Settings” for PDF output must be set to either “Searchable PDF” or “PDF/A” for the output document to be accepted by Cloud Information Manager.
Selecting any other file format than Searchable PDF or PDF/A causes the process to fail.

1. Select Templates > PDF > Output Format Settings.
2. On the “Output Format Settings” pane, select File Format (1).
3. Select either Searchable PDF or PDF/A.
4. From the menu bar at the top, select Apply settings.

Appendix

Third-party notices
This application contains the following open source or separately licensed third-party components:

ScannerVision Cloud Information Manager Connector components

• Third-party components listing

  • Json.NET
  • RestSharp

• Applicable license text for third-party components

  • License Text: Apache-2.0
  • License Text: MIT

• Third-party components information

  • Json.NET
  • Homepage: https://www.newtonsoft.com/json
  • Copyright: (c) 2022 Newtonsoft
  • License: MIT License

• RestSharp

  • Homepage: https://restsharp.dev/

  • Copyright: (c) 2009-2020 John Sheehan, Andrew Young, Alexey Zimarev and
    RestSharp community

  • License: Apache 2.0 License

License text for third-party components

•  License text: Apache 2.0
  • Apache License
  • Version 2.0, January 2004

http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.
   “License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
   “Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
   “Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. Forthe purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
   “You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License.
   “Source” form shall mean the preferred form for making modifications,including but not limited to software source code, documentation source, and configuration files.
   “Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code,generated documentation, and conversions to other media types.
   “Work” shall mean the work of authorship, whether in Source or Object form,made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
   “Derivative Works” shall mean any work, whether in Source or Object form,that is based on (or derived from) the Work and for which the editorial revisions,annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
   “Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.”
   “Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, nonexclusive,no-charge, royalty-free, irrevocable copyright license to reproduce,prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License,each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or
   Derivative Works thereof in any medium, with or without modifications, and in
   Source or Object form, provided that You meet the following conditions:

5. You must give any other recipients of the Work or Derivative Works a copy of this License; and

6. You must cause any modified files to carry prominent notices stating that
   You changed the files; and

7. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

8. If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
   You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

9. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

10. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

11. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

12. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special,incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction,or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

13. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for,acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against,such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to specific files in your work, attach the following boilerplate declaration, replacing the fields enclosed by brackets “[]” with your own identifying information. (Don’t include the brackets!) Enclose the text in the appropriate comment syntax for the file format. We also recommend that you include a file or class name and description of purpose on the same “printed page” as the copyright notice for easier identification within third-party archives.

Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.

License text: MIT
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy,modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

References

• JSON to C# Converter Tool | Iron Software
• Licenses
• Apache License, Version 2.0
• RestSharp
• Json.NET - Newtonsoft

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>