About Add-in Setup Tool

This page introduces "Add-in Setup Tool" which is a simplified tool for batch registration of an add-in.

Add-in Installation Method with "Add-in Setup Tool"

The following is how to install an add-in using "Add-in Setup Tool". (Also see the notes.)

1. Extract the add-in ZIP file.
2. Make sure that EA has not been started.
3. Select the file EAAddinSetupEn.bat located in the folder that contains the contents of the extracted add-in ZIP file., right-click and execute "Run as administrator".
4. When the installation finishes, the message "The Add-in is successfully registered." is shown.
5. Start EA and check if the add-in can be used.

Uninstallation Method

1. Extract the add-in ZIP file if necessary.
2. Open a command prompt by a user with administrator privileges.
3. Move to the folder that contains the contents of the extracted add-in ZIP file.
4. Execute "EAAddinSetupEn.bat /u".

Troubleshooting

The possible causes for each issue when running Add-in Setup Tool are described below. If you cannot find the cause, please contact support.

1. If the following error messages are shown when running EAAddinSetupEn.bat:

   ERROR	Possible causes and measures
   Sharing violation	EA has already used the corresponding add-in, and EA has started. Please install with EA closed.
   UNC paths are not supported.	The batch file does not support UNC format (\\name). Please move it together with .ini and .dll to a local machine and execute.
   Windows protected your PC	Restricted by Windows Defender SmartScreen. Open the properties of EAAddinSetup.bat, check "Unblock" in the "Security" at the bottom of the "General" tab to release "Block setting of downloaded file", then execute it.
   ERROR: Permission denied. Please start [Run as administrator].	Select EAAddinSetupEn.bat, right click and execute "Run as administrator".
   ERROR: EA Install path not found.	It is possible that EA has not been installed, or has never been started by the install user with administrator privileges. Open command prompt with administrator privileges, execute '(EA Install path)\EA.exe /register' and then re-execute.
   ERROR: ***file copy failed.	The EA installation path may not have been obtained correctly. Start EA by the install user with administrator privileges, close it, and then re-execute. If there is also a message "Permission denied", the install user may not have sufficient permission.
   ERROR: .NET Framework not found.	The .NET Framework required for the add-in execution may not have been installed. Read the add-in description and install the .NET Framework required for execution.
   ERROR: Require EA build **** or later.	The Version of EA required for the add-in execution may not have been installed. Read the add-in description and install the version of EA required for execution.
   ERROR: *** item in ini file is incorrect.	The contents of the EAAddin.ini may be incorrect. Contact the add-in distributor or Sparks Systems Japan Support.

   
   
2. If execution of EAAddinSetupEn.bat ends immediately and the add-in is not registered:
   Check if the name of the folder where EAAddinSetupEn.bat locates and the names of the high-order folders include '&' '(' '^' etc. If included, change the names not to include those symbols and re-execute "Run as administrator".
   
   
3. If the add-in is successfully registered by executing EAAddinSetupEn.bat, but the add-in is not available:
   • If the name of the registered add-in is not shown on the Add-In Manager called from "Specialize Ribbon > Add-Ins > Manage":
     • The access to the Registry is denied. Log in as a user who can access the registry and try again.
   • If the name of the registered add-in is shown on the Add-In Manager called from "Specialize Ribbon > Add-Ins > Manage" but also an error message is shown:
     • The contents of the EAAddin.ini may be incorrect. Contact the add-in distributor or Sparks Systems Japan Support.
   • If an error occurs when executing the add-in:
     • There is a problem with the add-in. Contact the add-in distributor or Sparks Systems Japan Support.
   
   

Notes

The following are notes on using the batch file EAAddinSetupEn.bat.

• Select EAAddinSetupEn.bat, right click and execute "Run as administrator".
• Make sure that the name of the folder where EAAddinSetupEn.bat locates or the names of the high-order folders do not include '&' '(' '^' etc.
• Prior to EAAddinSetupEn.bat execution, it is required to execute EA once by the administrative user who executes EAAddinSetupEn.bat.
• In order to register an add-in created using .NET Framework, .NET Framework needs to be installed.
  The required .NET Framework version depends on the add-in installation settings.