Square 9 Connector - Kyocera · Copystar dealership. You can evaluate the software, free of charge, for two 30-day trial periods. Kyoceras Square 9 Connector will be disabled when

KYOCERA Square 9

Connector

Square 9 Connector Version 1.1.6

February 2018

KYOCERA Document Solutions America, Inc.

Software Solutions Group

© 2018 KYOCERA Document Solutions America, Inc.

2 Copyright © 2018 KYOCERA Document Solutions America, Inc. All rights reserved.

Table of Contents 1. Introduction to Kyocera’s Square 9 Connector .................................................................................... 3

1.1 This Guide ..................................................................................................................................... 3

1.2 End-User Operation ...................................................................................................................... 3

1.3 Supported MFPs ............................................................................................................................ 4

1.4 Supported Environments .............................................................................................................. 4

1.5 Licensing ........................................................................................................................................ 4

1.6 On-line Activation ......................................................................................................................... 4

1.7 HyPAS Application File .................................................................................................................. 7

1.8 HyPAS Application Installation ...................................................................................................... 8

Installation on HyPAS-Capable MFPs .................................................................................... 8

Installation on HyPAS-Enabled MFPs .................................................................................. 10

2. Configuring Kyocera’s Square 9 Connector ........................................................................................ 11

2.1 Server Settings ............................................................................................................................ 12

2.2 Scan Settings ............................................................................................................................... 12

2.3 Options ........................................................................................................................................ 13

2.4 Import / Export Settings .............................................................................................................. 14

Export Square 9 Connector Settings ................................................................................... 14

Import Square 9 Connector Settings ................................................................................... 14

3. Operation ............................................................................................................................................ 15

3.1 MFP Login .................................................................................................................................... 15

3.2 MFP Logout/Exit .......................................................................................................................... 16

3.3 Scanning to an Archive ................................................................................................................ 17

3.4 Scanning With a Workflow .......................................................................................................... 20

3.5 Using Square 9 Data XChange ..................................................................................................... 22

3.6 Printing from an Archive ............................................................................................................. 24

4. Troubleshooting .................................................................................................................................. 27

5. Support ............................................................................................................................................... 28

Copyright © 2017 KYOCERA Document Solutions America, Inc. All rights reserved. 3

1. Introduction to Kyocera’s Square 9 Connector Kyocera’s Square 9 Connector is a Kyocera Business Application designed to simplify document scanning

from a network connected Kyocera HyPAS-enabled MFP to a Square 9 on-premise server or Square 9

Cloud server to further leverage an existing Square 9 investment. Kyocera’s Square 9 Connector takes a

scanned image and allows the user to add or modify indexing data and route the scan to an existing

Square 9 infrastructure.

Benefits of Kyocera’s Square 9 Connector:

• Scan and Print directly from a Kyocera network connected MFP to or from an existing Square 9

server

• Index data entered at the MFP panel is passed to the Square 9 Server

• Integration with Square 9’s Data XChange feature makes entering index data quick and easy

• Single sign-on

This document describes the components, functions, installation requirements, and steps required to

deploy and configure Kyocera’s Square 9 Connector effectively. Since Kyocera’s Square 9 Connector

offers multiple workflow and configuration options, it is essential to understand these to deploy this

solution correctly.

Kyocera’s Square 9 Connector is used when an end-user needs to scan or print a document to or from an

existing Square 9 server. At the MFP control panel, an end-user launches Kyocera’s Square 9 Connector

and authenticates using their Square 9 credentials. From here, the end-user can choose a document

archive or workflow to scan to. Index data is entered at the MFP panel and the index data and document

image are sent to the Square 9 server for storage or continued processing.

Alternately, users can search for and print documents from an Archive where the MFP will download the

image from the Square 9 server and print it.


For a full list of support MFP models, please refer to the Solutions Compatibility Chart on

KDACentral.com.

Kyocera’s Square 9 Connector requires an existing Square 9 server to function. The Square 9 connector

does not come with a Square 9 server setup or Square 9 account. For more information on purchasing

and setting up a Square 9 server environment, please visit www.square-9.com.

Supported Square 9 Server Versions: Square 9 Server 4.3.1

Kyocera’s Square 9 Connector requires the purchase of a software license from an authorized Kyocera or

Copystar dealership.

You can evaluate the software, free of charge, for two 30-day trial periods. Kyocera’s Square 9

Connector will be disabled when the two trial periods expire, and you will be required to purchase a

license key to be entered to continue using the application.

Kyocera’s Square 9 Connector uses the same activation method as the Card Authentication Kit,

Teaching Assistant, Data Security Kit and the Document Guard Kit. Following the purchase of a license

certificate, the Product ID Number is sent in an email message. You will need these items as well as the

MFP Serial Number when you access the License Page from KDACentral.

You will be issued a unique Activation Key once you register your option. Print this page and input this

Activation Key number on the panel of your HyPAS-Enabled MFP or HyPAS-Capable MFP to activate it.

Login to the License Key Service on KDACentral.com What’s Required:

• License Certificate

• Product ID Number

• MFP Serial Number

www.square-9.com


Kyocera’s Square 9 Connector Licensing Procedure

1. Enter the Product ID from the License Certificate, Click Next.

2. Your Product will be verified, Click Next.


3. Enter the MFP Serial Number, Click Next.

4. Re-enter the MFP Serial Number to confirm it, Click Next.


5. Your Information will be verified, Click Next.

6. Your License Key is issued.

7. Print the Page and input the License Key number on the panel of your HyPAS-enabled MFP to activate your Device.

Two 30-day full-featured trials are allowed per MFP. For use beyond the trial period, each MFP

installation must be activated with a unique license key obtained after purchasing the corresponding

item code.


Installation on HyPAS-Capable MFPs

1. Download Kyocera’s Square 9 Connector Package file from “KDACentral” Kyocera and Copystar

Dealer Portal and copy it to the root of a clean USB flash drive.

2. At the MFP control panel, open System Menu/Counter >Favorites/Application.

3. Log in as Administrator when prompted. The default login name is Admin and the default

password is Admin (Note: Enter capital A when entering ‘Admin’ as both login name and

password fields are case-sensitive).

4. Press Application button.

5. Press Menu button.


6. Press Add button.

7. Insert USB flash drive into the MFP.

8. A list showing the application will appear.

9. Select Kyocera’s Square 9 Connector and press Install.

10. After installation, press End to return to the Applications screen.

11. Select Kyocera’s Square 9 Connector and press Menu.

12. Press Activate. The MFP will prompt for Activation Mode. If a license key is available, enter the

license key, then select Official. Otherwise, press the Trial button to activate one of the two 30-

day trials. One trial can last for 30 days after which time the trial button will be disabled and

Kyocera’s Square 9 Connector service will no longer start. A license must be purchased from an

authorized Kyocera or Copystar dealer in order to restart Kyocera’s Square 9 Connector service.

13. If the Official button is pressed,

the MFP will prompt for a license

key. Enter it using the keypad

and press the OK button.

NOTE: License key can only be

generated by authorized Kyocera

or Copystar dealers.

After Kyocera’s Square 9 Connector is activated successfully, it can be executed from the main

Application screen (opened by pressing the Application key on the control panel).


Installation on HyPAS-Enabled MFPs

1. Download Kyocera’s Square 9 Connector Package file from “KDACentral” Kyocera and Copystar

Dealer Portal and copy it to the root of a clean USB flash drive.

2. At the MFP control panel, open System Menu > Applications.

3. Log in as Administrator when prompted. The default login name is Admin and the default

password is Admin (Note: Enter capital A when entering ‘Admin’ as both login name and

password fields are case-sensitive).

4. Press the Add button.

5. Insert USB flash drive into the MFP.

6. A list showing the application will appear.

7. Select Kyocera’s Square 9 Connector and press Install.

8. After installation, press Close to return to the Application screen.

9. Select Kyocera’s Square 9

Connector and Press Activate.

The MFP will prompt for

Activation mode. If a license key

is available, enter the license key,

then select Official. Otherwise,

press the Trial button to activate

one of the two 30-day trials. One

trial can last for 30 days after

which time the trial button will

be disabled and Kyocera’s Square

9 Connector service will no longer start. A license must be purchased from an authorized

Kyocera or Copystar dealer in order to restart Kyocera’s Square 9 Connector service.

10. After Kyocera’s Square 9 Connector is activated successfully, it can be executed from the home

screen.

NOTE: To setup Kyocera’s Square 9 Connector as the default screen of the MFP, open System Menu >

Common Settings > Default Screen and select Kyocera’s Square 9 Connector.


2. Configuring Kyocera’s Square 9 Connector Kyocera’s Square 9 Connector can be configured from either the MFP panel or from a web interface. The

web interface can be accessed by entering http://<MFPADDRESS>:8080/square9connector/jsp/main.jsp

into a web browser. Almost all configuration options are the same on the MFP panel and the web

interface except for an option to import/export settings which is only available via web interface. The

web interface was used to illustrate the following steps to include all options Kyocera’s Square 9

Connector provides.

1. After obtaining the MFP’s IP address, open a web browser and enter http://<MFPIPv4ADDRESS>:8080/square9connector/jsp/main.jsp in the URL bar.

2. Enter the MFP

Administrator’s

credentials and click the

Login button on the

lower right-hand corner

of the screen. By default,

the credentials are:

a. Username: Admin

b. Password: Admin

3. Once successfully logged

in, you will be shown the

Square 9 Connector

Configuration page.

Make changes as

necessary the click the

Finish button on the

lower right-hand corner

of the screen to save

your changes and return

to the login screen.


a. Server Address: The IP

Address or Hostname of

the Square 9 Server. If no

protocol is specified, http

will be assumed. If no

port is specified in the

address the default ports

will be used. (Http:80,

Https:443).

If using a cloud account

enter the cloud URL in the

form of https://<yoururl>.mysquare9.com. The SSL certificate may need to be extracted from the

site and imported into the MFP first.

b. Cache Location: The location of the WebPortalCache folder. The default location upon initial Square

9 server installation is “C:\SmartSearch\WebPortalCache”. However, this location can be changed.

Check with your Square 9 server administrator for the proper location.

NOTE: Cache Location is essential to allow users to use workflows to upload to the server. Without

this setting configured, users will not be able to upload documents via workflows.

Kyocera’s Square 9

Connector’s default scan

settings can be changed to a

more common set depending

on the types of documents

and requirements most

commonly used in an office

setting. However, users will

still be shown the scan

settings screen before

scanning and allowed to

make adjustments if

necessary.


Kyocera’s Square 9 Connector can be configured to include Square 9 Archives, Capture Workflows, or

both. However, at least one option will need to be selected. When both are selected you can configure

Kyocera’s Square 9 Connector to display either Square 9 Archives or Capture Workflows first by default

after logging in.

Additionally, when both the

Archive and Capture

Workflow options are

enabled, two buttons will

display on the default home

screen to allow users to

easily switch between

Archives and Capture

Workflows:

Workflow Selection

Database Selection

File Format PDF, TIFF, High Compression PDF

Color Mode Monochrome, Full Color, Grayscale, Auto (Color/BW), Auto (Color/Grayscale)

Resolution 200x200 dpi, 300x300 dpi, 400x400 dpi, 600x600 dpi,

Duplex 1-sided, 2-sided

Original Type Photo, Text, Photo/Text, for OCR

Original Orientation Top Edge Top, Top Edge Left

Scan Density (Darkest) -3 -2.5 -2 -1.5 -1 -.5 0 .5 1 1.5 2 2.5 3 (Lightest)

Continuous Scan ON, OFF

Page Size

Letter Letter R Legal (8.5”x14”) Statement

Statement R A3 Ledger (11”x17”) A4

A4 R A5 A5 R B5

B5 R B6 B6 R 16K

16K R Oficio Folio Auto

Mixed Size OFF, Same Width


NOTE: The Import/Export Settings will only appear when configuring Kyocera’s Square 9 Connector

through the web interface. Import/Export Settings will not appear on the MFP panel.

Import/Export Settings allow

the administrator to save all

settings configured in an

existing Square 9 Connector

installation and import them

into a new Square 9

Connector environment for a

quick and uniform setup.

Export Square 9 Connector Settings

Under Export Settings, click the Export button and your settings will automatically download to your

browser’s default download location. The file will be called “Square9ConnectorSetting.zip” and can be

copied and moved as any other .zip file.

Import Square 9 Connector Settings

Under Import Settings, click the Choose File button and navigate to the exported .zip file. Select the .zip

file and click the Open button. The .zip file will appear next to the Choose File button for reference. Next,

click the Import button to import your Square 9 Connector settings. A popup window should appear

stating that connector has “successfully imported data”. Click OK to close the popup window and click

the Finish button to return to the Settings page.


3. Operation

1. Press the Square 9

Connector application

button on the MFP panel.

2. Enter your Square 9

credentials to log in


3. After successful login,

you will be shown the

default Square 9

Connector home screen.

NOTE: The home screen

may be different

depending on what

options are configured.

1. Logged in users can log

out of the application by

pressing the Logout icon

( ) or exit the

application by pressing

the Exit icon ( ) on

the upper right-hand

corner of the screen.


If a card reader is attached

to the MFP and accessible

the login screen will display

an image of a hand holding

an HID card next to the login

prompts.

To register your HID card,

enter your username and

password then scan your

card. DO NOT press the next

button or you will skip the

registration process. The

new username, password, and HID card number association be stored on an internal database that

resides in the application. From now on you may simply swipe your HID card to log in.

To re-register a card simply repeat the registration process. The information stored on the internal

database will be overwritten with data in the username and password fields.

1. Select the database you

wish to scan to.


2. You will be shown the list

of Archives under that

Database. You can scroll

through the list or press

the Search icon ( )

and type the name of the

Archive you wish to scan

to. To add a document,

click the Add icon ( )

on the same row as the

desired Archive.

3. The next screen allows

you to enter index data

that cooresponds with

that Archive. Enter any

index data necessary.

Dates can be added

manually or chosen from

a calendar by pressing

the Calendar icon ( )

next to the input box.


4. If you would like to make

changes to the scan

settings, press the

Settings button on the

lower center of the

screen. Once changes are

made, press the Next

( ) icon to continue.

5. When index data and

scan settings are OK,

press the Scan ( ) icon

to begin the scan.

6. When scanning

completes you will be

returned to the last

Archive you were in.


Kyocera’s Square 9 Connector can be configured to allow users to use workflows configured on the

Square 9 server. Depending on the workflow, the steps to complete the workflow may differ. For this

example, the workflow has the option to enter index data and uses a Data XChange source.

1. Select the workflow.

2. Enter index data as

necessary.


3. Change scan settings as

necessary.

4. Press the Scan ( ) icon

to begin the scan.

5. When scanning

completes you will be

returned to the Select

Workflow screen.


Kyocera’s Square 9 Connector leverages the use of the Data XChange feature included with Square 9.

When scanning, users can enter one or more index data fields and use Square 9’s Data XChange feature

to lookup other common index data fields and populate other index data fields.

NOTE: Square 9’s Data XChange feature is configured on the Square 9 server and is not always

associated with an Archive. For more information, please refer to Square 9’s documentation.

1. When looking at the

Index Data screen of an

Archive, the option to

“Select a Source” will be

displayed in the upper

right-hand corner of the

screen if a Data XChange

source is available.

2. Enter one or more index

data fields and press the

down arrow icon ( ) in

the Data XChange field.

You will be shown the list

of Data XChange sources

available in this particular

Archive.


3. Select the Data XChange

source you would like to

use and press the Data

Xchange Lookup icon

( ) next to the Data

XChange field.

4. If a match or matches are

found you will be shown

the results matching your

search index data. If

more than one match is

found you can iterate

through the list by

pressing the left ( )

and right ( ) icons to

the left and right of the

list respectively.

When you choose the

correct search result,

press the check icon ( ) in the lower right-hand corner of the screen.


5. Your selected search

results will be applied

and populated into the

index data fields. You

may also make changes

as necessary.

1. Select the database you

wish to print from.


2. You will be shown the list

of Archives under that

Database. Iterate

through the list or press

the Search icon ( )

and type the name of the

Archive you wish to scan

to. To find a document in

an Archive, click the

Search Document icon

( ) on the same row

as the desired Archive.

3. You can browse the

Archive manually or use a

Search associated with

the Archive on the

server.

4. Enter index data to

narrow your search

results or press the Next

( ) icon to search the

entire Archive.


5. Your search results will

be displayed with a

preview thumbnail of the

the first page of the

document displayed on

the left and the index

data associated with that

document displayed on

the right. You can iterate

through the list by

pressing the left ( )

and right ( ) icons to

the left and right of the

list respectively. When you find your document, press the Print ( ) icon in the lower right-hand

corner of the screen.

6. The next screen will allow

you to make changes to

the print settings. Once

changes are made select

the Print ( ) icon in

the lower right-hand

corner of the screen to

download and print your

document.


4. Troubleshooting

When logging into Square 9 Connector, I get a message that says “Authentication failed with the

provided credentials”.

Check:

• The username and password of the account attempting authentication

• The IP Address and Port settings in Square 9 Connector’s configuration

When selecting an Archive to go further into the folder structure, I see a message that says “You

cannot go any further”.

Usually this message appears when you are at the end of the folder structure for that Archive or you do not have the proper permissions to go further.

When scanning with a workflow, my document doesn’t show up in the Archive.

Check:

• The Cache Location path in Square 9 Connector’s configuration. The proper path is necessary for documents scanned via a workflow to be processed and routed to their appropriate destination.

If issues persist, please contact your authorized Kyocera or Copystar Dealer for assistance.


5. Support

For Kyocera’s Square 9 Connector Support:

Contact your authorized Kyocera or Copystar Dealer.

For a listing of authorized Kyocera Dealers:

https://usa.kyoceradocumentsolutions.com/en/where-to-buy.html

For a listing of authorized Copystar Dealers:

https://copystar.com/en/where-to-buy.html

or

Contact KYOCERA Technical Support

Phone Monday - Friday 9 am - 6 pm EST

1-800-255-6482 Web https://usa.kyoceradocumentsolutions.com/en/about-us/contact-us.html

KYOCERA, CopyStar, Square 9 Connector and HyPAS are trademarks of the Kyocera Companies.

Square 9 and Data XChange are trademarks of Square 9 Softworks, Inc.

Copyright © 2018 KYOCERA Document Solutions America, Inc.

All rights reserved.

Rev. 1.0

https://usa.kyoceradocumentsolutions.com/en/where-to-buy.html

https://copystar.com/en/where-to-buy.html

https://usa.kyoceradocumentsolutions.com/en/about-us/contact-us.html


Documents

Square 9 Connector - Kyocera · Copystar dealership. You can evaluate the software, free of charge, for two 30-day trial periods. Kyoceras Square 9 Connector will be disabled when