randy.stephenson

General questions to get me started with an upgrade

0 votes

Hello, I need some tips to get me started with an upgrading to SDK 11.41 from a very old version. I was not involved in the original implementation, and I am lacking knowledge of what the platform provides. Once I’m more comfortable that I’m on the right track, I’ll be able to find more info on my own.

I am looking for documentation:

- to provide a general understanding of the Java SDK.

- anything that might help me understand how to support a work flow with multiple signers.

- anything specific to the email signing, notifySigner, reminderService, and signing order.

- Is there way to determine the status of documents programmatically, or via a login portal that shows if documents are signed by all signers?

- Anything the platform provides for troubleshooting.
 

Thank you for your help,

Randy


Reply to: General questions to get me started with an upgrade

0 votes

Hi Randy,

 

Welcome to OneSpan Sign! For your questions:
(1)to provide a general understanding of the Java SDK

Java SDK, no matter older or new version, is a wrapper/builder of RESTful API (e.g. createPackage() function will invoke a POST /api/packages call at the end, and the DocumentPackage object will be converted to the request payload).

Essentially the SDK interface wasn't get changed a lot, hence as long as you figured out the workflow of your existing integration, it should be fairly easy to upgrade.. For example, how many signers and documents are involved, how you placed the signature and fields to the document (with hardcoded coordinates or automatic extraction methods like text tags, text anchor or document extraction), what's the signing flow.

 

(2)anything that might help me understand how to support a work flow with multiple signers.

Not sure if you are talking about the signing index, the Signer Workflow guide should be helpful.

 

 

(3)anything specific to the email signing, notifySigner, reminderService, and signing order.

By default, once you sent out a package, "email.activate" template will automatically be sent out to signers according to their signing index.

For any reason, a signers did not receive an email notification for signing, you can manually resend the "email.notify" template. (guide here)

Reminders ("email.remind.signer" template), are additional notifications which will be sent in fixed days depending on when and how often you've specified when package creation. (guide here)

For signing index, refer to my above reply.

 

(4)Is there way to determine the status of documents programmatically, or via a login portal that shows if documents are signed by all signers?

You can always leverage the sender portal (e.g. https://sandbox.esignlive.com/a/login), filter, search and view the transaction list. Within each transaction edit page, if a document has been completed signing, you'll see a green tick beside the line.

To programmatically determine the signing status, it's suggested to set up a callback listener and monitor the Document Signed event rather than actively polling frequently. (But this may require extra development)

For actively polling, I would suggest to retrieve a list of packages (100 packages each call) > loop through all documents and all signatures > check if all signatures' "confirmed" or "signed date" attributes are not null.

As the last choice, you can retrieve signing status of a document in a particular document, but using this function will cost large amount of outbound APIs.



(5)Anything the platform provides for troubleshooting.

You can try catch the EslException, and the error message normally will carry the API response returned from OneSpan Sign server. And I would also suggest you to turn on the SDK's logging capability:

-add the logging.properties to your project (the attached example used the ConsoleHandler)

-before you initiate the EslClient, specify a system property

    static {
        System.setProperty("java.util.logging.config.file", "./sources/logging.properties");
    }

This will print out all the outbound calls as well as the API response to the console.

 

Duo

 

Duo Liang OneSpan Evangelism and Partner Integrations Developer


Attachments
logging_0.zip489 bytes

Reply to:

0 votes

Thank you Duo This is very helpful. 

We currently do all signing in an iFrame, and are introducing email with this upgrade.

Just so I understand the flow, after the withSigner and signingOrder is established,     
eslClient.sendPackage(packageId) will begin the email process, and OneSpan controls the sending of emails?

SigningOrder(2) email will not be sent until SigningOrder(1) is complete, and so on?
What if order is not important, and we would like them to sign in any order, is that possible?

Lastly, how do I get access to https://sandbox.esignlive.com/a/login ? No one in our shop has access anymore. 
Thanks again, Randy


Reply to:

0 votes

Hi Randy,

 

"SigningOrder(2) email will not be sent until SigningOrder(1) is complete, and so on"

Yes, this is how signing order works.

 

"we would like them to sign in any order, is that possible"

If you don't specify signing index, or set the same value to all signers (the default value is 0), this removes the signing order.

 

"get access to https://sandbox.esignlive.com/a/login"

Click "Forgot your password" and reset it if you still have access to the account email.

 

Duo

Duo Liang OneSpan Evangelism and Partner Integrations Developer


Hello! Looks like you're enjoying the discussion, but haven't signed up for an account.

When you create an account, we remember exactly what you've read, so you always come right back where you left off