Duo_Liang submitted December 19 2018

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

Before you start:

Before you get started, please contact our support team at [email protected] and make sure all the necessary account settings have been transferred to the target account.

Copy Modes:

Mode 1 - Copy templates and layouts of all senders to respective senders under target account.

Mode 2 - Copy templates and layouts of all senders to the target account owner.

Mode 3 - Only copy the templates and layouts under the API key holder.

Worthy of Note:

- Source and target accounts can be in the same environment.

- It's expected that templates migrated from Sandbox environments will have watermarks remaining. To work this around, move the original documents to a specified folder, name them as they are in the templates and select the folder before performing the migration.

 

For more detailed instructions on how to use the tool, check the developer blog "Template Layout Copy Tool".

 

 

Update 1.6.3.3 - 2024/10/08:

- Fix an issue where the "Remove Default Consent" flag remained enabled even when the radio button was disabled

 

Update 1.6.3.2 - 2024/03/28:

- Add a JVM argument to use system default proxy

 

Update 1.6.3.1 - 2024/01/19:

- Resolve the issue of accent characters appearing incorrectly when copying layouts.

 

Update 1.6.3 - 2024/01/19:

- Reduce page size from 100 to 30

 

Update 1.6.2 - 2023/10/06:

- To ensure that the Template & Layout Copy Tool remains functional in the latest OSS SaaS environment, you are required to upgrade to the latest version 1.6.2.

 

Update 1.6.1 - 2022/01/13:

- When copying layouts, the tool will download the flattened document in order to reduce the file size

 

Update 1.6.0 - 2021/11/30:

- Templates and Layouts will be sorted in Alphabetic order

- When select copy mode 1 and match source senders to target senders, clicking on sender's label will bring over individual sender to the target account

- Allowed going back and forward to review the migration results

- Added a confirmation message after successfully migration the layouts

- Corrected some grammar errors

 

Update 1.5.8 - 2021/11/26 :

1. When there are conditional fields, the tool will check if the document IDs and the field IDs exist in the original template/layout before creating a new template/layout in the target account.

 

Update 1.5.7 - 2021/09/23 :

1. Fixed an issue that after copying, the new package sender still appears the old sender's first and last name, instead of applying the actual sender profile name

 

Update 1.5.6 - 2021/08/04 :

1. Trying to fix the issue introduced by 1.5.5 - when destination account has removed the default-consent form already, an error saying "Copy Reminder or Visibility fails for template xxx" appears. Now, as long as the end user didn't toggle the remove option, the tool won't hit the same error.

 

Update 1.5.5 - 2021/06/01 :

1. introduced an additional option to remove auto-generated default consent form when copying template.

 

Update 1.5.4 - 2021/04/27 :

1. fixed the "pastDueDate" issue by removing the "due" and "created" attributes when copying the template / layout.

 

Update 1.5.3 - 2020/07/13 :

1. fixed an issue caused by different API modelling in sandbox vs production environments, when copying senders.

 

Update 1.5.2 - 2020/04/27 :

1. fixed a bug introduced by previous code change and caused that the layout copy function didn't work properly.

2. modified the option texts in process 3.

3. fixed duplicated slashes in the API URLs.

 

Update 1.5.1 - 2020/04/24 :

1. fixed a bug for on-prem environment that the endpoint URL wasn't concatenated properly

 

Update 1.5.0 - 2020/04/06 :

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

2. for on-premise users, allow to specify environment URL

Rate this Code Share

Comments

amfulton | Posts: 33

Reply to: Template & Layout Copy Tool - Java version

Wednesday, November 24, 2021 at 01:09pm
0 votes

Hi Duo....

We are attempting to use the tool (v1.5.7), from one account to another in the US2 instance and we are receiving an error: Request did not succeed.  Error retrieving sender's api key with email:  [email protected], please try again!

I have tried with other accounts and receive a similar error with different email address.  It was working last week when I created documentation.  

We have a PROD release on Friday, Nov 26 and it is imperative that we copy over the template layouts from the Sandbox.  Please investigate and advise.  Thanks

 

amfulton | Posts: 33

Reply to: Template & Layout Copy Tool - Java version

Wednesday, November 24, 2021 at 01:09pm
0 votes

Hi Duo....

We are attempting to use the tool (v1.5.7), from one account to another in the US2 instance and we are receiving an error: Request did not succeed.  Error retrieving sender's api key with email:  [email protected], please try again!

I have tried with other accounts and receive a similar error with different email address.  It was working last week when I created documentation.  

We have a PROD release on Friday, Nov 26 and it is imperative that we copy over the template layouts from the Sandbox.  Please investigate and advise.  Thanks

 

Duo_Liang | Posts: 3776

Reply to:

Wednesday, November 24, 2021 at 01:43pm
0 votes

Hi Anne-Marie,

 

Thanks for raising this to us! It may take some time to investigate the cause of issue, at the meantime, if you happen to know the login credentials / API Key of the template/layout creator, could you try with the mode 3 in the second step? This way, the tool will only pulls the templates and layouts created by this specific sender without retrieving other sender's API Key(s).

 

Duo

amfulton | Posts: 33

Reply to:

Wednesday, November 24, 2021 at 02:13pm
0 votes

Hi Duo....Thanks for the quick response.  I did give it a try and it failed to copy the templates.  I rec'd the following message:

null
64Ui4BRsuzEKFxM8kgtl31G5nVE= : https://sandbox.e-signlive.ca/api/packages : {"messageKey":"error.validation.condition.featureDisabled","message":"The approval contains Conditional Fields. That feature is disabled on this account. Please contact your administrator.","code":400,"name":"Validation Error"}
j6TvxfY9kxRsI3uet3E5H9Dv-sc= : https://sandbox.e-signlive.ca/api/packages : {"messageKey":"error.validation.condition.featureDisabled","message":"The approval contains Conditional Fields. That feature is disabled on this account. Please contact your administrator.","code":400,"name":"Validation Error"}

so it appears that I need to turn something on for the account?  Is that correct?  I did not know this had to be done for the account.

 

Duo_Liang | Posts: 3776

Reply to:

Wednesday, November 24, 2021 at 02:22pm
0 votes

Hi Anne-Marie,

 

From the description, it seems your original template/layout contains conditional fields, in which case, your target account also needs to turn on the feature - do you have a testing account which has the Conditional Field feature turned on?

 

Duo

Duo_Liang | Posts: 3776

Reply to:

Wednesday, November 24, 2021 at 03:00pm
0 votes

Hi Anne-Marie,

 

As of the release 11.45, the way how to pull sender's templates/layouts has been changed a bit, I will work on the issue according to the latest best practice and it could take up to few days. I will let you know when there's a new version of tool.

 

Duo

amfulton | Posts: 33

Reply to:

Wednesday, November 24, 2021 at 03:32pm
0 votes

Hi Duo....release 11.45 is not in PROD yet, so just want to confirm we should not have any issues copying the templates from the US2 Sandbox (11.45) to US2 PROD instance (11.44), using Option 3 as mentioned earlier?

Thanks, AM

Duo_Liang | Posts: 3776

Reply to:

Wednesday, November 24, 2021 at 03:45pm
0 votes

It would be tricky to tell if it will 100% function well, hence I think it could be safer if you can perform a quick test before your release:
(1)rename the template in sandbox environment (maybe add some dummy suffix like "-sandbox")

(2)copy to your production account (template with unique name shouldn't or have very minor affect to your current business flow)

(3)fully check the template in your production account

(4)when you are ready for the rollout, rename the template to its official name (if it's a replacement, you may need to delete the existing template first)

 

Duo

carloslau | Posts: 9

Reply to: Template & Layout Copy Tool - Java version

Friday, January 28, 2022 at 04:41pm
0 votes

Hi OneSpan

 

We're promoting a template to production, and noticed that the watermark is being promoted as well. We followed the instructions and click yes to "Do you want to upload original Documents?", and selected the folder where the files are located. 

We see upon selecting the folder, there are no files to be seen from the tool. Using the Windows Explorer, the files are in the folder. 

 

Using version 1.5.3 of the tool

carloslau | Posts: 9

Reply to: Template & Layout Copy Tool - Java version

Friday, January 28, 2022 at 04:44pm
0 votes

Hi OneSpan

 

We're promoting a template to production, and noticed that the watermark is being promoted as well. We followed the instructions and click yes to "Do you want to upload original Documents?", and selected the folder where the files are located. 

We see upon selecting the folder, there are no files to be seen from the tool. Using the Windows Explorer, the files are in the folder. 

 

Using version 1.5.3 of the tool

Duo_Liang | Posts: 3776

Reply to:

Monday, January 31, 2022 at 08:45am
0 votes

Hi carloslau,

 

Thanks for your post!

-You mentioned "there are no files to be seen from the tool". I think it's kind of normal because the tool was looking for folders not files (no files will be listed when you navigate into the folder)

-The reason that came on top of my head could be the file name, could we make sure the file name in the folder (e.g. Contract1.pdf) remain the same as the document name in template (e.g. Contract1) so that the tool could match them? If it still doesn't work for you, could you kindly share the original file to [email protected] (if there's no sensitive information) so that I can take a closer look at the issue?

 

Duo

 

sravyareddy | Posts: 1

Reply to: Template & Layout Copy Tool - Java version

Wednesday, April 5, 2023 at 11:31am
0 votes

I am using OneSpan Sign – Template and Layout Copy Tool to migrate Conga templates form sandbox to production. I am encountering issues at various steps in this process. Can someone from your team connect with us and resolve the issues?

Tom_Smith | Posts: 6

Reply to: Template & Layout Copy Tool - Java version

Monday, September 11, 2023 at 08:26am
1 votes

Does the tool have a limitation when using group recipients? We are experiencing the below error when trying to promote templates across environments, because the equivalent group in our other accounts have differing UIDs.

error.notFound.groupNotFound,"technical":"Group with UID a2867c25-32a2-4611-85fe-924d6782c917"

Duo_Liang | Posts: 3776

Reply to:

Monday, September 11, 2023 at 10:14am
0 votes

Hi Tom,

 

Thanks for your post! Yes, I don't think the tool supports to migrate templates/layouts when there are group signers. A quick workaround is to switch the recipient to a placeholder signer first, copy the template/layout, then switch the recipient type back to group signer.

 

Duo

liam.dobie | Posts: 1

Reply to: Template & Layout Copy Tool - Java version

Tuesday, March 5, 2024 at 12:07pm
0 votes

Hi Duo.

 I'm using Docusign and transfering over to Onespan. I

 

 have input all the credentials for both sites. 

Currently now when I go to test, it just says Test Connection Failed. Im using specify environment and the link is https://www.apps.docusign.net 

Not sure if that one is the correct one. Any input on what i should do? 

Duo_Liang | Posts: 3776

Reply to:

Tuesday, March 5, 2024 at 01:05pm
0 votes

Hi Liam,

 

Thanks for your post! Please be aware that this tool can only transfer templates between OneSpan Sign accounts, and it won't be able to help migrate from DS to OSS. If you are looking for migration service, please also reach out to your customer success represetative for further discussion.

 

Duo

JoelSchuuring | Posts: 2

Reply to: Template & Layout Copy Tool - Java version

Wednesday, October 9, 2024 at 04:21am
0 votes

Hi Duo,


I am trying to copy some templates between Senders, but get the following errors:

null
IOEdeP4LP7tq1JeXdNXglEB7Zf0= : Copy Reminder or Visibility fail for template: IOEdeP4LP7tq1JeXdNXglEB7Zf0=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","parameters":{"transactionGuid":"e0DkVH278xLIhxmk76P2DMDxFr0=","documentIds":"default-consent"},"message":"The specified documents does not exist.","code":404,"name":"Resource Not Found"}
rajIo3wA7jhf52KyNdfN7aj-OWE= : Copy Reminder or Visibility fail for template: rajIo3wA7jhf52KyNdfN7aj-OWE=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","parameters":{"transactionGuid":"WExy0ydgbO-UT6JxOn4Dk3N6jyU=","documentIds":"default-consent"},"message":"The specified documents does not exist.","code":404,"name":"Resource Not Found"}
J3GmwJXQDdU-ZOX_oBaK_lwv7jU= : Copy Reminder or Visibility fail for template: J3GmwJXQDdU-ZOX_oBaK_lwv7jU=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","parameters":{"transactionGuid":"Wn1drpYUmFkB7XhOrGiKXCfw8zo=","documentIds":"default-consent"},"message":"The specified documents does not exist.","code":404,"name":"Resource Not Found"}
2nK94Z0V1GRaL7dX7FzEozikz6M= : Copy Reminder or Visibility fail for template: 2nK94Z0V1GRaL7dX7FzEozikz6M=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","code":404,"parameters":{"transactionGuid":"XvTeW5sUKr83qyn25UKj3mrVp1U=","documentIds":"default-consent"},"message":"The specified documents does not exist.","name":"Resource Not Found"}

I am on version 1.6.3.1 of the tool and do not have "Yes" selected for the Remove Default Consent as none of our customers have this enabled. We use the sub-accounts feature, but the senders I am copying the templates between are in the same sub-account. 

Do you have any idea why I am getting these errors?

Thanks in advance.

Regards,

Joël

JoelSchuuring | Posts: 2

Reply to: Template & Layout Copy Tool - Java version

Wednesday, October 9, 2024 at 04:23am
0 votes

Hi Duo,


I am trying to copy some templates between Senders, but get the following errors:

null
IOEdeP4LP7tq1JeXdNXglEB7Zf0= : Copy Reminder or Visibility fail for template: IOEdeP4LP7tq1JeXdNXglEB7Zf0=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","parameters":{"transactionGuid":"e0DkVH278xLIhxmk76P2DMDxFr0=","documentIds":"default-consent"},"message":"The specified documents does not exist.","code":404,"name":"Resource Not Found"}
rajIo3wA7jhf52KyNdfN7aj-OWE= : Copy Reminder or Visibility fail for template: rajIo3wA7jhf52KyNdfN7aj-OWE=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","parameters":{"transactionGuid":"WExy0ydgbO-UT6JxOn4Dk3N6jyU=","documentIds":"default-consent"},"message":"The specified documents does not exist.","code":404,"name":"Resource Not Found"}
J3GmwJXQDdU-ZOX_oBaK_lwv7jU= : Copy Reminder or Visibility fail for template: J3GmwJXQDdU-ZOX_oBaK_lwv7jU=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","parameters":{"transactionGuid":"Wn1drpYUmFkB7XhOrGiKXCfw8zo=","documentIds":"default-consent"},"message":"The specified documents does not exist.","code":404,"name":"Resource Not Found"}
2nK94Z0V1GRaL7dX7FzEozikz6M= : Copy Reminder or Visibility fail for template: 2nK94Z0V1GRaL7dX7FzEozikz6M=; Reason is: {"messageKey":"error.validation.documentsDoNotExist","code":404,"parameters":{"transactionGuid":"XvTeW5sUKr83qyn25UKj3mrVp1U=","documentIds":"default-consent"},"message":"The specified documents does not exist.","name":"Resource Not Found"}

I am on version 1.6.3.1 of the tool and do not have "Yes" selected for the Remove Default Consent as none of our customers have this enabled. We use the sub-accounts feature, but the senders I am copying the templates between are in the same sub-account. 

Do you have any idea why I am getting these errors?

Thanks in advance.

Regards,

Joël

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

LoginSign Up