Release 1.10.0

Release Date: 13/01/2023

Check the migration steps to understand how to upgrade.

Key features

Improved Analytics API

New analytics REST API available.

Fetch a whole new range of data subsets with easy-to-use predefined queries:

  • Get document count per status - /analytics/document/perstatus

  • Get document statistical averages (session duration, document size and pages) - /analytics/document/statistics

  • Get document lifetime statistics (minimum, maximum and average) of all submitted documents - /analytics/document/lifetime

  • Get the number of documents per channel - /analytics/document/perchannel

    • You must define a session’s (during authentication via addin) and/or document’s channel (via document’s variable CHANNEL) and it will be written on its correspondent session analytics entries (user analytics)

  • Get number of documents with N signatures for each distinct N - /analytics/document/persignatures

  • Get number of documents with N signers for each distinct N - /analytics/document/persigners

  • Get number of signatures per signature type - /analytics/signature/pertype

  • Get number of distinct users per user domain per year - /analytics/user/perdomain

    • You must define a session’s domain (during authentication via addin) and it will be written on its correspondent session analytics entries (user analytics)

  • Track your license usage, this service gets your history of license limits per year and documents submitted per year and month - /analytics/license/usage

  • Get your usage data for the given period, this means: - /analytics/usage/data

    • License history and contracted volume per year

    • Documents per year and status

    • Signatures per year and per type

    • Interval of the query

    • Your customer’s name

    • Your customer’s id

  • Get a list of the years with recorded activity - /analytics/usage/years

Domains and Channels

Defining a document’s channel in its variables will make it its default. This defined value will become the default channel to be inserted in the document’s analytics entries unless the session currently accessing the document has an associated channel.

To set the variable in the create document request set in the variables:

"variables" : [
  {
    "name":"CHANNEL", (1)
    "value": "channel name" (2)
  }
]
1 must be the literal name CHANNEL, it is case sensitive
2 Private variable (prefixed with #)

To define a user's domain or channel via its session details one must implement such logic within a session authentication addin implementation.

Features

  • [Devops-22982] User analytics will now be able to distinguish between service and viewer sessions

  • [Devops-31604] createAndReturn service calls will now be distinguished on artifact analytics entries with the action description "ONDEMAND"

  • [Devops-31257] INTERNAL type signatures can now be hidden from several analytics queries either via a flag in the request or in the server configurations (as server defaults):

    • Hide INTERNAL signatures in "persigner" query with the property analytics.documents.persigner.exclude.internal : true

    • Hide INTERNAL signatures in "signature per document" query with the property analytics.documents.signatures.exclude.internal : true

    • Hide INTERNAL signatures in "signatures per type" query with the property analytics.signatures.pertype.exclude.internal : false

  • [Devops-31514] A warning is now presented in logs when using eSign’s default signature certificate

  • [Devops-31538] ISessionInformationAddin now receives ServletRequest as argument making it more flexible and improving usefulness

Fixes

  • [Devops-27074] Fixed an error when signing fields with usernames larger than 1000 characters

  • [Devops-17478] Fixed an error that would occur and show in logs when accessing /eSignServer/pages/monitor with empty analytics tables

  • [Devops-18590] Fixed an error that would prevent document creation when providing empty field locations in SOAP requests

  • [Devops-31547] Added missing signing method CLICKTOSIGN to "signing.signmethods" configuration (methods available by default)

  • [Devops-17811,17812,17813,17814,19235,19548,29336] Fixed error codes and/or Improved error messages