Typical installation procedures for the Java-based censhare Client and Admin Client.

Target groups

System administrators

Users (on self-managed workstations)

Context

The installation process for all censhare client applications is similar. This article focuses primarily on the censhare Client and Admin-Client.

Introduction

The Java-based censhare Client and Admin-Client are installed on the computer of the censhare user and connect to the censhare Server.

Beginning with the 2019.2 release, censhare officially supports Java 11 and the Open Java Development Kit (OpenJDK). OpenJDK is an open-source implementation of the standard-edition Java platform (Java SE) and does not impose license fees. All censhare client applications in the 2019.2 version are bundled with OpenJDK 11.

You can use the Java-based censhare Client with or without a virtual file system (VFS). censhare-Client installers always include the VFS. Your hosts.xml settings determine whether the VFS is activated. Since the standard censhare-Client installation uses VFS, unless otherwise specified in the settings, the VFS is activated. For more information, see Virtual File System (VFS).

The Java-based censhare Admin-Client is a system-customization and monitoring tool that administrators use to maintain a censhare system. The Admin-Client does not use a VFS.

Download censhare software

The censhare product Portal is the central location for all censhare-related information. Use the Download Center of the portal to locate and download the software that you need.

censhare provides five different client applications:

  • The censhare Client and censhare Web are designed for end-users

  • The censhare Admin-Client handles administrative tasks

  • The censhare Render-Client provides server functionality for InDesign

  • The censhare Service-Client provides additional tools such as ImageMagick, Ghostscript, and more.

All censhare clients are available for macOS and Windows 64-bit. censhare clients before 2019 are also available in 32-bit Windows versions. censhare software for macOS is distributed in the DMG file format. censhare software for Windows is distributed in the ZIP file format. 

You can download precisely the files that you require from an extensive selection of client versions, installers, and related software:

  • Downloads for censhare clients are available from the Download Center of the censhare product Portal. 

  • Individual download files are available for each client version and operating system. 

Notes

(1) Oracle ends support for their Java Web Start software in January 2019. censhare offers a client-deployment feature to help you transition current Java Web Start customers. For more information see, Simple client deployment.

(2) From the 2019.2 release onward, protected and debug versions of the censhare Client are available on request only. The protected Client is not available on Java 8 basis.

For more information, contact your censhare project manager.

Download from the Product Portal

  1. To download a censhare client, log in to your account on https://product.censhare.com/en.

  2. On the start page of the product Portal, select the Downloads from the dropdown.

    The Download Center opens.

  3. To locate the download that you need, use the filter options of the Download Center to search for the desired file. You can combine multiple filters:

    • Client Software: Filters for a specific type of censhare client, installer, or Java version.

    • Operation system: Filters for censhare clients that run on macOS, Windows 32 bit (pre-2019 only), or Windows 64. 

    • Software version: Filters for specific censhare-client releases.

    • File Format: Filters for downloads of a specific file type. 

  4. From the list of search results, click  of the desired censhare software.

    The Downloads dialog opens. 

  5. In the Downloads dialog, click Master (size of download) to begin the download.

Notes

(1) If you do not have access to the Product Portal, you can request an account from the Product Portal home page:https://product.censhare.com/en.  

Unpack and install censhare software 

After you download the client-software package that you need, extract the ZIP package on Windows or mount the DMG file on Mac to start the installation. There are two basic types of installations: client software with an installer and client software without an installer. In general, we recommend that you use the installers.

Install on Windows (without installer)

  1. To install the censhare Client manually, go to the ZIP file that you downloaded and extract the files.

  2. Move the censhare [Software client] [Software version] folder that you downloaded to the default application directory. When this file is placed in the default application directory, one installation is sufficient for all users of the computer.  If multiple censhare clients are installed, create a censhare subfolder in the application directory.

  3. The installation folder contains a censhare executable file (.exe). From the executable file, you can create links to the desktop, start menu, or taskbar as desired.

The censhare Admin-Client and Service Client do not include an installer for Windows. You can use the steps that are described in this procedure for any censhare client that does not include an installer for Windows.

Install on Windows (with installer) 

Installers contain the censhare Client, virtual file system (CBFS forWindows), and OpenJDK 11.

censhare version 2019.1 and higher require a newer Windows virtual file system (CBFS). The new virtual file system uses a different schema for the version numbers. The new schema begins with a year. 

  1. To install the censhare Client with an installer, go to the ZIP file that you downloaded and extract the files.

  2. Click the censhare Client [version] installer.msi file and follow the steps of the installation wizard as directed.

The installer automatically de-installs the older version of the VFS/CBFS and installs the current version. To use different client and VFS/CBFS versions in parallel, re-install CBFS versions as needed. censhare provides separate installer packages for each CBFS version.

Install on macOS (without installer)

  1. To install the censhare Client on macOS, double-click the DMG file to mount it to the desktop.

  2. Locate the censhare Client icon in the mounted volume. Move the application file (.app) to the default application directory. When you place the censhare application in the default application directory, one installation is sufficient for all users of the computer. If multiple censhare clients are installed, create a censhare subfolder in the application directory. 

  3. Create aliases from the client application or add the application to the Mac Dock as desired.

Install on macOS (with installer) 

  1. To install the censhare client on macOS, double-click the DMG file to mount it to the desktop.

  2. To open the installer, double-click the censhare Client installer.pkg. The installer guides you through the installation process. 

Based on the selected macOS, the installer automatically de-installs the older version of the VFS and installs the VFS version that the macOS requires.

Prepare local folder

The local folder provides temporary storage for files that are currently checked out. All versions of the Java-based censhare Client require a local folder. 

If a local folder is not present from a previous installation of a censhare client, you must create the folder in the operating system (Explorer/Finder) of the destination computer. The censhare client creates a sub-directory in this local folder automatically. To name the sub-directory, the censhare client uses the server name or data base name that is defined in your hosts.xml file .

Some special characters are automatically replaced with an underscore in the sub-directory name.

Place the local folder in the home directory of the user. Since the user does not need to access or view the local folder, the folder can be located deep within the home-directory hierarchy. The local folder can be named as desired.     

When no local folder is assigned, the user must select a local folder the first time that the censhare Client requires storage. A dialog in which the user must select a local folder opens automatically. This dialog is untitled and can cause confusion on the part of the end-user. The location that the user selects as the local folder is where the censhare Client creates a sub-directory. To ensure a good user experience, always create and define the local folder during the installation process.

You can assign the local folder manually or with the censhare Server. 

To ensure the best possible performance, place the local folder on a network device that has the adequate speed for your intended use case.

The user must have sufficient permissions to access the location of the local folder on the system. If you use an administrative account for the installation procedure, verify that the user can write to the local folder. 

Assign local folder (manually)

The first time the censhare Client launches, a dialog to enter general settings opens. Define the name and location of the local folder in this dialog. The censhare Client stores the location of the folder in the preferences file of the censhare Client.

  1. To define the location of the local folder manually, launch the censhare Client application.

  2. In the File menu, select Preferences| General.

    A dialog to enter general settings opens.

  3. In the Assets area of the dialog, define a folder location in the Local folder field.

    Click Select to browse locations on the local computer or enter a path manually. For example, on macOS: Macintosh HD/Users/<USERNAME>/censhare-local-folder. For example, on Windows: C:\Users\<USERNAME>\censhare-local-folder .

  4. To save your changes, click OK.

Assign local folder (with the censhare server)

  1. To define the location of the local folder with the censhare server, open the censhare Admin-Client.

  2. Navigate to Configuration | Modules | Clients | Client | and open the desired Client preferences. 

    A [New] Client Preferences dialog opens.

  3. In the [New] Client Preferences dialog, select Edit XML-File.

    The Client Preferences XML file opens.

  4. In the Preferences XML file, locate the asset tag.

    In the asset tag, add a create-local-folder="true" attribute and a local-folder="file:///${user.home}/censhare-local-folder/" attribute.

Standard-server settings override any manual settings that are present.

Define connection parameters

The first installation of a censhare client requires communication parameters to access the application server. Define the communication parameters in a hosts.xml file. Install the hosts file in the correct location before the initial launch of the censhare Client.

If you install a censhare client on multiple computers, distribute the hosts.xml to the required computers to ensure consistency. Do not set communication parameters individually on each computer. For more information, see The hosts.xml file and Client Preferences. 

When the censhare client cannot locate a valid hosts.xml file, a dialog to create a host definition opens. The censhare client generates a hosts.xml file from the hostname and connection string (URL) that you enter in the dialog.

Define preferences

The censhare client follows and stores the preference settings that you define. You can enter preference settings manually in a configuration dialog or install predefined preference files. Some parameters in the preference settings are essential for production. The installation procedure must ensure that all production-critical preference settings are accurate.

Test the newly-installed client

Each newly-installed censhare client must be tested to ensure proper operation for the end-user. Testing is necessary, even when preferences, local folder, and communications presets are available from a previous censhare-client installation. 

Perform a quick fitness test:

  • Launch the application.

  • Log in with a user account. 

  • Perform a quick search and an expert search.

  • Save and open an asset that includes a master file. For example, an image.

  • Open, edit, and save a layout document with InDesign (if applicable on your system). For example, place a local image onto a layout and save the changes (installed InDesign plug-in is required).

  • Drag an asset with a file to the desktop to verify that the VFS functions (if applicable). For example, drag an Image, Layout, or Text asset to the desktop.

  • Drag one asset to another asset to create an assignment relation.

Completion of these operations (without any error messages) verifies correct network setup, local folder configuration, and client/server compatibility. For technical support, submit a support ticket on the web-based or Java-based Tracker support system.

Result

You can successfully install the desired censhare client.