Fusion Apps

Fusion apps provide tailored search functionality to specific groups of users.

An app is a named set of linked objects, including collections, datasources, index and query pipelines, index and query profiles, parsers, and more. You can define security on a per-app basis using roles and security realms.

The Create App modal can be accessed by clicking Create App. When naming an app, the name must start with a letter and can include letters, numbers, dashes (-), or underscores (_), with a maximum length of 128 characters.

To edit an app, access the Edit App modal by clicking on the settings cog icon on the app tile. Click on the pencil icon by the app name in the modal to edit the app name.

Generally, you will create multiple apps for different purposes. You can view all of your apps in the launcher when you log in to the Fusion UI:

To enter the Fusion workspace for any app, click the app name.

In the Fusion workspace, you can hover over to switch to another app, create a new app, or return to the launcher:

Fusion Applications and Collections

The course for Fusion Applications and Collections focuses on the features of Fusion apps and collections and best practices when working with them.

Take this course on the LucidAcademy.

Learn more

Create and manage Fusion apps

You can create, modify, and delete apps in the Fusion UI or with the Apps API.

Manage apps in the Fusion UI

Create an app

Fusion prompts you to create an app the first time you log in. You can create additional apps at anytime from Fusion’s home page.

1. Log into Fusion and navigate to the home screen.

2. Click Create new app.

   

3. Enter a Name, Description, and select an App tile color.

   

4. Click Create App.

Modify or delete an app

1. Log into Fusion and navigate to the home screen.

2. Click the Configure icon on the app you want to modify or delete.

   

3. To modify the app, click the edit icon .

   
   1. Edit the Name or Description.
   2. Click OK.

4. To delete the app, click Delete app.

   1. A dialog box appears where you can choose which associated objects to delete or retain. Only objects not associated with other objects are displayed. All objects are selected by default.

   2. Click Confirm.

      

Manage apps with the Apps API

Create an app

curl -u USERNAME:PASSWORD -X POST -H 'Content-type: application/json' -d '{"id": "MyNewApp", "name":"My new app", "description":"A really really great new app"}' https://FUSION_HOST/api/apps

Delete an app

Run the following command, replacing {id} with the name of your app. This operation take about a minute to complete.

curl -u USERNAME:PASSWORD -X DELETE https://FUSION_HOST/api/apps/{id}

Export a Fusion App

To export a Fusion app, you can use either the Fusion UI or the Objects API.

To upgrade from one Fusion version to a 5.x version, see Fusion 5 Upgrades to migrate objects.

Export an app with the Fusion UI

1. Navigate to the launcher.
2. Hover over the app you want to export and click the Configure icon:
3. In the app config window, click Export app to zip:

To import the downloaded zip file into other instances of Fusion 5.x, see Import a Fusion App.

Export an app with the Objects API

The examples below show how to export one or more apps:

Export all apps

curl -u USERNAME:PASSWORD http://localhost:6764/api/objects/export?type=app > all-apps.zip

Get all app IDs, then export one app by ID

> curl -u USERNAME:PASSWORD http://localhost:6764/api/apps

[ {
  "id" : "movies",
  "name" : "Movies",
  "description" : "Search the movielens database.",
  "dataUri" : "/App-Tile-01-460x160.png",
  "properties" : {
    "headerImageName" : "headerImage1",
    "tileColor" : "apps-darkblue",
    "previousCollectionId" : "movies"
  }
}, {
  "id" : "tech-pubs",
  "name" : "TechPubs",
  "description" : "Search the documentation.",
  "dataUri" : "/App-Tile-02-460x160.png",
  "properties" : {
    "headerImageName" : "headerImage2",
    "tileColor" : "apps-darkblue",
    "previousCollectionId" : "tech-pubs"
  }
} ]

> curl -u USERNAME:PASSWORD http://localhost:6764/api/objects/export?app.ids=tech-pubs > techpubs.zip

When you export an app that includes objects that are shared with other apps, then all apps linked to that object are also exported.

Export two apps by ID

curl -u USERNAME:PASSWORD http://localhost:6764/api/objects/export?app.ids=tech-pubs,movies > two-apps.zip

For the app object type, the deep parameter is not used. Linked objects are always included when exporting apps.

Import a Fusion App

To import an app, you can use either the Fusion UI or the Objects API.

Import an app with the Fusion UI

1. Navigate to the launcher.

2. Click Import app.

   

3. Under Data File, click Choose File and select the zip file containing the app you want to import.

4. If your app has usernames and passwords in a separate file, select it under Variables File. If the Variables File is needed, it must be a separate file that is not in a .zip file. It is a .json map of variables to values. The following is an example:

   {
   "secret.dataSources.Inventory_BR_S3_DS.password":"SOMETHING",
   "secret.dataSources.LLM_A_BR_S3_DS.password":"FmJSaDE9Tj5REDACTED",
   "secret.dataSources.LLM_BR_Inventory_S3_DS.password":"FmJSaDE9Tj5GzIVvethAC4Huh",
   "secret.dataSources.LLM_BR_Load_S3_DS.password":"FmJSaDE9Tj5GzIVvethAC4"
   }
   

5. You can sometimes edit parameter values to use the new values in the imported app. If this is the case, Fusion displays a dialog box that lets you edit the parameter values.

   

   Make desired changes, and then click Import.

Import an app with the Objects API

Like any other Fusion object, an exported app is contained in a zip file which Fusion can consume upon import. The zip file does not need to be expanded first.

Import objects from a file and stop if there are conflicts

curl -u USERNAME:PASSWORD -H "Content-Type:multipart/form-data" -X POST -F 'importData=@/Users/admin/Fusion/export.zip' http://localhost:6764/api/objects/import?importPolicy=abort

Import objects, substitute the password variables, and merge any conflicts

curl -u USERNAME:PASSWORD -H "Content-Type:multipart/form-data" -X POST -F 'importData=@/Users/admin/Fusion/export.zip' -F 'variableValues=@password_file.json' http://localhost:6764/api/objects/import?importPolicy=merge

password_file.json must contain plaintext passwords.

Import a zip file of Fusion objects and merge any conflicts

curl -u USERNAME:PASSWORD -H "Content-Type:multipart/form-data" -X POST -F 'importData=@/Users/admin/Fusion/techpubs.zip' http://localhost:6764/api/objects/import?importPolicy=merge

Import objects into an app

You can import exported Fusion objects into the currently open app.

1. In the Fusion launcher, click the app into which you want to import objects. The Fusion workspace appears.
2. Click System > Import Fusion Objects. The Import Fusion Objects window opens.
3. Select the data file from your local filesystem. If you are importing usernames and passwords in a separate file, select it under Variables File.
4. Click Import. If there are conflicts, Fusion prompts you to specify an import policy:
   • Click Overwrite to overwrite the objects on the target system with the ones in the import file.
   • Click Merge to skip all conflicting objects and import only the non-conflicting objects.
   • Click Start Over to abort the import. Fusion confirms that the import was successful:
5. Click Close to close the Import Fusion Objects window.

Add an object to an app

You can add objects present in other apps (or in no apps) to the open app. Some objects are linked to other apps. You can also add those directly to an app.

• Add an object to an app – While in the Fusion workspace for the app to which you want to add an object, open Object Explorer and click In Any App. Search for or browse to the object you want to add. Hover over the object, click the App icon, and then click Add to this app.

  

• Add an object to an app directly – In cases when an object is linked to an app, but is not linked directly to the app (it is linked via some dependency), you can add the object to an app directly.

  While in the Fusion workspace for the app to which you want to add an object directly, open Object Explorer and click In Any App. Search for or browse to the object you want to add. Hover over the object, click the App icon, and then click Add to this app directly.