Duo_Liang submitted February 4 2020

Note:

  1. 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.
  2. 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


 

Rate this Code Share

Comments

jdasilva | Posts: 1

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hi, I believe the wrong .jar was uploaded. OSS - Package Export  & Download Tool - v1.1.7.jar.

fll | Posts: 1

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hi Duo,

Can you please provide the sample csv file?

Thanks

Lili Fu

From ANZ

 

Duo_Liang | Posts: 3776

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hi Lili,

 

Sorry about that, I've added the sample CSV to the code share.

 

Duo

MYuen05 | Posts: 1

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hello -

I am trying to leverage the v1.3.1 bulk upload tool, after clicking Invite Sender, I get the following pop-up. 

Image removed.

Not being successful in inviting, what step am I missing?

Please advise.

Thanks!

Duo_Liang | Posts: 3776

Reply to:

0 votes

Hi 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

Support | Posts: 1

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hello!!

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

crnkovicc | Posts: 3

Reply to: Bulk Invite Sender Tool - Java

0 votes

In 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

Duo_Liang | Posts: 3776

Reply to:

0 votes

Hi 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

crnkovicc | Posts: 3

Reply to:

0 votes

Looks 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

AD240 | Posts: 12

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hi,

I am having the following error when trying to access the tool; and my user has both the roles Manager and Admin:

Error accesing Bulk send

 

 

 

 

 

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!

Duo_Liang | Posts: 3776

Reply to:

0 votes

Hi 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 

kalyanimeshram | Posts: 2

Reply to: Bulk Invite Sender Tool - Java

0 votes

I 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

Bulk invite with API Key

Bulk invite with Username pwd

kalyanimeshram | Posts: 2

Reply to: Bulk Invite Sender Tool - Java

0 votes

I 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

Bulk invite with API Key

Bulk invite with Username pwd

Duo_Liang | Posts: 3776

Reply to:

0 votes

Hi 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

emeraldcorpuz | Posts: 2

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hello,

 

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 

 

screenshot

Duo_Liang | Posts: 3776

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hi 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

karenjorb | Posts: 12

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hiii, 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

 

nealhennessy | Posts: 19

Reply to: Bulk Invite Sender Tool - Java

0 votes

Why 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

 

nealhennessy | Posts: 19

Reply to: Bulk Invite Sender Tool - Java

0 votes

Why 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

 

Duo_Liang | Posts: 3776

Reply to:

0 votes

Hi there,

 

This Apple Support article suggests to follow below steps to grant Control access to files and folders on Mac:

  1. Choose Apple menu 

    Image removed. > System Settings, then click Privacy & Security Image removed. in the sidebar. (You may need to scroll down.)

     

  2. Click Files and Folders.

  3. 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

dvernall | Posts: 4

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hi 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?

dvernall | Posts: 4

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hi 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?

areams | Posts: 1

Reply to: Bulk Invite Sender Tool - Java

0 votes

Hello! 

I'm not seeing the example CSV within the code download. Is it hosted somewhere else?

serenapotts3 | Posts: 10

Reply to: Bulk Invite Sender Tool - Java

0 votes

I 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.

serenapotts3 | Posts: 10

Reply to:

0 votes

I 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.

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