Sie sind auf Seite 1von 11

7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

Print | Send Link | Close

Author: Naomi Housknecht


Document ID: 160354
First Published: 12/5/2013 9:06 AM
Last Modified: 3/2/2017 12:50 PM
Last Published: 10/19/2015 4:42 PM
Channels: Internal; Customer Portal; Partner Portal;

ImageNow: Integration Server Technical Overview

Table of Contents

Overview
Technical requirements
Terminology
Licensing
Questions to ask
Information to capture
Sample INI and configuration
Testing Integration Server
Related articles

Overview

Integration Server is a middle-tier, Representational State Transfer (REST) web service that
provides access to the Perceptive Content environment. This enables a backbone for
interoperability between many pieces of the Enterprise Software suite, including some
Interact products in 6.7 and higher. For licensing details in this context, see the Licensing
section later in this article.

In addition to the functionality this adds to a pure Enterprise Software implementation,


Integration Server furnishes third-party application developers with a rich set of functions
through the REST architecture, enabling them to embed Perceptive Content functionality
directly into their applications. Developers can use toolkits with standard development tools
for Java, C#, and many other languages to embed this functionality.

The architecture supports asynchronous and synchronous communications using standard


XML and JSON message formats. Integration Server is multi-threaded, which allows for
concurrent execution of multiple client requests. For secure client-to-server and server-to-
client communication, Integration Server supports SSL.

In version 7.1.2, an Integration Server API was introduced that allows documents to be
declared as records based upon events in external systems. Version 7.1.2 also
supports WebSphere's Federal Information Processing Standards (FIPS) compliance
certification.

Technical requirements

Perceptive Content or ImageNow Server (installed locally or remotely)

Apache Tomcat (32-bit or 64-bit, matching the Integration Server version)

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 1/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

Java 6 or higher

In Linux environments, Perceptive Content or ImageNow Server version 6.7.0.2902 or


higher

Terminology

Representational State Transfer (REST): An architecture used to connect distributed


systems through an asynchronous communication protocol. In this context, Integration
Server uses REST-based communications over HTTP.

GET: An HTTP method that requests a representation of the specified resource. Requests
using GET should only retrieve data and should have no other effect.

POST: An HTTP method that requests the server to accept the entity enclosed in the
request as a new subordinate of the web resource identified by the uniform resource
identifier.

PUT: An HTTP method that requests the enclosed entity to be stored under the supplied
uniform resource identifier. If the uniform resource identifier refers to an already existing
resource, it is modified; if the uniform resource identifier does not point to an existing
resource, then the server can create the resource with that uniform resource identifier.

DELETE: An HTTP method to request the deletion of the specified resource.

Request URL: This URL is determined by the Integration Server call being utilized and how
the web server used to host the service is configured. For example, a default installation of
Integration Server on a Tomcat web server would use http://<host
address>HostAddress]:8080/integrationserver/<URL parameters>.

Request Headers:

X-IntegrationServer-Username: <<USERNAME>>
X-IntegrationServer-Password: <<PASSWORD>>
Host: << HostAddress::PORT>>
Content-Type: application/xml or application/json

Note: Additional headers may be necessary depending on the call being used.

Request Body: The body of the request is determined by the Integration Server call that is
utilized. Reference the product documentation for Integration Server for the specific call
details. GET calls will not have information entered into the request body because the
information is being requested from the server. POST and PUT calls can have information in
the request body that is specific to the call being utilized.

Licensing

For Perceptive Interact products that do not use transaction-based licensing,


Integration Server will still need to be licensed and installed.

For Perceptive Interact products with their own transaction-based licensing, an


Integration Server license is needed, but an Integration Server Transaction Pack
license will not be as the products already have their own Transaction Pack
license. Interact products and products that require their own Transaction Pack
license as follows:

Message Agent Transaction Pack

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 2/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

Integration Server Transaction Pack


Integration Framework
ImageNow Interact for ArcGIS Server
ImageNow Interact for ArcMap
ImageNow Interact for ArcIMS
ImageNow Interact for SharePoint
ImageNow Interact for Lexmark
Student Document Portlet
Vendor Portal
Perceptive Media Connector
Perceptive Intelligent Capture Connector
Perceptive Interact for Microsoft Dynamics AX Transaction Pack

For a user-developed application, one Integration Server license and one Integration
Server Transaction Pack license are needed to run Integration Server with the
Perceptive Content Server. License options include 200 transactions per hour for all
operations with no concurrent user limit. Optional overdraft support is available with
the Integration Server Transaction Pack license. Additional Transaction Pack licenses
are available for an additional cost. Integration Server licenses purchased with the
product must be entered into the ImageNow Client. See the ImageNow Installation
Guide for the installed version for more information regarding obtaining and entering
licenses. The following operations are not counted in the transaction total.

GET: /connection
DELETE: /connection
POST: /document
POST: /document/{id}/page
POST: /captureGroup
POST: /captureGroup/{Id}/page
PUT: /captureGroup/{Id}
PUT: /form/{id}/document/{docId}
PUT: /form/{id}/folder/{folderId}

The transaction counter for Integration Server is reset at the top of each hour. The
hour is based on the system clock of the Perceptive Content Server; this may be
different than the clock of the machine running Integration Server. No matter what
time the server is started or when the first transaction occurs in the hour, the counter
is reset at top of the hour.

Questions to ask

These are the basic questions to ask during any investigation of an Integration Server
issue.

Question Reason

What type of Integration Server calls are To narrow whether the issue is with
failing? Integration Server as a whole, or with
specific calls failing.

Are some or all users affected? Can determine whether the issue is with
Integration Server itself or the
permissions on a particular user.

Has it ever worked? To pinpoint configuration or


environmental issues.

Can Integration Server be reached on the Process of elimination to eliminate


configured port from the problem potential network issues.
https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 3/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

machine(s)?

Can the Perceptive Content server be Process of elimination to eliminate


reached from the Integration Server potential network issues.
machine on the configured port?

Is Apache Tomcat running? Apache Tomcat serves out the


Integration Server handling, so it must
be running on its machines.

Information to capture

Obtain copies of the following types of files. If logging is not turned on to capture a
particular file type, turn on logging.

File/Information Reason

Perceptive Content server address To verify the correct server is in the


integrationserver.ini configuration file.
Troubleshooting may require using Telnet
to manually send an email to confirm the
mail server is accepting SMTP requests.

integrationserver.ini Configuration file for Integration Server.

Note: This is included with the


Integration Server install, typically in
the [drive]:\Program Files\Apache
Software Foundation\Tomcat
7.0\webapps\integrationserver\WEB_INF
folder.

integrationserver_<yyyymmdd>.log Logs for Integration Server.

Note: This defaults to


[drive]:\inserver6\log, but may be stored
anywhere; look for log.directory in the
integrationserver.ini file to find the
location.

Any logs for the external application May confirm information on messages
connecting to Integration Server, if and status.
applicable.

Logging

To enable normal logging for integration server, open the integrationserver.ini file in the
Tomcat/webapps/integrationserver directory and set the following values:

log.level=7

log.level.thirdparties=7

log.timing.enabled=TRUE

To enable interceptor logging for integration server, open the integrationserver.ini file in
the Tomcat/webapps/integrationserver directory and set the following values:

log.interceptor.enabled=TRUE

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 4/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

For interceptor logging, the config.xml within the Tomcat/webapps/integrationserver


directory also needs to be modified. Set the following parameters:

<prop key="log.interceptor.enabled">TRUE</prop>

<prop key="log.level">7</prop>

<prop key="log.level.thirdparties">7</prop>

Sample INI and configuration

Click on the file name in the table below for a sample. For any updates to the
integrationserver.ini file in subsequent versions of Perceptive Content, see the INI Changes
by Release addendum in the Update Readme for that version.

File Name Path to File

integrationserver.ini [drive]:\Program Files\Apache Software


Foundation\Tomcat
7.0\webapps\integrationserver\WEB_INF

For details on configuring the Integration Server, see the Configure Integration Server
section and Appendix A, integrationserver.ini file options, in the Perceptive Integration
Server Installation and Setup Guide for the relevant version.

Testing Integration Server

Since Integration Server's intended functionality is to make Perceptive Content functionality


available to third-party applications through a custom program, the use of a third-party tool
that can mimic functionality with the necessary code development is necessary to test
functionality.

The web debugging tool Fiddler can be used for this purpose and can be downloaded
from Fiddler. This will allow for testing of all necessary functionality of the Integration
Server.

The Composer tab is where all of the parameters used for the specific API call are entered
to test the call.

After the appropriate information is entered by setting the type of call being used (such
as GET, POST, PUT, and DELETE), the URL, the request header, and the request body,
the Execute button can be pressed to send the call.

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 5/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

Previous calls can be tracked in the column in the left pane, and the corresponding HTTP
status codes will show the status of calls that were executed. The previous calls can be
dragged and dropped back into the composer to bring the request back.

The Inspectors tab will show specific information about the call that was executed. This
information can be either the results from the call or any messages that are encountered.

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 6/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

The first call that can be utilized to test Integration Server is the GET:/connection call. This
API call verifies the connection status of Integration Server to the Perceptive Content or
ImageNow Server and makes a connection to the server if one does not already exist. If
the connection is active, the server will return the Perceptive Content or ImageNow version
number. If the connection check fails, the system tries to create a new connection.

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 7/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

Input all of the required fields for the specific API call being used, again referencing the
product document for all required fields. After inputting the required information, click
the Execute button. If all fields are entered correctly and the server is taking requests, an
HTTP status code of 200 and the version of the server will be returned.

Another simple test to determine if the Integration Server is functioning correctly is


the GET:/document{id} call. This API call retrieves document information for the document
that matches the given ID. The Integration Server response includes the document ID,
document name, document keys, and version number, as well as the properties and
workflow items associated with the document. Integration Server also returns data
pertaining to each page of the document, including the page ID, page name, file name, and
file extension. A document might be comprised of multiple files, and each file is considered
to be a page.

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 8/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 9/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

Testing Integration Server can be accessed for additional detailed information about testing
Integration Server.

Related articles

Integration Server Getting Started Guide


Testing Integration Server
Perceptive Integration Server Installation and Setup Guide
What is Integration Server?

Integration Server FAQ

John Irvine, Donovan Kidd

Updated 03/02/2017 by Joshua Williams (Updated Licensing section with


Transaction pack info)
Updated 08/16/2016 by Corey Kidd (Updated install guide link to 7.1)

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 10/11
7/18/2017 Knowledgebase | ImageNow: Integration Server Technical Overview

Updated 10/19/2015 by Susan Cook with notes from Mike Askren (Added
additional information about version 7.1.2 features and changed formatting
to match current KB standards)

Note from John Irvine: "If Integration Server has been working in the past, any
problems are likely either an issue with Tomcat, network connectivity, or a new
application accessing Integration Server. Restarting Tomcat [should resolve the
issue]."

Is this the topic you were looking for? Yes No

Comments:

Submit
©2017 Perceptive Software | Legal Terms and Privacy Policy

https://lexmark--c.na56.visual.force.com/apex/Knowledge_Technical_Overview_Internal?popup=true&id=kA5i0000000L4fP&lang=en_US&pubstatus=o 11/11