The user account “SSAdministrator” is the service account used to proxy all document and data access requests to individual clients. This account is used when authorizing access for most Square 9 Windows Services, in addition to acting as the Application Pool user for both GlobalSearch and GlobalCapture. When GlobalSearch is installed it creates the SSAdministrator account and requires that the user performing the installation create a password. While a complex password is not required by GlobalSearch, it must comply with your system’s password requirements for the application to work properly. The password is case sensitive.


Change Password in Application Pools

The Application Pool identity of the GlobalSearch and GlobalCapture application pool needs to be updated to reflect the new password.


  1. Open the Microsoft Internet Information Services Manager (IIS) on the GlobalSearch server.

  2. Expand the server to see the Application Pools folder.

    Application Pools in the IIS Manager


  3. Within the Application Pools folder, right-click on the SmartSearch4 application pool and select Advanced Settings from the context menu.

  4. In the Advanced Settings window, under the Process Model section, click on the Identity tab.

  5. To edit the Identity, click the More (three dots) button.

    Identity in the Advanced Settings


  6. In the Application Pool Identity window, select Custom account and click Set.

    Application Pool Identity


  7. In the Set Credentials window that appears, enter the credentials of the local or domain SSAdministrator:

    1. Enter the local or domain username of the SSAdministrator in the User name text box.

    2. Enter the password of the SSAdministrator in the Password text box.

    3. Confirm the password in the Confirm password text box.

      Your domain location will depend on where you want your users to be located and authenticated from. For local installations, users will be on the Local System, therefore you will need to use the local SSAdministrator. For domain installations, users will be on the domain in the Active Directory therefore, you will need to use the domain SSAdministrator account.

  8. In the Advanced Settings, Application Pool Identity, and Set Credentials windows, click OK.

  9. If the SmartSearch4 application pool is not currently running, right-click on it to select it and then in the context menu, click Start.

  10. Repeat steps 3 through 9 for the GlobalCapture application pool.

  11. Once the identity has been updated, make sure the application pool is running. If it’s not, right-click on the pool and select Start from the context menu.

    Run the GlobalCapture and SmartSearch Application Pools


Update Services

Since GlobalSearch version 4.2, the Service Console has been released as an efficient way to update all GlobalSearch services, although the services can still be accessed through the normal Windows Service menu. All GlobalSearch services must be updated from the Services Console for permissions to be properly applied; the ssContentSearch service is the only exception. To set the ssContentSearch service permissions, please use the procedure in the “Change the SSAdministrator Password#Update the ssContentSearch Service” section below. If the services do not update from Service Console on your system you will need to update the SSAdministrator password manually on each service. 


Run the Service Console

Below 6.1 service console section. 

  1. Right-click on the Service Console and click Run as an Administrator. The console is located C:\GetSmart, or wherever the GetSmart directory is stored.

    Service Console in the GetSmart Directory


  2. Once the console is open, to stop all the services, click Stop All.

    Stop Services in the Square 9 Services Console


  3. Enter in the SSAdministrator or the service user in User text box and the corresponding password in the Password and Confirm text boxes.

  4. Click Set Services. A minute wait time is required before you can restart the services.

  5. Once a minute has passed, click Start All. The services will restart one by one.

  6. Once all the services have been started, close the service console.

For 6.1 and above.

  1. As of 6.1.x Service Console is located in a different folder path. 

    C:\Program Files\Square 9 Softworks\Service Console

    You can search for Service Console in the Windows menu instead of running the file directly. 
  2. Service console also has the ability in 6.1 and above to update the Authentication Server. Which you don't need to do for a password change.

GlobalCapture Service Console stand alone.

  1. Some customers have stand alone GlobalCapture. Meaning you only have GlobalCapture. Your service console is located in a different folder.
  2. C:\GetSmart\GC_ServiceConsole  ServiceConsole.exe



Update the ssContentSearch Services

  1. Launch the Windows Service menu. This can be reached by running Services.msc, or it can be found under your Administrative Tools.

  2. Right-click on the ssContentSearch service and go to Properties.

    ssContentSearch Service


  3. In ssContentSearch Properties, on the Log On tab, change the logon user in the This account text box.

  4. Click Browse and select the SSAdministrator. The user you will use should be the same user entered in the Service Console and the Application Pools. Verify that the domain name is consistent with the other applications.

    ssContentSearch Properties


  5. Enter the updated password in the Password and Confirm password text boxes and click OK.

  6. In the Windows Service Menu, verify any other service running as the SSAdministrator has been updated as well. Both the S9 GlobalAction and the GlobalCapture_1 services will most likely stay running as Local System. This is normal and they can function without issue as Local System. Depending on your installation, these services may have been changed to run as the SSAdministrator user instead. If so, you will need to update them using steps 2 through 5.


Update GlobalCapture Portals

The GlobalCapture Portals are the last section that will need to be updated.


  1. Browse to the GlobalCapture menu.

  2. Once signed in, click the Manage (
    ) icon.

    GlobalCapture Home Page


  3. From the menu on the left, select Portals. By default, there are three portals installed: Batch Portal, Analytics Portal, and Square9 API Portal. All three portals run off the SSAdministrator or service user. If you have additional portals, all of them will need to be updated as well.

  4. Click on the More Options (
    ) icon and select Edit.

    GlobalCapture Portals


  5. Verify that the SSAdministrator is listed as either the domain or local user, depending on your installation. If need be, change the username to correspond with the user used in the previous “Application Pools” and “Services” steps.

  6. Enter in the new password in the Password text box.

  7. To finish, click Save.

  8. Repeat steps 4 through 5 for the other portals until all passwords have been updated. The Test Connection (circle) icons located in the top left of each row to should now be green to indicate successful Portal connections.

    Configure Portal Settings


Update Windows Scheduled Tasks


If you have any Scheduled Tasks that use the SSAdministrator user you will have to update the password for those tasks as well. You will need to check each scheduled task, the "Author" does not always match the "Run As" configuration on the task

Simply double click on any of the scheduled tasks and click "Ok" on the popup and it will prompt you to update it.

Update MongoDB SSAdministrator Users

It is important to note that this step only needs to be taken if you have authentication set up for your instance of MongoDB, for more information please see the Enabling Mongo Authentication Knowledge Base article.

In the event that you need to reset your SSAdministrator password, you will need to update the Mongo database users. You should first make sure that you have updated your SSAdministrator password using the instructions above.

This update can be performed one of two ways listed below:

Mongo Shell

  1. Open an authenticated Mongo shell by running the following commands using an administrative command prompt. Replace "MyAdminUser" and "MyAdminPassword" with the Mongo admin username and password you created.

    cd C:\GetSmart\mongodb\bin
    mongo.exe --port 27017 -u MyAdminUser -p MyAdminPassword --authenticationDatabase "admin"
    POWERSHELL
  2. In the Mongo shell, run the following commands. Replace "SSAdministrator" and "MySSAdministratorPassword" with the username and password (respectively) for your Square 9 service account.

    use WorkflowEngine
    db.updateUser("SSAdministrator",{pwd:"MySSAdministratorPassword"})
    JS

    This SSAdministrator user is case sensitive and will need not just the password, but also the username to match exactly to the user set up to run services in the Service Console (i.e., 'SSAdministrator' is not the same as 'ssadministrator' )

  3. Repeat the previous step for the ServiceEngine, PortalSecurity, and CaptureWorkflow databases. To do this, replace "use WorkflowEngine" with "use ServiceEngine", etc.
  4. Restart the ssBatchPortal, S9GlobalAction, and GlobalCapture_1 services.

Mongo Database GUI (i.e., Robo3T or MongoDB Compass)

  1. Open your MongoDB visualizer of choice and sign in with the Mongo admin username and password you created.

  2. In your MongoDB visualizer, you should see all your databases in the Object Explorer, and expanding each will show you a Users object containing your SSAdministrator user.

  3. For each database (ServiceEngine, PortalSecurity, CaptureWorkflow, etc.) you will want to open a shell by right-clicking on the database. Run the query below replacing "SSAdministrator" and "MySSAdministratorPassword" with the username and password (respectively) for your Square 9 service account.

    db.updateUser("SSAdministrator",{pwd:"MySSAdministratorPassword"})
    JS

    This SSAdministrator user is case sensitive and will need not just the password, but also the username to match exactly to the user set up to run services in the Service Console (i.e., 'SSAdministrator' is not the same as 'ssadministrator' )

  4. Restart the ssBatchPortal, S9GlobalAction, and GlobalCapture_1 services.