Licensing
This topic describes the requirements for Integration Server licensing. Integration Server uses a transaction package license, which counts the number of transactions against Integration Server. For general information about each of the license types, refer to "About licensing in ImageNow" in the Managing ImageNow>Licensing section of Administrator Help.
ImageNow Server tracks each call that is made to Integration Server, which is charged against a transaction package license. Transaction package licensing is controlled from ImageNow Server. Transactions licenses are based on counting the number of transactions within ImageNow and decrementing this number over a period of time. After users perform all of the transactions in a specified period, no more transactions can be done until the period expires. You can purchase overdraft licensing protection for Integration Server transaction licenses.
Licensing for other applications
ImageNow applications that use Integration Server, such as ImageNow Interact for Microsoft Outlook, can use either the concurrent use or per seat licensing model. Per seat licensing is a node-locked license that is based on the number of computers on which you install the software. A separate transaction package license is not required for calls that are used by a Developer Network partner's product that uses Integration Server.
Transaction Licenses Overdraft Report
If you purchase overdraft licensing protection for Integration Server transaction licenses, you must generate a quarterly report to send to Perceptive Software. You may also use this report or the ImageNow Server Administrator utility to check the usage status of your overdrafts.
Free calls
The following Integration Server calls are not charged against a transaction package licensing model.
| Call | Description |
|---|---|
| POST: /v1/captureGroup/ | Creates a capture group that can be used to capture a group of pages into one or more documents |
| PUT: /v1/captureGroup/{id} | Completes the capture process for a captured document group. |
| POST: /v1/captureGroup/{id}/page | Captures a page to a capture group |
| DELETE: /v1/connection/ | Disconnect current connection from the server. |
| GET: /v1/connection/ | This API call verifies the connection status of Integration Server to ImageNow Server. If a connection to ImageNow Server does not already exist, a new connection is made. Integration Server uses the connectionStatus type to provide the product version for the connection. |
| POST: /v1/department | Creates a department. |
| PUT: /v1/department/{id} | Updates an existing department. |
| POST: /v1/document | Store a new Document in the Server. |
| POST: /v1/document/{id}/page | Adds a page to a document stored in the Server. |
| PUT: /v1/form/{id}/document/{docId} | Store form data to a specific version of a document. |
| PUT: /v1/form/{id}/folder/{folderId} | Store form data to a folder. |
| PUT: /v1/license/featureToken | This API call acquires a token for a feature license. The Integration Server response includes the requested token in plain text. |
| GET: /v1/licenseGroup | Get the License Group of this ImageNow Server. |
| POST: /v1/recordCaptureGroup/ | Creates a capture group that can be used to capture a group of pages into one or more records |
| PUT: /v1/recordCaptureGroup/{id} | Completes the capture process for a captured record group. |
| POST: /v1/recordCaptureGroup/{id}/page | Captures a page to a capture group |
| GET: /v1/serverInfo | Gets all server information. |
| GET: /v1/sso/callback/{profileName} | A redirection endpoint for the OpenID Connect Authorization Code Flow. |
| POST: /v1/sso/callback/{profileName} | A redirection endpoint for the OpenID Connect Authorization Code Flow. |
| GET: /v1/sso/login | Initiates a single sign-on (SSO) flow based on the SSO configuration using the default login profile. |
| GET: /v1/sso/login/{profileName} | Initiates a single sign-on (SSO) flow based on the SSO configuration using the specified login profile. |
| GET: /v1/sso/token/login/{profileName} | Establish a Perceptive Content session using Bearer authentication by supplying a bearer token in an Authorization header. A valid bearer token login profile name must be provided in the endpoint path. |
| GET: /v1/status | Retrieve state of integration server and its dependent services. |
| GET: /v1/uniqueId | Returns a set of server generated unique IDs. |
| GET: /v1/user | Gets a list of all users. |
| POST: /v1/user | Creates a user. |
| GET: /v1/user/group | Gets the list of groups a user belongs to. |
| DELETE: /v1/user/{id} | Deletes an existing user |
| GET: /v1/user/{id} | Gets an existing user. |
| PUT: /v1/user/{id}/account | Updates an existing user with new account information |
| GET: /v1/user/{id}/extendedInfo | Gets an existing user. |
| GET: /v1/user/{id}/group | Gets the list of groups a user belongs to. |
| PUT: /v1/user/{id}/group | Updates an existing user with group membership |
| GET: /v1/user/{id}/privilege | Gets the privileges for a user |
| PUT: /v1/user/{id}/privilege | Sets the privileges for a user |
| PUT: /v1/user/{id}/profile | Updates an existing user's profile |
| GET: /v1/userGroup | Retrieves all existing userGroups in the department and groups shared with that department |
| POST: /v1/userGroup | Creates a new user group |
| DELETE: /v1/userGroup/{id} | Deletes an existing user group |
| GET: /v1/userGroup/{id} | Retrieves an existing userGroup |
| PUT: /v1/userGroup/{id} | Updates an existing user group |
| GET: /v1/userGroup/{id}/privilege | Gets the privileges for a user group |
| PUT: /v1/userGroup/{id}/privilege | Sets the privileges for a user group |
| GET: /v2/connection/ | This API call verifies the connection status of Integration Server to ImageNow Server. If a connection to ImageNow Server does not already exist, a new connection is made. Integration Server uses the connectionStatus type to provide the product version, user ID, and user name for the connection. |
| GET: /v2/serverInfo | Gets version information. |
| GET: /v2/user | Gets a list of all users. |
| GET: /v2/user/{id}/privilege | Gets the privileges for a user |
| PUT: /v2/user/{id}/privilege | Sets the privileges for a user |
| GET: /v2/userGroup/{id} | Retrieves an existing user group |
| PUT: /v2/userGroup/{id} | Updates an existing user group. |
| GET: /v2/userGroup/{id}/privilege | This API call requests detailed information about the privileges for the user group that matches the given ID. Integration Server structures the response using the privilegeSet type, which provides the unique ID and type of each privilege set, the name of each privilege within a set, as well as whether the privilege for that user group is GRANTED, DENIED, or UNSET. You can use query parameters to return specific privilege sets for a user group, such as global privileges and document type privileges. You can enter multiple query parameters on the same call. If a query parameter is repeated, Integration Server ignores the extra query parameters. If you don't provide any query parameters, Integration Server returns an empty structure. |
| PUT: /v2/userGroup/{id}/privilege | This API call modifies the privileges for an existing user group. Integration Server structures the request using the privilegeSet type, which provides the unique ID and type of each privilege set, the name of each privilege within a set, as well as whether the privilege for that user group is GRANTED, DENIED, UNSET, or IGNORE. For the call to succeed, the request must contain all of the privileges for the given privilege type, such as FOLDER_TYPE in the example below. |
| POST: /v3/document | Store a new document in the server. |