OneSpan Sign - Transaction Export & Download Tool - v1.7.1

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.7.1: 2024/04/12

1. Fixed an issue where it would cause infinite loop when end user entered wrong credentials.

Update 1.7.0: 2024/04/12

1. Count the number of senders first before querying the sender API.

Update 1.6.9.1: 2024/02/13

1. Add duplicate filename handling for file download process.

Update 1.6.8: 2023/08/04

1. Increase the sender limitation to 2000. Also see release note "Update 1.6.0".

Update 1.6.7: 2023/06/07

1. Allow to filter transactions by keyword (transaction name and description), sender (sender email, Id, f/lname) and status (multi-select).

2. Now the reports include either selected transactions (before it was completed transactions), or transactions of all statuses.

Update 1.6.6: 2023/06/06

-Add a new function bulk delete selected transactions. Users can expect a warning dialog to double confirm before final delete.

Update 1.6.5.2: 2023/04/21

-Use system proxy as default

-Escape downloaded documents' names

-Add transaction ID as a suffix to downloaded evidence summary ("Evidence Summary_C_ejhz7t2XqlHiEodYrdo1beMXc=.pdf") and uploaded attachments folder ("Uploaded Attachments_C_ejhz7t2XqlHiEodYrdo1beMXc="), so that if you have select multiple zip files in a folder and choose "Extract Files...", the extracted evidence summary and attachments folders won't overwrite each other.

Update 1.6.5: 2023/04/19

-Allow to customize the name of the downloaded PDFs. An additional toggle was added to the left bottom of the panel to enter the name formula.

-The default value is "{document_name}", and the other available placeholders are "transaction_name", "transaction_id", "transaction_desc", "document_name", "document_id", "document_desc", "fieldname:your_field_name", "fieldid:your_field_id".

-For example you have a label field "client_name" that you want to make as part of the document name, your formula could be like "{document_name} - {fieldname:client_name}".

Update 1.6.4: 2023/03/28

1.Allow to select draft transactions from list

2.For non-integrated users, resolved an issue when using login credentials.

Update 1.6.3: 2023/03/16

-Add time zone support.

Update 1.6.2: 2023/03/16

-Add export fields CSV functionality, to export a list of all transactions with their field data in CSV format. Rename packages to transactions in UI labels.
 

Update 1.6.1: 2023/02/03

-Move project to Maven file structure with POM file. Rename esignlive package to OneSpan.

Update 1.6.0: 2022/12/14

-For accounts with more than 1,000 senders, instead of looping through senders and retrieve each senders' transactions, the tool now uses transaction summary API. This significantly improves the performance in this case, however some features will be disabled, e.g. to download flattened PDF or to download signer attachments. Also, the exported report will miss some columns, e.g. signer list, document list, transaction attributes, etc.

Update 1.5.5: 2022/11/22

-Fixed a bug where the selected file path was not correct for Mac users.

Update 1.5.4: 2022/11/04

-Added an index at the front of each line.

Update 1.5.2: 2021/12/10

-Fixed a bug in version 1.5.1 where if the account has Roles & Permissions turned on and the tool might not read the admin user's permissions properly.

Update 1.5.1: 2021/12/01

-Added an additional option to download flattened documents. This option will be turned off by default (download active documents by default), hence it won't affect your normal usage.

Update 1.5.0: 2021/11/23

-For accounts who has turned on the "Roles & Permissions" feature, as of release 11.45, a new permission "Manage users’ transactions, templates, layouts (API)" has been introduced. This has changed the way how the tool retrieves the transactions and downloads signed documents & evidence summary. 

-Despite the complexity in code upgrade, the end users of the tool simply need to make sure your admin account has at least "API Access" and "Manage users’ transactions, templates, layouts (API)" permissions to manage all your senders' transactions.

Note:
(1)Accounts that hasn't turned on the RnP feature won't be affected by this upgrade.

(2)Considering Production environments are still in 11.44 release, I've also attached the v1.4.2 tool for the backward compatibility.

(3)For now, "Admin" role won't be automatically granted the new permissions, hence you will need to manually create a customized role and assign the role to your admin user. Also, "Admin" user won't be able to edit their own account role through UI, you will need to either edit through another admin user, or contact support team to have your account set up properly.

Update 1.4.2: 2021/10/01

-When the account has turned on the “Roles & Permissions” feature:

1. Removed the logic to query every sender’s Account Role For better performance

2. Adapted the response handling for API “GET /api/account/senders/{senderId}/roles” 

Update 1.4.1: 2021/03/17

1. Set JVM default locale as Locale.US.

Update 1.4.0: 2021/03/04

1. Support entering API Client ID + Secret as login credentials. 

Update 1.3.8: 2021/02/25

1. Add a retry mechanism for most core outbound APIs

2. Add an option to enable logging capability - user needs to toggle the option and select a directory to store log files. This log file WON'T store your API Key / login credentials, but still may include sensitive information, hence it's important to keep the log files in a secured location or remove it after execution.

Update 1.3.7: 2021/02/23

1. The tool now supports accounts with Roles & Permission feature turned on. Make sure the input user has the "Admin" role. 

Update 1.3.6: 2021/02/17

1. Allow to list and download not completed transactions.

Update 1.3.5: 2020/11/04

1. Date Picker is editable now.

Update 1.3.4: 2020/10/30

1. fixed a bug introduced by previous code change that failed to load transactions when logged in user is a regular member. 

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!