FME Flow: 2026.1

AR Apps

Select Flow Apps > AR Apps tab.

AR apps allow FME Flow clients to run augmented reality workspaces from a web browser. Augmented reality workspaces write data to the FME Augmented Reality (FME AR) Writer. To run AR app workspaces, FME Flow uses the Data Streaming Service. AR apps are shared as URLs, and may be presented through customizable web pages.

The AR Apps tab of the Flow Apps page lists the AR apps that have been created, including sample apps already provided.

By default, all apps are disabled when created. Disabled apps do not run. To enable or disable an app, select an app, and select Actions > Enable or Disable.

From the Actions menu, you can also Remove an app or Change Expiration of an app.

To view and run an app, or copy an app's URL, click the View or URL icon of the corresponding app, respectively.

To edit an AR app, click on it.

To Create an AR App

  1. Click Create under the AR Apps tab. Alternatively, to duplicate an existing AR app and revise, select an app, and select Actions > Duplicate. The Create AR (or Duplicating) App dialog opens. Complete or update the following:
    • Name: Provide a name for the app. The name appears on the run page for the app. App names are case-insensitive.
    • Title (optional): Provide a title for the app. The title appears in place of Name on the run page for the app.
    • Description (optional): Provide a description for the app. The description appears on the run page for the app. Use the toolbar widgets to customize the appearance of the description, as desired.
    • Repository: The repository of the workspace you want the app to run. Only repositories with workspaces that contain FME AR writers are listed.
    • Workspace: The workspace you want the app to run. Only workspaces that contain at least one FME AR writer are listed. If the specified workspace is not already registered to run the Data Streaming Service, a message informs you that when the AR app is created, the workspace will be registered to the data streaming service. If the specified workspace contains multiple AR writers, click Choose FME AR Writer to specify the writer to which you want to stream data for the app.
    • App Security: Specifies who has access to the app.
      • Public: Full access to the app is provided to anyone with the app URL.
      • Private: Full access to the app is provided to the Roles and/or Users specified under Allowed Roles and Allowed Users. Users must first log in to FME Flow with their username and password before access is granted. Access is denied to all others.
    • User Can Upload: If the workspace uses the Data Upload Service, this setting allows users to upload temporary files that are used to run the workspace.
  2. Device Geolocation
    • Auto Populate Geolocation Parameter: If enabled, Geolocation Parameter (below) is auto-populated with the current location of the device when the app launches. If disabled, the app does not use Geolocation Parameter.
    • Geolocation Parameter: If Auto Populate Geolocation Parameter (above) is enabled, select the parameter that will be used for the device's geolocation. The parameters available for selection are obtained from user parameters of type Geometry or Text under Parameters (below).
      • Note  When selected, the parameter is no longer available for configuration under Parameters (below).
    • Hide Parameter in App: This parameter controls whether Geolocation Parameter can be set by the user of the app. If enabled (default), Geolocation Parameter is hidden and cannot be changed by the end user.
  3. Parameter Defaults: If the workspace has user parameters, configure the default values for each one when the app runs.

    4. To revert to the original default values of the workspace, click Reset Values.

    Note  
    If the workspace is republished to FME Flow with new default values for user parameters, the values specified for this app are not affected, unless you click Reset.
    A user parameter of type Geometry or Text that is specified for Geolocation Parameter (above) is not available for configuration.
    • Show in App: If checked, the app allows the user to explicitly specify a value for the parameter, or accept the default value. If unchecked, the app page does not display the parameter, and the app runs according to its default value.
  4. Dynamic Parameter Configuration
    • Enable Dynamic Parameters: If enabled, allows you to use a JSON schema to change default values or available choices of user parameters dynamically at runtime. For information about working with the schema, click View Guide.

      • The Dynamic Parameters guide provides assistance in three tabs:

      • Schema Guide: Explains the dynamic parameters JSON schema, with an example.
      • Generate Configuration: If Enable Configuration Loading at Launchis enabled, this tab allows you to generate a dynamic parameters JSON configuration for any of the current set of user parameters.
        • Parameters: Select the user parameters you want to configure dynamically in the JSON schema.
        • Schema Sample: The JSON schema populates the user parameters selected in Select parameters to configure (above) with the values specified under Parameter Defaults. You can manually update these default values and make any other adjustments to the schema as desired. When finished, test and download the schema as follows:
          1. Click Test. The dialog displays the parameter configurations that are found. To see these parameters as they would appear in the app, click Preview. To close the view, click Close.
          2. To download the configuration as a JSON file, click Download JSON.
      • Generate URL Config: If Enabled URL-Based Configuration (below) is enabled, this tab allows you to generate a static URL from a JSON parameter configuration.
        • Parameter Configuration Schema: Paste a user parameter configuration in the form of a valid JSON schema. For assistance generating the schema, use the Generate Configuration tab (described above). When finished, click Generate Url. The URL appears below. Click on the URL to open it in your browser. To copy, click Copy Url.
    • Enable URL-Based Configuration: If enabled, a URL pushes URL-encoded JSON parameter configurations to launch the app. The URL must supply the configurations through a query string parameter named dynamicParameterData. For assistance generating the URL, click View Guide (see "Working with View Guide," above).
      • Allowed Parameters: To ensure security of the URL, specify the user parameters the URL is allowed to push.
    • Enable Configuration Loading at Launch: If enabled, the app pulls JSON parameter configurations when it launches. Configurations are pulled from the specified Data Source: 
      • Resource: Parameter configurations derive from a JSON schema in Resources.
      • Workspace: Parameter configurations derive from a workspace that returns the required JSON schema.
        • Repository: The repository containing the Workspace.
        • Workspace: The workspace from which parameter configurations derive.
      • URL: Parameter configurations derive from the specified URL, such as an external web service or Data Virtualization endpoint.
      Tip  To display the parameter configurations from the specified Data Source, click Test. To see the parameters as they would appear in the app, click Preview.
  5. Resource Permissions: If the designated Workspace requires access to Resources in addition to those specified under Parameter Defaults, click Add Resources to specify the Resources folder that app users have permission to access. In the Select file for dialog, click the plus (+) icon beside each Resources folder to add. When finished, click Confirm.
    6. Warning  Access is granted to an entire Resources folder. For maximum security, create your own Resource Connection and, in that folder, place only those files to which you want to grant access.
  6. Connection Permissions: If the designated Workspace requires access to additional Database Connections or Web Connections, click Add Connections to specify the connections that app users have permission to access. In the Add Connections dialog, click the plus (+) icon beside each connection to add. When finished, click Add Connections.
  7. Customize (optional): You can customize various elements of the run page for the app. Alternatively, to specify that the app should run as soon as its URL is invoked, without displaying a run page, enable Run Immediately (at bottom).
    8. Note  Icon, Logo, and Banner fields support only .jpg and .png files.
    • Browser Icon: A clickable icon to reference the app URL.
    • Heading Background Color: A background color to comprise the banner at the top of the app page. Appears behind Heading Banner, if transparent.
    • Heading Logo: Appears over Heading Banner and/or Heading Background Color, centered.
    • Heading Banner: An image to comprise the banner at the top of the app page. If transparent, appears over Heading Background Color.
    • Footer Text: Appears beneath the Links on the app page. Use the toolbar to customize as desired.
    • Footer Logo: Appears beneath Footer Text, and behind Footer Banner, if transparent.
    • Footer Banner: An image to comprise the banner at the bottom of the app page. If transparent, appears over Footer Logo.
  8. Click Create. A message appears to indicate the app is created, along with the app URL. Click Copy to copy the URL. To run the app, click the URL.

    9. Note  Other permissions may still be required, and you may need to further test and adjust the given permissions. For more information about permissions in FME Flow, see Role-Based and User-Based Access Control.

  9. Click Close. The Flow Apps page re-opens and lists your new app on the AR Apps tab.
    Note  By default, AR apps are disabled when created, which prevents them from running. To enable, select the app, and select Actions > Enable.