Upgrade Typefi Desktop

This article is a how-to guide for system administrators—or others with a similar IT background—who are upgrading Typefi Server for Desktop (Typefi Desktop).

There are two ways you can upgrade your Typefi Desktop:

1. Self-service. If you want to complete the upgrade process yourself, please follow the steps in this article. We strongly suggest discussing this upgrade with your Solutions Consultant before upgrading.
2. Full-service. If you want us to complete the upgrade process, please contact your Solutions Consultant to schedule a time. 

Prepare to upgrade

Please allow 1-2 hours for the upgrade. If you are migrating to a new computer and upgrading, complete the migration process before upgrading.

Use this table to help you prepare to upgrade:

FAQ

• How long will the system be down? Please allow 1-2 hours of downtime for the upgrade.
• Will a restart be required? Yes.
• When will this happen? As desired. Please contact your Solutions Consultant to schedule a time.

Download required files

Access the Typefi FTP to download the installers for each component you need. Depending on the system requirements, you may only need all components.

Install components

We recommend installing the components in this order: Typefi Designer, Typefi Writer (if using), Typefi Server for Desktop, and then the workflow plug-ins you have licensed.

Install Typefi Designer

1. Run the installer. If you are using macOS and cannot open the installer, please follow the steps in this workaround.
2. Follow the steps in the installer, accepting all default settings. There's no need to change the installation path.
3. Verify the installation:
   1. Open Adobe InDesign and navigate to Window → Typefi to verify that Typefi Designer is installed. If you do not see Typefi as an option, Typefi is not installed.
   2. Check the version number to ensure it matches the installer. For example, Typefi_Designer-8_7_1_1179.dmg corresponds to Typefi Designer 8.7.1. To check the version, go to:
      • Windows: Help → About Plug-ins → About Typefi Designer
      • macOS: InDesign → About Plug-ins → About Typefi Designer.

Install Typefi Writer

Custom DOTM files and other integrations may interact with each other and cause issues during the upgrading process. Your Solutions Consultant can help you remove  and replace old DOTM files with new DOTM files. Alternatively, you can follow the instructions in the help article, Missing customizations in Office Word after an update.

1. Run the installer.
2. Follow the steps in the installer.
3. Verify the installation:
   • Open Microsoft Word and verify that the Typefi tab is in the Word ribbon. If you do not see the Typefi tab, please follow the steps in the help article, Typefi ribbon does not appear in Microsoft Word.

Install Typefi Server for Desktop

1. Run the installer.
2. Follow the steps in the installer. We recommend that you accept all default settings. Once the installer completes, Typefi Server for Desktop launches as a background application.
3. Restart your computer.
4. Verify that Typefi Server for Desktop is installed:
   1. Open your web browser and visit http://localhost:8080. You should see the Typefi sign-in page.
   2. Sign in as an administrator.

Workflow plug-ins

1. In your Typefi Server, go to Admin → Plug-ins.
2. At the bottom of the page, click + Add Plug-in.
3. Browse for the appropriate WAR file you downloaded and select it.
4. Wait. The installation process may take several minutes, especially when installing large plug-ins, so please be patient. The screen will eventually refresh and display the plug-in with all available actions. If it does not, click Reload (located at the bottom of the screen).
5. Verify that the actions you intend to use do not indicate Unlicensed:
   • If the action is unlicensed and you purchased the plug-in, contact your Solutions Consultant to have the license updated or re-issued.
   • If the action is unlicensed and you have not purchased the plug-in, contact the Typefi Sales Team.

To install workflow plug-ins directly within the file system, refer to help article, Install workflow plug-ins and actions.

Troubleshooting

• Each time you add a WAR file, the process may take a moment and will populate the new workflow action on that screen with an auto-refresh. Do not cancel or manually refresh the page.
• If you do not see the WAR files uploading, a local security setting is affecting the system. As a temporary workaround, locate the Typefi installation folder, click on .\Typefi\Server\webapps and paste all the WAR files into that folder. You will see them self-extract within a few moments. If this happens, make a note of the issue so that it can be resolved.
• If a workflow action has an orange badge in the top right corner, a newer version is available. Click the badge to update the action. For more information, see the help article, Update an action.

Configure and license your Typefi Server ↩

To configure:

1. Open InDesign and minimise it. InDesign must be open when configuring a new engine.
2. In your Typefi Server, go to Admin → Add-ins and click InDesign.
3. Click New Engine.
4. Name the new engine, for example, ID 2021. The name set here is used in all the workflows. If you change the name here later, all the workflows must be updated, too. We recommend using a simple name, such as ID + the year, which reflects the InDesign version.
5. Choose the InDesign version from the pop-up menu.
6. Click Refresh.
7. Verify the PDF presets are loaded.

To license:

This step requires internet access.

1. In your Typefi Server, go to Admin → Licenses.
   
2. Click Add / Update (located at the bottom of the screen). A new tab will open, indicating whether or not your license request was successful. If you click Add / Update more than once, all subsequent claims will fail. The license key will be emailed to your organisation's designated Tech Rep. The Tech Rep is the person at your organisation who is in charge of licensing your Typefi Server.
3. Close the new tab you have open. The previous tab will have a box where you can enter the license key. 
4. Paste the license key exactly as it is in the email.
5. Check to see if the new license is present. If it is, you are good to go. If it is not, go to Admin → Log and scroll to the bottom of the log. Copy and paste the last few lines (you will see a message about the license failure) and send it to your Solutions Consultant for the next steps.

If you use third-party software with Typefi, such as movemen MathML or DeltaXML, you may also need to update those licenses. For MathTools, see the help article, License movemen MathTools with Typefi.

Run a test job ↩

As a best practice, we recommend building a test workflow to make sure your Typefi Server is configured correctly.

Troubleshooting

If your workflows are not running, check the job log. If you see this error, Could not run workflow (workflow.typefi_workflow). Invalid license. Contact Typefi to obtain a valid license., then go back to the Admin → Licenses page and delete all licenses except for the most recent one.

Then, run the test workflow again.

If deleting the old licenses did not fix the issue, please contact your Solutions Consultant.

movemen MathTools ↩

movemen MathTools is a subscription product. To upgrade to a newer version of MathTools for InDesign:

1. Download the latest MathTools installation package from the MathTools Download Area. Make sure to install the MathTools package that matches your InDesign version. If you are using Microsoft Windows, make sure you unblock it.
2. If InDesign is open, close it.
3. Move the movemen folder from the InDesign Plug-ins folder somewhere else (for example, your Desktop).
4. Extract the ZIP archive you downloaded (in step 1) to the InDesign Plug-ins folder inside the InDesign application folder.
5. Navigate to your old movemen folder (moved in step 3) and select the license file (for example, movemen/lic/mt.MathToolsV2.lic).
6. Important: Copy your existing license file and paste it into the new movemen folder you extracted to the InDesign Plug-ins folder in step 4.
7. Open InDesign.
8. Choose Math → Licensing → Verify License.
9. Close and reopen InDesign.
10. Verify that MathTools is activated:
    • Create a new document and choose Math → Enable Math for Current Document.

If you are licensing MathTools for the first time, licenses are only issued after Typefi has received payment. It may take up to 10 business days to receive a license. For more information, see the help article, License movemen MathTools with Typefi.