Skip to main content

Controlsuite : How to install Equitrac Workstation Client silently from the command line without displaying Security Framework Credentials

Article # 3042279 - Page views: 41


How can the Equitrac Workstation Client be installed silently from the command line without displaying Security Framework Credentials in plain text?


There are two options:

Use a Token

A Token can be generated on the Security Framework Server to use in the Workstation installation script

Follow the process below:

  1. Open a Command Prompt as administrator
  2. Navigate to the Program Files\Kofax\Shared Services\SecurityFrameworkService\NDISecTool\ directory
  3. Run the command :  NDISecTool.exe" -clientinstalltoken -u sfs_admin_user -p sfs_admin_password -expires seconds_from_now > token.txt
  4. This will generate a text file containing the token


sfs_admin_user                User used to login to the Security Framework in Confoguration Assistant. (if not using a domain prefix with a backslash e.g. \adminuser)

sfs_admin_password     Password for above

Seconds from Now           In the range of 1 to 604800 (7 days) seconds. Maximum token expiry time is one week

Once you have the token add to the silent installation script

Example below

MsiExec.exe /i "Equitrac.Client.x64.msi" CASNAME="CASserver" LANGUAGE="en" ADDLOCAL="Common,DRC,ManagedQueue,IQueue,EQMsg" SFSHOST="Security Framework Server" SFSFIXEDTOKEN="eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCIsIng1dCNTMjU2IjoiQjIyNDlDRjM1MTYzRjIzNjI0N0JCNjVEMERBQzM1RkI0NkUzRTcxRCJ9.eyJpc3MiOiJXUTA2M0lORjEwMDA0Iiwic3ViIjoiL3VzZXJzL2NhXFxmcmFtZXdyayIsImV4cCI6MTYzNjY0MDEwNSwiaWF0IjoxNjM2MDM1MzA1LCJqdGkiOiI0ZmRiYTU0MS1jMDQzLTQ1MTAtYmQ4Yy1iMTY1NmZjZTlmYjYiLCJncm91cHMiOlsiZ3JvdXAxIiwiZ3JvdXAyIl0sInJvbGVzIjpbInNmczpjbGllbnRpbnN0YWxsIiwiZGRiOmRhdGFjZW50ZXJzOnJlYWQiXSwidXNlciI6eyJJZCI6IjE1MTA2M2JiLWUxNzMtNGQ1My1iOTVhLTQyZDRhMmFiYThiYiIsIkF1dGhlbnRpY2F0aW9uU291cmNlIjpudWxsLCJEb21haW4iOiJjYSIsIlVzZXJQcmluY2lwbGUiOiJmcmFtZXdyayIsIlBhc3N3b3JkIjpudWxsLCJFbWFpbEFkZHJlc3MiOm51bGwsIkxvY2tlZCI6ZmFsc2UsIkRpc3BsYXlGdWxsbmFtZSI6bnVsbCwiRGVzY3JpcHRpb24iOm51bGwsIkdyb3VwcyI6bnVsbCwiUm9sZXNQZXJTZXJ2aWNlIjp7InYxLXNlcnZpY2UiOlsic3NkczpwdWJsaXNoIiwic3Nkczp1bnB1Ymxpc2giXSwidjEtYXV0aCI6WyJhdXRoOmNsaWVudHM6d3JpdGUiLCJhdXRoOmNsaWVudHM6ZGVsZXRlIiwiYXV0aDp1c2Vyczp3cml0ZSJdLCJ2MS1kZGJtYW5hZ2VtZW50IjpbImRkYjpkYXRhY2VudGVyczpyZWFkIiwiZGRiOmRhdGFjZW50ZXJzOndyaXRlIl19fX0.BBS8o2i4NgWREVmwA-q5a_cfAoq_gyoFJa8ofot2efMvnkV9RoP-mx_uAWUC9e1hqqQI9SqC2emGG8jNQvTWfw" DATACENTERNAME="Datacentername" IQUEUE_DEFAULT_PAPERSIZE=9 IQUEUE_DEFAULT_COLOR=1 IQUEUE_DEFAULT_DUPLEX=2 /passive /l*v Install.log


/passive means show a progress bar (/qn can be used instead for silent install without any visibility)
/l*v Install.log will create a log file

See the Kofax Equitrac Client Installation Guide for silent install options.

Use a Transform File

If a week is not long enough the alternative is to use a Transform File. This will store all the variables normally added on the command line.


1.       You will need to install Orca, which is the tool for editing MSI files. (

2.       Download the Equitrac Workstation Client

3.       Right click on the .msi file and choose Edit with Orca

Transform 0.png

4.       Once you have Orca opened, click on the Transform tab for "New Transform". 

Transform 1.png

5.       Next, navigate to the Property Tab

6.       Right click and choose ‘Add New Row’ to create a new entry

Transform 2.png

7.       Add new rows for all the options and enter the values as you would in the silent installation script (no speech marks are required to encapsulate the options)

Transform 3.pngTransform 4.png
Transform 5.png

8.       Once all options have been added Go back to the Transform tab, then select Generate Transform to complete the mst creation

Transform 6.png

9.       Now the Client and its transforms are ready to deploy using the remaining switches

Example below

msiexec /i Equitrac.Client.x64 TRANSFORMS=”Transform.mst” /qn /l*v install.log



Applies to:  

Product Version
Controlsuite 1.x


Article # 3042279
  • Was this article helpful?