Note:
- If you choose to enable the "Activate Sender" option, this will trigger automatic invitations to all senders without them having to receive an activation email. However, if you choose to disable this option, especially when dealing with a large number of senders, it's advisable to request assistance by creating a support ticket at [email protected] and to utilize the tool only under the guidance of our support team. Such guidance may include:
- Personalizing the "email.account.invitation" and "email.signup" templates
- Requesting your IT department to whitelist our domain. This strategy is designed to prevent senders, who may not be anticipating activation emails, from mistakenly marking our domain as a phishing attempt.
- If, by accident, senders were invited directly but you intended them to receive the activation email, the "Activate Sender" option should be deactivated. Following this, invite the senders again twice - the first call will deactivate the senders, and the second call will initiate the sending of the activation email.
In order to run this tool, you will need the following:
1. install JRE/JDK environment (1.8 or later)
2. OneSpan Sign API key or Username + Password of your account
3. a CSV file in UTF-8 encoding, which contains sender's information. (A sample file has been included in the attachment showing you the expected header format) For sender information: Firstname, Lastname, Email are specified per sender. Company name and whether to Activate your senders immediately are set in batch.
Update 2024/03/28 - v1.4.6:
1. Add a JVM argument to use system default proxy
Update 2023/11/10 - v1.4.4:
1. fixed an issue concerning the presence of reserved words, such as "roles", in sender profiles. Note:
Note:
Currently, to assign roles to sender accounts, please use the username and password method. Note that the assignment of roles via API Key is not supported at this moment.
Update 2023/05/24 - v1.4.3:
1. Fixed a bug where the sender status is only determined when importing the CSV, now sender status and company can be overwritten at any time.
Update 2021/10/26 - v1.4.1:
1. Adapted the response handling for API “GET /api/account/senders/{senderId}/roles”
Update 2021/03/03 - v1.4.0:
1. Supports the "Roles & Permissions" feature. In order to assign sender roles, add a "Roles" column in CSV file, enter the Role Name(s) in the cells and use semi colon(s) to separate multiple role names. An sample CSV file is also included.
2. Beautify the sender list
Update 2020/08/11 - v1.3.1:
1. Sender “company” and “status” can be either specified as CSV columns or determined in bulk during the operation. When both options are provided, whatever you’ve specified in the CSV will take priority.
Update 2020/07/17 - v1.3.0:
1."Bulk Sender Invite Tool" now features the function to update existing senders. In order to facilitate this use case, an extra step has been introduced which pulls all the existing sender's Emails to a CSV file.
You can cut the "Email" column and merge into your own CSV file, then add your customized columns. Any sender attributes can be used as column name, for example, "TimezoneId" or "Language", case insensitive. (To update an existing sender, the "email" is the minimal requirement, so no need to fill in the first/last names, unless you want to update them)
Update 2020/06/16 - v1.2.0:
1. after execution, a report as well as a log file will be persisted to the same folder as the sender CSV file located. Although both files don't include API Key/Token, it's still suggested to delete them both after you've confirmed all senders have been successfully invited to the account. Otherwise, they could be a useful resource to troubleshoot with underlying issues during execution. (log file is locked during execution, exit the program then you get access to the content)
Update 2020/04/29 :
1. fixed the duplicated slashes in the API URLs.
Update 2020/04/03 :
1. add the proxy capability, allow to manually choose proxy ip/port or use a proxy script, also allow proxy authentication
Comments
Reply to: Bulk Invite Sender Tool - Java
Monday, March 30, 2020 at 02:07pmHi, I believe the wrong .jar was uploaded. OSS - Package Export & Download Tool - v1.1.7.jar.
Reply to: Hi, I believe the wrong .jar…
Friday, April 3, 2020 at 02:08pmHi jdasilva,
Thanks a lot for bringing it up to us! I've re-uploaded the jar file.
Duo
Reply to: Bulk Invite Sender Tool - Java
Wednesday, May 6, 2020 at 11:15pmHi Duo,
Can you please provide the sample csv file?
Thanks
Lili Fu
From ANZ
Reply to: Bulk Invite Sender Tool - Java
Thursday, May 7, 2020 at 08:39amHi Lili,
Sorry about that, I've added the sample CSV to the code share.
Duo
Reply to: Bulk Invite Sender Tool - Java
Wednesday, September 2, 2020 at 02:58pmHello -
I am trying to leverage the v1.3.1 bulk upload tool, after clicking Invite Sender, I get the following pop-up.
Not being successful in inviting, what step am I missing?
Please advise.
Thanks!
Reply to: Hello - I am trying to…
Wednesday, September 16, 2020 at 10:35amHi Maggie,
Sorry for the late reply! Because the screenshot was broken, I can't know exactly what is happening. But after the execution finishes, the tool generates a report along with a log file at the same folder as the input CSV file, where you could quickly walk through the report and see if it's helpful. If the issue persist, you are very welcome to send the error screenshot to developer@esignlive and I'd like to assist you in a private thread.
Duo
Reply to: Bulk Invite Sender Tool - Java
Thursday, September 10, 2020 at 10:16amHello!!
We need to know if with the "bulk invite sender" tool it is possible to send an email to the user who has been activated through this tool.
Could you tell us if it is possible?
Thanks
Reply to: Bulk Invite Sender Tool - Java
Wednesday, March 3, 2021 at 12:20amIn the version 1.3.0 notes, it is stated that "any sender attributes can be used as column name." What I'm having trouble finding is a list of available sender attributes. Is this information contained in documentation somewhere, or can you post a list here?
Thanks
Reply to: In the version 1.3.0 notes,…
Wednesday, March 3, 2021 at 07:47amHi crnkovicc,
The most common sender attributes are:
email String
firstName String
lastName String
status String INVITED / ACTIVE / LOCKED
type String REGULAR / MANAGER
language String find abbreviations in this guide
timezoneId String find all timezone IDs in this post
company String
title String
phone String
Duo
Reply to: Hi crnkovicc, The most…
Wednesday, March 3, 2021 at 08:02amLooks good. Is it possible to assign a Role to the users upon import? My test runs have landed the senders with no role assignments, and I'm not sure if that is normal or if something isn't functioning properly.
Thanks for help,
Chris
Reply to: Looks good. Is it possible…
Wednesday, March 3, 2021 at 08:33amHi Chris,
The tool doesn't work with Roles & Permissions feature for now. I will update the code and let you know once it's available. (May take few hours)
Duo
Reply to: Looks good. Is it possible…
Wednesday, March 3, 2021 at 11:48amHi Chris,
I've updated the code, and now the tool should support assigning sender roles.
Duo
Reply to: Hi Chris, I've updated…
Wednesday, March 3, 2021 at 04:09pmExcellent! That was definitely a faster response than I had expected.
Thank you
Reply to: Bulk Invite Sender Tool - Java
Tuesday, October 26, 2021 at 03:05pmHi,
I am having the following error when trying to access the tool; and my user has both the roles Manager and Admin:
Previously, I have been able to use the tool with the same roles and without any issue. Do you know what the problem could be?
Thank you in advance!
Reply to: Hi, I am having the…
Tuesday, October 26, 2021 at 03:28pmHi AD240,
There's a known issue introduced by release 11.44 where the response schema for API "GET /api/account/senders/{senderId}/roles" has been changed. I've adjusted the code and published the v1.4.1 tool. Would you mind downloading it and try again?
Duo
Reply to: Hi AD240, There's a…
Wednesday, October 27, 2021 at 08:13amHi Duo,
Now I was able to access the tool. Thank you!!
Reply to: Bulk Invite Sender Tool - Java
Tuesday, March 29, 2022 at 10:41amI am trying/Testing the bulk invite tool with one of our US2 Sandbox account.
I tried with API key as well as username and password, but I am getting the error.
Please let me know what to do in order to resolve it.
Attached is the screenshot of errors.
Thanks
Reply to: Bulk Invite Sender Tool - Java
Tuesday, March 29, 2022 at 10:42amI am trying/Testing the bulk invite tool with one of our US2 Sandbox account.
I tried with API key as well as username and password, but I am getting the error.
Please let me know what to do in order to resolve it.
Attached is the screenshot of errors.
Thanks
Reply to: I am trying/Testing the bulk…
Tuesday, March 29, 2022 at 12:17pmHi Kalyani,
Thanks for reporting this to us! Few questions:
(1)Which Java version are you running with? If it's not Java 8 or greater, is it possible to try with a later version? - This is to make sure the HTTPS connection is on TLS 1.2
(2)Are you connecting through a VPN/proxy? Is it possible to try with a different Internet setup?
(3)If it's possible, could you try any other integration tools to see if you can log in there, like Transaction Export & Download tool, or Template & Layout Copy Tool?
Duo
Reply to: Bulk Invite Sender Tool - Java
Thursday, August 18, 2022 at 12:07pmHello,
Since yesterday i can't access the bulk upload tool and keep getting this error message. i tried updating java to v1.4.1_0 and i am still getting this error message
Reply to: Bulk Invite Sender Tool - Java
Thursday, August 18, 2022 at 12:18pmHi Emerald,
Could you share the Environment URL as well as the Account Email to [email protected] so that I can have a quick check on your account settings?
Duo
Reply to: Hi Emerald, Could you…
Thursday, August 18, 2022 at 12:23pmHi Duo,
ive sent the information to [email protected]
Thanks,
Emerald
Reply to: Bulk Invite Sender Tool - Java
Wednesday, March 22, 2023 at 12:13pmHiii, how can I add in the bulk invite sender tool , users with role "manager" , thanks! I tried adding "type" and the users with "manager", but it doesn't work
Reply to: Hiii, how can I add in the…
Wednesday, March 22, 2023 at 02:37pmI thought it didn't work because I didn't see the option when I loaded the users, but it's working. :)
Reply to: Bulk Invite Sender Tool - Java
Friday, May 19, 2023 at 12:20pmWhy is the tool not showing any of the files I have on my desktop? Screenshot: https://drive.google.com/file/d/1LblY7iaUxdj-rAX-aq5N_ks-IaVVIuGQ/view?usp=sharing
Reply to: Bulk Invite Sender Tool - Java
Friday, May 19, 2023 at 12:22pmWhy is the tool not showing any of the files I have on my desktop? Screenshot: https://drive.google.com/file/d/1LblY7iaUxdj-rAX-aq5N_ks-IaVVIuGQ/view?usp=sharing
Reply to: Why is the tool not showing…
Friday, May 19, 2023 at 01:30pmHi there,
This Apple Support article suggests to follow below steps to grant Control access to files and folders on Mac:
Choose Apple menu
> System Settings, then click Privacy & Security in the sidebar. (You may need to scroll down.)Click Files and Folders.
For each app in the list, turn the ability to access files and folders in specific locations on or off.
Let me know if this makes sense to you.
Duo
Reply to: Bulk Invite Sender Tool - Java
Tuesday, May 30, 2023 at 04:41pmHi Duo_Liang
I am trying to do the Bulk upload WITH the roles, but I get an error message:
"Fail to invite sender: [email protected];Reason is: {"messageKey":"error.forbidden.roleAndPermissionNotEnabled""
How would I enable this?
Reply to: Bulk Invite Sender Tool - Java
Tuesday, May 30, 2023 at 04:42pmHi Duo_Liang
I am trying to do the Bulk upload WITH the roles, but I get an error message:
"Fail to invite sender: [email protected];Reason is: {"messageKey":"error.forbidden.roleAndPermissionNotEnabled""
How would I enable this?
Reply to: Hi Duo_Liang I am trying to…
Tuesday, May 30, 2023 at 05:53pmHi David,
In order to enable the Roles and Permissions feature, please contact our support team at [email protected].
Duo
Reply to: Bulk Invite Sender Tool - Java
Tuesday, March 12, 2024 at 03:41pmHello!
I'm not seeing the example CSV within the code download. Is it hosted somewhere else?
Reply to: Hello! I'm not seeing the…
Tuesday, March 12, 2024 at 03:53pmHi Amy,
I have re-uploaded the sample csv here.
Duo
Reply to: Bulk Invite Sender Tool - Java
Wednesday, April 17, 2024 at 12:20amI am having trouble using the latest version of the tool v1.4.6 on Mac OSX. On the second screen the first time I ran I downloaded the existing sender CSV and then pressed next. No file seems to be in the folder I selected. I then tried to select the input CSV file on the third screen and the tool locked up.
I force closed and tried to run the tool again and now on the second screen when I try to download the existing sender CSV the button saw processing and the tool locks up again.
Reply to: I am having trouble using…
Thursday, May 2, 2024 at 12:13amI was running an older version of Java. Once I ran with Java 1.8 the tool was about to upload a sender CSV. The downloading of existing didn't prompt me for a folder and just dumped some JSON to my command line console, as I ran the jar file from there as I have other version of Java running so had to run via java -jar command.