Skip to content
English
  • There are no suggestions because the search field is empty.

Upgrading Shinydocs Pro

This guide covers upgrading Shinydocs Pro from one 26.x release to a newer one, for example from 26.4 to 26.5.2. An upgrade has three parts: preparing, upgrading the Shinydocs Pro server, and, from 26.5, upgrading each source’s index.

Upgrading from 25.x or earlier? Contact Shinydocs Support before you start.

Before you upgrade
  1. Read the Shinydocs Pro Release Notes for every version between yours and the new one, especially their Before you upgrade notes. For example, from 26.5.0, Document Mobility (the former Downloads beta) and System of Record need a license add-on. To check your license, see How To Update Your Shinydocs Pro License.
  2. Let running work finish. When you upgrade from a version before 26.5, any analysis, remediation or bulk tagging that is still queued or running is stopped and doesn’t carry over. A disposal that has already started deleting carries on after the upgrade.
  3. Check free disk space on the search engine server. From 26.5, each source’s index is upgraded by copying it into a new index, so the search engine needs room for a second copy of the index being upgraded. Control Center checks the space before each index upgrade starts.

Back up Shinydocs Pro

Control Center keeps its settings and database under %ProgramData%\Shinydocs\ControlCenter. The installer leaves this folder in place, but take a copy before you upgrade so you can go back if you need to.

  1. On the Shinydocs Pro server, open Services and stop Shinydocs Control Center.
  2. Copy the %ProgramData%\Shinydocs\ControlCenter\database folder, which holds embedded.db and, if present, embedded.db-wal and embedded.db-shm. Copy all three together.
  3. Copy the appsettings files in %ProgramData%\Shinydocs\ControlCenter, such as appsettings.json and appsettings-override.json, if they exist.
  4. Stop Shinydocs Search Engine in Services and copy its data folder, which holds your indexes. It is in the Shinydocs Pro install folder, by default C:\Program Files\Shinydocs Professional\SearchEngine\data. If it was moved, the path.data setting in the search engine’s opensearch.yml file gives its location; see Relocating the Shinydocs Search Engine Data Folder. Start Shinydocs Search Engine again when the copy is done.
  5. Copy the agent’s settings, %ProgramData%\Shinydocs\Agent\connection.json and, if it exists, %ProgramData%\Shinydocs\Agent\appsettings-override.json, from the same server.

Store the copies somewhere safe. The database holds connection credentials.

Upgrade the Shinydocs Pro server
  1. Sign in to the Shinydocs Pro server as an administrator.
  2. Run the installer for the new version, as described in Shinydocs Pro Installation Guide. In Options, you can leave out components that don’t need reinstalling.
  3. The installer stops Shinydocs Control Center and starts it again when it finishes. It also upgrades the Shinydocs Agent, which runs on the same server.

The first time Control Center starts after an upgrade, it updates its database before Windows shows the service as running, so the start can take longer than usual. If Windows reports that the service didn’t respond in time (error 1053), see Shinydocs Control Center service times out when starting (Error 1053).

Upgrade source indexes (26.5 and later)

From 26.5, a source whose index was created by an earlier version must have its index upgraded before analysis can run on it. The Sources page shows how many need it, for example 3 sources need their indexes upgraded before they can be analyzed., and lists them under Upgrade required.

  1. Go to Sources and select Upgrade on the source. You can also open the source and select Upgrade index.
  2. Read the message, which says the upgrade copies every document into a new index and that the source can’t run until it finishes, then select Upgrade.
  3. Follow the progress on the source, for example Upgrading index… 40%. When it finishes, you see Index upgraded.

While it runs:

  • Nothing else can run on the source: analysis, disposal, reports, downloads and bulk tagging wait until the upgrade finishes. If one of these is already running, the upgrade waits for it, or asks you to try again once it has finished.
  • Only one index upgrade runs at a time. Others queue behind it.
  • Large indexes take a while. For a source with a million documents or more, the message warns you.
  • To stop, select Cancel upgrade. The source keeps the index it had.

If some documents can’t be copied, the upgrade finishes with Index upgraded, but … documents couldn’t be copied and were set aside. They are kept in a separate index, and the source’s index information says where.

If Control Center restarts during an upgrade, the source shows as needing an upgrade again. Start it again once the search engine has finished or cancelled the copy it was making.

Optional: reclaim disk space

Indexes from some earlier versions use an older format that takes more space. These show Update index instead of Upgrade, in the source’s index information and on System Health > Indexes. Updating is optional: it moves the index to the current, smaller format the same way, and the source can’t run while it does.

After the upgrade
  • On Settings > Agents, the agent is Online and its Version matches Control Center. An agent with a different version shows as Incompatible and gets no work.
  • On Sources, no source shows Upgrade. Run analysis on one source to check that it starts.
  • From 26.5, Control Center keeps connection certificates in its database instead of reading them from a file. On upgrade it copies each certificate file it can read. If it couldn’t read a file, for example because the file had moved, the connection keeps working, but enter the certificate again the next time you edit the connection.