Workspace Apps

Select Server Apps > Manage Workspace Apps.

Workspace apps allow FME Server clients to run workspaces from a web browser. The "apps" are shared as URLs, and may be presented through customizable web pages.

When you create a workspace app to run a workspace, FME Server generates a URL for the workspace, along with a security token. The token allows anyone with the URL to run the workspace and configure published parameters, without authenticating to FME Server.

Note: Once created, security tokens can be accessed on the API Tokens tab of the Token Management page.

Tip:
You can provide your clients with access to multiple workspace apps and other links from a single, customizable web page. For more information, see Gallery Apps.
Workspace apps provide some Progressive Web App (PWA) features, such as Add to Home Screen (A2HS). For more information, see this FME Community article.

The Workspace Apps tab of the Server Apps page lists the workspace apps that have been created.

By default, all apps are enabled to run when created. Disabled apps do not run, even if their tokens are not expired. To disable or enable an app, select an app, then select Actions > Disable or Enable.

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 a workspace app, click on it.

To Create a Workspace App

  1. Click New under the Workspace Apps tab, or select Server Apps > Build Workspace App. Alternatively, to duplicate an existing workspace app and revise, select an app, and select Actions > Duplicate. The Create Workspace Server (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.
    • 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.
    • Workspace: The workspace you want the app to run.
    • Service: An FME Server service that the workspace is registered to run.
    • Expiration: The expiration date and time of the security token of the app. After the token expires, the app will not run. The default expiration is 10 years from the current date.
    • Require Authentication: If enabled, access to the app is restricted to designated Users or Roles in FME Server. Designated users must first log in to FME Server with their username and password before access is granted. Access is denied to all others. To enable, click the slider. Click inside the Allowed Users box to add the users and roles you want to grant access.
    • 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. Additional Permissions: The security token that FME Server generates for the app is configured with the minimal set of permissions to run the specified workspace. However, if this setting appears, other permissions may still be required. You may need to further test and adjust the given permissions.

    3. Note: The following is a complete list of permissions in FME Server. Under Additional Permissions, only the minimal additional permissions that may be required to run the workspace display. After the token is generated, you can configure additional permissions for it on the Token Management page.

    • Access: Access the Automations page.
    • Create: Create workflows.

      • Individual Automations:

      • Read: View a workflow and its log file.
      • Write: Edit or remove a workflow.
      • Run: Start and stop a workflow.

      Note: Automations requires additional permissions. You are prompted to grant any additional permissions that are required.

    Manage: Access and manage Broadcast Messages.

    • Access: Access the Database Connections and Web Connections pages.
    • Create: Create connections.
    • Manage: Access, create, and remove connections.

      • Individual Connections:

      • Access: Manage web services.
    • Access: Access the Jobs page to view the jobs you have run, or cancel any of your jobs that are currently running or in queue.
    • Manage: Access and manage the jobs of all users. You can:
      • Cancel any job that is currently running.
      • Remove the history of jobs that were previously run.
      • Manage Job Queues. (Also requires Manage permission in Licensing & Engines.)
    • Upload: Allow publishing FME packages from FME Desktop to FME  Server.
    • Access: Access the Projects page.
    • Create: Create projects.

      • Individual Projects:

      • Read: View information about a project.
      • Write: Edit a project.
      • Delete: Delete a project, or delete items from a project.

      Note: Access or Create permission is not required to have Read/Write/Delete permission on individual projects. These tasks can still be accomplished with the REST API.

    • Access: Access the Publications page.
    • Create: Create Notification Service Publications.

      • Individual Publications:

      • Read: View information about a publication.
      • Write: Edit a publication.
      • Remove: Delete a publication.
    • Access: Access the Workspaces page.

      • Note: Access permission is not required to run a workspace. Only Run permission on the applicable repository is required (see below).

    • Create: Create repositories.

      • Individual Repositories:

      • Download: Download workspaces and other repository items from FME Server into Workbench.
      • Read: View repository information.
      • Publish: Publish workspaces and other items to the repository from Workbench.
      • Run: Run repository workspaces from FME Server.

        • Note: Users must also have Allow permission on the applicable service (see Services) when running workspaces.

      • Remove: Remove a repository, or remove items from a repository.

      Note: You must uncheck all five permissions to completely remove a role from membership with a repository.

    • Access: Access the Resources page.
    • Create: Create connections to network resources.

      • Individual Resource connections (top-level folders):

      • Access: Read and download a file.
      • List: List the folders and files of a resource.
      • Write: Write to files.
      • Upload: Upload files.
      • Remove: Delete files.
    • Access: Access the Schedules page.
    • Create: Create schedules.

      • Individual Schedules:

      • Full Access: Edit or delete a schedule.
    • Manage: Access to Security configurations.
    • Access: Access the Server Apps page.
    • Create: Create new FME Server apps.

      • Individual Server Apps:

      • Run: Run an FME Server app.
      • Read: Access an FME Server app.
      • Write: Edit or Remove an FME Server app.
    • Manage: Configure the FME Server services.

      • Individual Services:

      • Full Access: Manage FME Server services.
    • Access: Access the Subscriptions page.
    • Create: Create Notification Service Subscriptions.

      • Individual Subscriptions:

      • Read: View information about a subscription.
      • Write: Edit a subscription.
      • Remove: Delete a subscription.
    • Access: Access the Topics page.
    • Create: Create topics.

      • Individual Topics:

      • Read: View information about a topic.
      • Write: Edit a topic.
      • Publish: Publish notifications to a topic.
      • Remove: Delete a topic.

    Note: Version Control must be enabled to view these permissions.

    • Access: Commit versions and view repository history.
    • Manage: Enable version control and configure with a remote Git repository.

  3. Parameters: If the workspace has published 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.

    Note: If the workspace is republished to FME Server with new default values for published parameters, the values specified for this app are not affected, unless you click Reset.

    • 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. 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.
    • 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.
  5. Click OK. A message appears to indicate the app is created, along with the app URL. Click the Copy icon to copy the URL. To run the app, click the URL. When finished, click OK. The Server Apps page re-opens and lists your new app on the Workspace Apps tab.