Skip to main content

Upgrade Typefi Cloud

Karl J.
  • Updated

This article is a how-to guide for system administrators—or others with a similar IT background—who are responding to a Typefi Server for Cloud upgrade.

Since you are a Typefi Server for Cloud customer, we will do the upgrade for you. Your organisation's Tech Rep—the person in charge of licensing Typefi Server—will receive a notification two weeks before the upgrade. Depending on the upgrade, you may need to update your client software.

Prepare to upgrade

Use this table to help make sure you are ready for the Cloud upgrade:

Task Description
Make sure you have admin privileges. You'll need admin privileges to complete the installation of Typefi Designer and Typefi Writer (if using). If you don't have admin privileges, make sure you have access to credentials (username and password) to fill in during the install.
Check the system requirements. For example, Typefi Server 8.7.2  added support for Adobe InDesign 2021 and retired support for InDesign 2018. You'll want to make sure you have InDesign 2019 or later.
Update InDesign to the required version. If upgrading Typefi Server requires an updated InDesign version, we recommend updating InDesign first (use the Creative Cloud app). If you use movemen MathTools, the InDesign version also affects which version of MathTools you need to have locally. Once the updated InDesign version is installed, perform the following checks:
  • Confirm that InDesign opens, and you can create a simple one-page document and save it.
  • Confirm that the InDesign user details are filled in under File → User. If this has not been set, then on running the first job, InDesign will open a dialogue box asking for the user details. This prevents Typefi from running.
  • Confirm that the PDF Presets have been migrated from the previous version of InDesign. File → Adobe PDF presets.
  • Confirm that the PDF job options have been migrated from the previous version of InDesign. The job options are stored here:
    • Windows: C:\Program Files\Adobe\Adobe InDesign [Year]\Resources\Adobe PDF\settings\mul
    • macOS: Library/Application Support/Adobe/Adobe PDF/Settings
  • Unless specifically required, the language version of InDesign should be English. Creative Cloud App → Profile (top right) → Preferences → App → Installing → Default install language: English.
  • If MathTools is installed, confirm the plug-in has migrated to the updated InDesign version. Math should be in the top menu.
Typefi Writer workflows only: Let your Solutions Consultant know if you have any of the following:
  • custom DOTM files you made
  • custom DOTM files we made
  • other integrations (such as MathType or DeltaXML)
 These may interact with each other and cause issues during the upgrading process. Your Solutions Consultant can help you remove old DOTM files and replace them with new DOTM files. Alternatively, you can follow the instructions in Missing customizations in Office Word after an update.

FAQ

  • How long will the system be down? Please allow 1-2 hours of downtime for the upgrade.
  • Will a restart be required? No.
  • When will this happen? Your organisation's Tech Rep will receive a notification two weeks before the upgrade.

Download required files

Access the Typefi FTP to download the installers for each component you need. Depending on your workflows, you may not need all components.

Component Location on FTP
Typefi Designer Typefi__Designer
Typefi Writer (if using) Typefi__Writer
Workflow plug-ins Typefi__Server Plugins

Only download the plug-ins that you have licensed. For a list of each plug-in and its filename on the FTP, see Typefi latest releases.

 

Install components

We recommend installing the components in this order: Typefi Designer, Typefi Writer (if using), 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 defaults. There is no need to change the installation path.
  3. Verify the installation:
    1. First, verify that Typefi Designer is installed. Open Adobe InDesign and navigate to Window → Typefi. If you do not see Typefi as an option, Typefi is not installed.
    2. Next, verify that the version number 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 InDesign → About Plug-ins → About Typefi Designer (macOS) or Help → About Plug-ins → About Typefi Designer (Windows).

Install Typefi Writer

Custom DOTM files and other integrations may interact with each other and cause issues during the upgrading process.

  1. Run the installer.
  2. Follow the steps in the installer.
  3. Verify the installation: Open 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 Typefi ribbon does not appear in Microsoft Word.

Workflow plug-ins

  1. Sign in to your Typefi Server as an administrator.
  2. Go to Admin → Plugins.
  3. At the bottom of the page, click + Add Plugin.
  4. Browse for the appropriate WAR file you downloaded from the Typefi FTP, and select it.
  5. 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 along with all available actions. If it does not, click Reload (located at the bottom of the screen).
  6. Verify that the actions you intend to use do not indicate Unlicensed:

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 it can be resolved.
  • If a workflow action has an orange Update badge badge in the top right corner, a newer version is available. Click the badge to update the action. For more information, see Update an action.

Configure and license your Typefi Server

To configure your Typefi Server:

  1. Sign in to your Typefi Server as an administrator.
  2. Go to Admin → External Applications and click InDesign.
  3. Click New Engine.
  4. Give the new engine a name; for example, ID 2021. The name set here is used in all the workflows. If you change the name here at a later stage, then all the workflows will need to be updated as well. We recommend using a simple name, such as ID 2021, 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 your Typefi Server:

This step requires internet access.

  1. In your Typefi Server, go to Admin → Licenses.
    Admin → Licenses
  2. Click Add / Update Add / Update button (located at the bottom of the screen). A new tab will open indicating whether your license request was successful or not. 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.
  3. Close the new tab you have open, and the previous tab will have a box to enter the license key. 
  4. Paste the license key exactly as it is written 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 need to update those licenses too. For MathTools, please see Licensing 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.

Delete old licenses

Then, run the test workflow again.

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

Upgrade movemen MathTools

movemen MathTools is a subscription product. To upgrade to a newer version of MathTools for InDesign, follow the instructions in this article.

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 Install and license movemen MathTools.

FAQ

  • How long will the system be down? Not at all.
  • Can this be done remotely? Yes.
  • Will a restart be required? No.
  • When will this happen? As desired.

Related articles

Comments

0 comments

Please sign in to leave a comment.