Upgrading

This article describes how to upgrade App Studio and Appkit.

Upgrade App Studio

When you upgrade Fusion Server, that also upgrades App Studio to its latest version, and its embedded Appkit to the Appkit version in the App Studio release. The App Studio version might differ from the Fusion Server version. Not all Fusion Server upgrades have a new version of App Studio.

Note
An App Studio release might not contain the latest version of Appkit. Check the App Studio Release Notes and Appkit Release Notes to confirm the versions. To upgrade a new app to a more recent version of Appkit than the version that an App Studio release contains, create the app and then Upgrade Appkit in the app.

The App Studio upgrade doesn’t upgrade the version of Appkit used in existing apps. For that procedure, see Upgrade Appkit in existing apps.

Upgrade Appkit in existing apps

When you create an Appkit webapp, it uses a specific version of Appkit. Appkit releases occur independently of App Studio releases.

You can upgrade web apps to use the latest version of Appkit.

To upgrade
  1. Stop the app.

  2. In the package.json file at the root of your project, update the appkit-ui dependency to the latest Appkit version, for example:

    "appkit-ui": "http://appkit.lucidworks.com/repo/4.2.0/appkit-ui.tar.gz",
  3. In the pom.xml file at the root of your project, update the value of the parent.version property to the latest Appkit version, for example:

        <parent>
            <groupId>twigkit</groupId>
            <artifactId>twigkit.app.js</artifactId>
            <version>4.2.0</version>
        </parent>
  4. Upgrade the Appkit Social module, if required (see below).

  5. Perform any additional upgrade steps that are required for a specific Appkit upgrade. See the Appkit Release Notes for more information.

  6. Start the app.

Upgrade the Appkit Social module

Note
These steps are only required if you are currently using the Appkit Social module – this is indicated by the presence of a <dependency> block in the pom.xml file at the root of your project that has an <artifactId> entry that starts with twigkit.social. If you are not using the Appkit Social module (i.e. there is no twigkit.social entry in your pom.xml), then you don’t need to follow the steps in this section.
To upgrade the Appkit Social module
  1. Remove the existing twigkit.social <dependency> block from your pom.xml file and replace it with the following:

    <dependency>
    	<groupId>twigkit</groupId>
    	<artifactId>twigkit.social.provider.platform</artifactId>
    	<version>${project.parent.version}</version>
    </dependency>
  2. Create a configuration file named src/main/resources/conf/social/social.conf with the following contents:

    # Use conf/platforms/fusion/social.conf for Social module platform configuration
    platform: platforms.fusion.social

    The platform value indicates the name of the platform configuration file to use, which you will create in the next step.

  3. Create a configuration file named src/main/resources/conf/platforms/fusion/social.conf that contains the following (note that the name of the file matches the platform value configured in the previous step):

    # For every Fusion App, a corresponding YOUR_FUSION_APP_user_prefs collection is automatically created.
    # Appkit uses this collection for storing collaboration user-data.
    
    # Name of the collection to store user data in
    collection: YOUR_FUSION_APP_user_prefs
    
    # Name of the Query & Index pipelines to use - _system is the Fusion default
    # pipeline: _system
    
    # Enable writing new Social entities into the platform
    readOnly: false
    
    # Prevent users from searching this platform directly
    webservice-enabled: false

    Replace the string YOUR_FUSION_APP in the collection parameter with the name of the Fusion app you want to associate your social data with.