Getting Started with FME Server Workspace Apps

Liz Sanderson
Liz Sanderson
  • Updated

FME Version

  • FME 2022.0

Introduction

FME Server has the ability to create web-based ‘Apps’ - which is a method to allow users to run a workspace without needing login access to FME Server. When you choose to create an App, FME Server will generate an app page with a valid token with the necessary permissions.

 

Creating an App 

You can create an app from the Run Workspace page, under Workspace Actions or the Advanced tab.
Alternatively, select ‘Server Apps’ from the navigation panel. This section also allows you to view and manage any existing apps.

ServerAppMenu.png

From the Server Apps page, click ‘Build Workspace App’ from the drop-down menu.

BuildWorkspaceApp.png

This will bring you to the page ‘Create Workspace App’.


Required Parameters

There are a few parameters you will need to set to create your app:

Name: This name will become part of the URL for the app and will also be used within FME Server for managing your apps.
Repository: This is the location of the workspace that you would like to build your app around. 
Workspace: This is the workspace that the app will be running. If it contains any published parameters, these will become available to manage in an additional dialog box.
Service: Choose from the Job Submitter, Data Download or Data Streaming service (dependent on what the workspace was registered with when published)

CreateAPp.png

 

 

Workspace Parameters

If your workspace includes published parameters, an additional dialog box will be available for you to configure. You can control whether the parameters are available for the end-user to set in the app, and what the default values will be.

WorkspaceParams.png

Optional Parameters

Title: The title will be displayed at the top of the app and in the browser tab.
Description: Provide a description to give users more information or instructions/expectations for use. The toolbar can be used to customize the text following markdown guidelines.
Expiration: Behind the scenes, FME Server creates a token that is used to authenticate the app. The token automatically has the necessary permissions required for the user to run the application. By default, token expiration is set to 10 years. 
Requires Authentication (FME Server 2020.0+): Configure the app to require users to provide authentication before running the application. Additionally, you can specify which users are allowed access. By default, this parameter is disabled. In FME Server 2022 you can monitor the runtime user.
RequireAuth.png

When a user goes to the FME Server App URL with required authentication enabled, they will be presented with the following login screen:

AppLogin.png

Customize Parameters

Browser Icon: An image to be displayed in the web browser tab. There is a 50kb file size limit for icon images.
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: An image that appears over Heading Banner and/or Heading Background Color, centered. There is a 250kb file size limit for the heading image.
Heading Banner (FME Server 2020.0+): An image to comprise the banner at the top of the app page. If transparent, appears over Heading Background Color.
Footer Text (FME Server 2020.1+): Text to be shown at the bottom of the page, underneath any workspace parameters. The toolbar can be used to customize the text following markdown guidelines.
Footer Logo (FME Server 2020.1+): An image that is shown beneath the workspace parameters. Appears beneath Footer Text, and behind Footer Banner, if transparent.
Footer Banner (FME Server 2020.1+): An image to comprise the banner at the bottom of the app page. If transparent, appears over Footer Logo.
Run Immediately (FME Server 2020.0+): If enabled the app will run as soon as its URL is invoked, without displaying a customized app page. By default, this parameter is disabled. 

CustomizeParams.png

When you have finished configuring your app, press OK. A page will be returned listing the details of your app, this includes the app URL and token details including the expiration date and permissions granted. 

AppToken.png

 

Viewing an App

If you navigate away from this page, you can view or copy the URL from the main Server Apps > Manage Workspace Apps page.

ViewApp.png

 

Changing an App’s Expiration

If you need to change the expiration date of an app, select it, and choose ‘Change Expiration’ from the Actions dropdown menu.

ChangeExpiration.png

Alternatively, as the expiration is managed by the token that is created to authorize usage of the app, you can configure expiration using the Token Management page.
To access this, click on Manage Tokens from the User Settings dropdown (top right of the FME Server Web Interface).

ManageToken.png

 

 On this page, you should see the token created for your app. Clicking on the token will open the edit page.

ListToken.png

 

Here you can modify the token description, enable or disable the token (disabling will mean your app no longer works), change the expiration date and the permissions that have been given to the token.

EditToken.png

 

Monitoring the Runtime User

In FME Server 2022 an additional field ‘Ran by’ has been exposed on the Jobs Completed/Queued/Running pages to record the user who has logged in to run an app:
RanBy.png

There are two new FME Server Parameters available so that this information can also be fetched in FME Workbench:
FME_SERVER_RUNTIME_USER: Name of the user who authenticated the FME Server workspace app to run the workspace.
FME_SERVER_RUNTIME_ID: The UUID of the user who authenticated the FME Server workspace app to run the workspace.

DesktopParams.png

Learn more about how to integrate FME Server runtime parameters into your workspace app in Working with FME Server Runtime Parameters.


Geometry Parameter

FME Server (2020+) allows users to draw an area directly onto a map by using the Geometry Published Parameter, which can be parsed into a workspace using the GeometryReplacer transformer. More on how to set up the Geometry Picker can be found in Using the Geometry Picker in FME Server.

GeometryPicker.png

 

 Additional Resources

[Article] Working with FME Server Runtime Parameters
[Article] Using the Geometry Picker in FME Server
[Documentation] Workspace Apps
[Webinar] Creating No Code Web Apps with FME Server
[Demo] Interactive Demos

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.