App Studio 4.2.0 Release Notes - Lucidworks documentation

Release date: 28 February 2019 Appkit SDK version in this release: 4.2.0 See the Appkit 4.2.0 release notes for other changes. In apps created with this version of Fusion App Studio, you can Upgrade Appkit in Existing Apps. For a list of Appkit versions, see the Appkit Release Notes.

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.How to upgrade

Stop the app.
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",
```

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:

Copy

    <parent>
        <groupId>twigkit</groupId>
        <artifactId>twigkit.app.js</artifactId>
        <version>4.2.0</version>
    </parent>

Upgrade the Appkit Social module, if required.
Perform any additional upgrade steps that are required for a specific Appkit upgrade. See the Appkit Release Notes for more information.
Start the app.

New features

New features in this release of App Studio come in through the corresponding embedded release of the Appkit SDK.

Improvements

Fusion collection for social data. A new collection called _user_prefs is now created automatically with each new Fusion app for the purpose of storing social data such as user tags, bookmarks, and so on.

Manage Collections in the Fusion UI

Collections can be created or removed using the Fusion UI or the REST API.For information about using the REST API to manage collections, see Collections API in the REST API Reference:

Fusion 5.x. Collections API
Fusion 4.x. Collections API

Creating a Collection

When you create an app, by default Fusion Server creates a collection and associated objects.To create a new collection in the Fusion UI:

From within an app, click Collections > Collections Manager.
At the upper right of the panel, click New.
Enter a Collection name. This name cannot be changed later.
To create the collection in the default Solr cluster and with other default settings, click Save Collection.

Creating a Collection with Advanced Options

To access advanced options for creating a collection in the Fusion UI:

From within an app, click Collections > Collections Manager.
At the upper right of the panel, click New.
Enter a Collection name. This name cannot be changed later.
Click Advanced.
Configure advanced options. The options are described below.
Click Save Collection.

Solr Cluster

By default, a new collection is associated with the Solr instance that is associated with the default Solr cluster.If Fusion has multiple Solr clusters, choose from the list which cluster you want to associate your collection with. The cluster must exist first.

Solr Cluster Layout

The next section lets you define a Replication Factor and Number of Shards. Define these options only if you are creating a new collection in the Solr cluster. If you are linking Fusion to an existing Solr collection, you can skip these settings.

Solr Collection Import

Import a Solr collection to associate the new Fusion collection with an existing Solr collection. Enter a Solr Collection Name to associate the collection with an existing Solr collection. Then, enter a Solr Config Set to tell ZooKeeper to use the configurations from an existing collection in Solr when creating this collection.

Time Series Partitioning

Available in 4.x only.

You can map a Fusion collection to multiple Solr collections, known here as partitions, where each partition contains data from a specific time range.To configure time-based partitioning, under Time Series Partitioning click Enable.See Time-Based Partitioning for more information.

Configuring Collections

The Collections menu lets you configure your existing collection, including datasources, fields, jobs, stopwords, and synonyms.In the Fusion UI, from any app, the Collections icon displays on the left side of the screen.Some tasks related to managing a collection are available in other menus:

Configure a profile in Indexing > Indexing Profiles or Querying > Query Profiles.
View reports about your collection’s activity in Analytics > Dashboards.

Collections Manager

The Collections Manager page displays details about the collection, such as how many datasources are configured, how many documents are in the index, and how much disk space the index consumes.This page also lets you create a new collection, disable search logs or signals, enable recommendations, issue a commit command to Solr, or clear a collection.

Disable search logs

When you first create a collection, the search logs are created by default. The search logs populate the panels in Analytics > Dashboards.

Hover over your collection name until the gear icon appears at the end of the line.
Click the gear icon.
Click Disable Search Logs.
On the confirmation screen, click Disable Search Logs.

Note that if you disable search logs, you cannot see any data for this collection in Analytics > Dashboards.See Dashboards:

Fusion 5.x. Dashboards
Fusion 4.x. Dashboards

Disable signals

When you first create a collection, the signals and aggregated signals collections are created by default.

Hover over your collection name until the gear icon appears at the end of the line.
Click the gear icon.
Click Disable Signals.
On the confirmation screen, click Disable Signals.

Hard commit a collection

Hover over your collection name until the gear icon appears at the end of the line.
Click the gear icon.
Click Hard Commit Collection.
On the confirmation screen, click Hard Commit Collection.

Read internal details about how Solr processes commits on our blog.

Datasources

To access the Datasources page, click Indexing > Datasources. By default, there are no datasources configured right after installation.To add a new datasource, click New at the upper right of the panel.See the Connectors and Datasources Reference for details on how to configure a datasource. Options vary depending on the repository you would like to index.After you configure a datasource, it appears in a list on this screen. Click the name of a datasource to edit its properties. Click Start to start the datasource. Click Stop to stop the datasource before it completes. To the right, view information on the last completed job, including the date and time started and stopped, and the number of documents found as new, skipped, or failed.

When you stop a datasource, Fusion attempts to safely close connector threads, finishing processing documents through the pipeline and indexing documents to Solr. Some connectors take longer to complete these processes than others, so might stay in a “stopping” state for several minutes.

To stop a datasource immediately, choose Abort instead of Stop.There is also a REST API for datasources:

Fusion 5.x. Connector Datasources API
Fusion 4.x. Connector Datasources API

Stopwords

The Stopwords page lets you edit a stopwords list for your collection.To add or delete stop words:

Click the name of the text file you wish to edit.
Add a new word on a new line.
When you are done with your changes, click Save.

To import a stop words list:

Click System > Import Fusion Objects.
Choose the file to upload.
Click Import >>.

Synonyms

Fusion has the same synonym functionality that Solr supports. This includes a list of words that are synonyms (where the synonym list expands on the terms entered by the user), as well as a full mapping of words, where a word is substituted for what the user has entered (that is, the term the user has entered is replaced by a term in the synonym list).See more about synonyms:

Fusion 5.x. synonyms
Fusion 4.x. synonyms

You can edit the synonyms list for your collection.To access the Synonyms page in the Fusion UI, in any app, click Collections > Synonyms.Filter the list of synonym definitions by typing in the Filter… box.To import a synonyms list:

From the Synonyms page, click Import and Save. A dialog box opens.
Choose the file to import.

To edit a synonyms list:

Enter new synonym definitions one per line.
- To enter a string of terms that expand on the terms the user entered, enter the terms separated by commas, like Television, TV.
- To enter a term that should be mapped to another term, enter the terms separated by an equal sign then a right angle bracket, =>, like i-pod=>ipod.
Remove a line by clicking the x at the end of the line.
Once you are finished with edits, click Save.

To export the synonyms list, click Export. This downloads the list to your computer using your browser download capability.

Profiles

Profiles allow you to create an alias for an index or query pipeline. This allows you to send documents or queries to a consistent endpoint and change the underlying pipeline or collection as needed.Read about profiles in Index Profiles and Query Profiles:

Fusion 5.x.
- Index Profiles
- Query Profiles
Fusion 4.x.
- Index Profiles
- Query Profiles

To access the Solr Config page, from any app, click System > Solr Config.

Additional resources

LucidAcademyLucidworks offers free training to help you get started.The Quick Learning for Collections Menu Tour focuses on the Collections Menu features and functionality along with a brief description of each screen available in the menu:

Visit the LucidAcademy to see the full training catalog.

Single package file. A search app’s two package.json files have been combined in a single file.
Previous files (pre-4.2.0):
```
/package.json
/src/main/webapp/search/package.json
```
Current file (4.2.0):
```
/package.json
```

Fusion Server

Fusion AI

App Studio

​New features

​Improvements

New features

Improvements