Duo_Liang submitted January 9 2019

A Java Stand-alone application that runs at client side.

 

Prerequisite:
This tool is encapsulated as an Executive Jar, so you need to install the JRE/JDK environment in order to run the Jar.

 

Supported Function:

1. Allow using API KEY or email/password as a credential.

2. Loading all packages of all sender under your main account within a period of time.(0 <= timeDiff <= 365)

3. Allow specifying save folder.

4. Download Completed Packages:

4.1 Allow to select partial of completed packages

4.2 For each package, download a zip file including evidence summary and all signed documents.

5. Export Packages as CSV file:

5.1 Two Options -- export only completed packages or export package of all status.(not include deleted packages)

 

Update 1.3.3: 2020/10/16

1. Retrieve the usage report before loading all packages, and only loads partial senders and package statuses accordingly. This optimization helps to reduce outbound API calls.
2. provide support for accounts enabled sub-account feature. Because subaccount is still an evolving feature, please make a post or leave a comment below if it doesn't work for your account.

 

Update 1.3.1: 2020/09/24

1. if enabled Roles & Permission, sender role will be reflected as the actual role(s) in CSV report - there's a known issue that even if a sender has "Admin" role, if the sender's type is "Regular" instead of "Manager", the sender still missed some API access.

2. allowed to select only completed or archived packages for downloading

3. offered an option to avoid downloading signed documents

4. better UI auto-sizing

 

Update 1.3.0: 2020/09/18

1. introduced multiple language support for Spanish and Brazilian Portuguese, localization includes all the UI labels and the downloaded file names.

2. add an option to include signer attachments. Attachments are downloaded individually with naming convention of {attachment_name}_{signer_full_name}_{actual_uploaded_file_name}

3. refactored the string encoding to better support accent characters

 

Update 1.2.1: 2020/09/04

1. allow on-premise users to specify custom instance URL.

 

Update 1.2.0: 2020/08/20

1. fix an issue that the tool failed to connect through proxy when username + password are specified.

 

Update 1.1.9: 2020/04/20

1. fix a CSV display issue when sender's first/last name, or the package name contains comma. The tool will surround double quotation marks to the string in these cases.

 

Update 1.1.8: 2020/04/17

1. removed the limitation that only pulls senders with status of "ACTIVE", that's because in many cases, senders are auto-provisioned and therefore might be active in PENDING status.

2.Now the tool only won't pull senders with "LOCKED" status, this is because suspended sender's API Key can't be directly used to pull packages. It's a known limitation that if there are still ongoing packages under a suspended sender, these packages won't be retrieved.

 

Update 1.1.7: 2020/03/26

1. add the proxy capability, allow to manually choose proxy ip/port or use a proxy script, also allow proxy authentication

2. fixed a bug that previous versions won't export trashed packages in the report (this is because the package retrieval API won't return trashed packages)

3. provide an extra option to choose whether to export packages to the report where the sender is just a signer (sender is not the package owner)

 

 

If you have any questions or suggestions on this tool, please feel free to make a post!

Rate this Code Share

Comments

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes
Is there a similar tool but to delete the packages?

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes
Hi cmorales, "Filter packages by update date and the status, then bulk trash packages" is feasible through the new sender UI from Web Portal. To do so: (1)navigate to Transactions > Inbox folder (2)input the From and To dates (3)choose the "REFINE" icon at the right and choose "Completed" (4)Multiselect the packages you want to trash and click the Trash button (5) (Optional)switch to the Trash folder and permanently delete the packages. Duo

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes
This only allows me to delete the packages with the logged on user is it possible to delete all packages from all users under the main account?

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Would it be possible for the Completed package list in this tool where you choose which packages to export, to show a table with information similar to in the transaction listing in the web UI shown below? For transactions sent with bulk send all transactions have the same name so it is very hard to differentiate between transactions without referring back to the transaction id which is not very user friendly to use to identify.

transaction listing

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hi...I used the most recent jar (v1.1.7) and ran it against a WEB UI account.  It did not return all the packages, only a very small subset and only packages created by one user.  Is there a new setting?  I have run this for other accounts without issue.

Reply to:

0 votes

Hi amfulton,

 

Our support team should have reached out to you per your question. This is because in order to grab all packages under your main account, you'd use your account owner's credentials/API Key, as opposed of sender's.

Also, I appreciate your feedback and contributions to this tool a lot!

 

Duo

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hi Duo !

Thanks for creating this. Very useful tool.

Our customer is requesting the source code (for security reasons). Would it be possible for you to provide us with that?

 

Thank you,

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hi Duo, 

Thanks for directing me to this tool. It is very useful.

Similar to the previous post by vdantoni, I'd like to know if the source code can be made available. If we use it, the security team will need to scan the code, since it looks like it needs to run on premises. 

Also, is this an official tool from oneSpan? 

Thanks and Regards, 

Dexter

Reply to:

0 votes

Hi Dexter,

 

I've posted the source code in another code share:

https://community.onespan.com/documentation/codeshare/onespan-sign-package-export-download-tool-source-code-0

This is not an official tool from OneSpan Sign (here's the Terms and Conditions for codes hosted at the Developer Community Code Share), which is more like an integration example since outbound calls I used are exposed APIs.

Although it's not guaranteed that the tool will work perfectly like a part of the production, I will maintain and update the code if a new feature comes up and broke the function, or there's bug reported or any other valuable suggestions raised.

For the tool entrance, the tool can only be executed from UI, but you can extract the code snippet that

(1) retrieve API Keys of all senders

(2)pulls all packages of interest for perspective sender, using their API Key

(3)download signed documents in zipped file, as well as the evidence summary. Then programmatically combine them into a new zipped file and store locally.

 

Duo
 

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hi Duo, 

Can this tool be used to initiate a download from the command line, or do we always need to use the UI? 

Is there another version of the code that can be run just from the command line, providing inputs either through command line parameters, or a property file? 

Thanks again, 

Dexter

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hi Duo,

 

Can you tell me what actions trigger the "LastUpdateDate" field  to be updated?  I noticed that we have a status of "Completed", Complete Date is 2020-07-02 15:12:02, and Last Update Date is: 2020-07-02 16:17:02

 

thanks,

Anne-Marie

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hi Duo,

 

Can you tell me what actions trigger the "LastUpdateDate" field  to be updated?  I noticed that we have a status of "Completed", Complete Date is 2020-07-02 15:12:02, and Last Update Date is: 2020-07-02 16:17:02

 

thanks,

Anne-Marie

Reply to:

0 votes

Hi Anne,

 

One of the potential scenarios could be:  signer has signer authentication specified and the person was trying to access the signing ceremony, therefore updates the lastestUpdateDate field. (signer could be locked even after package completion)

Or if it's not the case, if you can share the package ID, I can help you have a quick check in backoffice to see if there's something obvious.

 

Duo

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hello Duo_Liang,

Backgrouds:

Package 1: 

Owners save the document pictures as PDF files and send to Signer => 

Owner sent the package to signer | signer completed the package |  when Owner clicked to download button it gave them the error: 

{technical":"EsepCommand failed and no fallback available.","code":500,"messageKey":"error.internal.default","message":"Unexpected error. We apologize for any inconvenience this may have caused you, please try again. If the problem persists, please contact our support team.","name":"Unhandled Server Error"}

 

Package 2: 

Owners remove some pdf files ( which were images converted to pdf) sent again => that completed package can be downloaded.

++++++

++++ Checking log +++ 

I see: Done executing an eSEP Call for a transaction

 

++++++++++++

Please let me know if any information you may need for your further advises 

Thank you 

Reply to:

0 votes

Hi Antonio,

 

#1. Are you developing with on-premise or SaaS environment?

#2. Is the error consistent -- (1)this package consistently can't be downloaded and (2)the same PDF consistently failed to download even in other packages?

#3. I assumed for package1, the error message you saw comes from the tool, what if you used the UI portal? And what if you download the documents one by one, will you hit the error?

For downloading each document, you could build below link:

GET /api/packages/{packageId}/documents/{documentId}/pdf 

After logging onto the sender portal, hit the link in address bar.

Kindly advise.

 

Duo

Reply to:

0 votes

Hello Duo_Liang,

 

Thank you for your prompt answer,

 

From the Back Office => Package Json Toggle =>  we can see that one of the documents for the 1st Package the SIZE is Zero  

The 2nd Package all the documents have their own Size Numbers.

 

Unfortunately that 1st Package the customer had signed so we can do nothing but only made the 2nd Package to send to them and they completed.

 

However, I am not too much sure why "Size" : 0 could cause the issue for downloading the package 

{technical":"EsepCommand failed and no fallback available.","code":500,"messageKey":"error.internal.default","message":"Unexpected error. We apologize for any inconvenience this may have caused you, please try again. If the problem persists, please contact our support team.","name":"Unhandled Server Error"}

Issue has been resolved, however if you have any ideas on that issue please kindly give me some hints 

Thank you for your time 

Reply to:

0 votes

Hi Antonio,

 

Glad to hear that the issue has been solved.

For document size as 0, is it true that the uploaded file is blank / has empty length? If that's the case, it's a known issue that in previous OSS version, the system accepted zero length document but didn't allow to download. This issue should have been fixed at 11.32 version (however, it's later than on-prem version) and now the UI and API layer will prevent you from doing so.

 

Duo

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hey Duo,

Is there a way to get the signing name of the other party on the csv report?

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

sorry didnt mean to post twice

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Hi OneSpan team,

I am looking to report some improvements with regard to the tool  - especially in light of recent requirements for our needs.

The tool takes a really long time extracting information for a longer time period (say a year). Having an ability to generate the CSV list in a quick and easy way will be very helpful.

please consider this improvement and share your inputs.

Thanks

Vijiram

Reply to:

0 votes

Hi Vijiram,

 

Thanks for the suggestion! In the latest update version 1.3.3, I've introduced an extra step that before loading all senders' packages of all statuses, the tool now retrieves the usage report first (each sender has sent how many packages of each status), and only invokes partial package retrieval API calls. This improvement should be noticeable when there are a large amount of senders under the account, and not every senders are active.

 

Duo

Reply to: OneSpan Sign - Package Export & Download Tool - v1.3.3

0 votes

Its a great great tool!

It worked great in our sandbox enviroment.

 

But it fails to connect to our production enviroment. 

Should we check with support? Could it be a setting in the enviroment preventing us to connect?

 

Thanks! Daniel!

Reply to:

0 votes

Hi Daniel,

 

Thanks for your appreciation! You can have a quick self-check if you've chosen the correct environment (apps.esignlive.com vs apps.e-signlive.com, etc) and API Key. If it still doesn't work, please kindly create a support ticket and we can move the discussion to a private thread.

 

Duo

Reply to:

0 votes

Great it works at the end. If you executed the jar file from command line, the tool prints logs in console and you will see all outbound API calls. And if it took longer than you expected, it's probably because you have a lot senders under your account and the tool needs to pull all senders' API Keys in that step.

 

Duo

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