FME Flow: 2024.1

Workspaces

Use this page to upload and manage the following in FME Flow:

  • Workspaces
  • Workspace templates
  • Custom transformers
  • Custom formats

In FME Flow, these items are uploaded and organized into Repositories.

Uploading to FME Flow

Note  Uploading data files, Database Connections , Web Connections, or packages associated with workspaces is not supported from FME Flow.

To upload workspaces to FME Flow with support for any of these features, use the Publish to FME Flow wizard from FME Workbench. Alternatively, upload them separately using the tools in Files & Connections.

Note  When an existing workspace is re-uploaded, or republished from FME Flow, workspace metrics do not reset automatically. If desired, reset them manually. For more information, see Working with Workspace Metrics and Metadata, below.
  1. Do one of the following:
  2. To upload a single workspace:

    • From the Workspaces page: Click Upload.
    • From any page: Drag and drop a workspace file directly onto the page.

    To create a repository from a folder of workspaces, and upload its contents:

    • From any page, drag and drop a folder of workspaces directly onto the page.
    • On the Uploading Folder dialog, provide a Repository Name, and click Upload.

    To upload multiple workspaces from a folder, and place them into an existing repository:

    1. From the Workspaces page, open the repository you want to hold the new workspaces.
    2. Drag and drop a folder of workspaces directly onto the page.
    3. The Uploading Folder dialog opens and asks if you want to create a new repository for these workspaces. To proceed as intended, leave this box unchecked, and click Upload.
  3. Choose Repository: This dialog opens if you initiate an upload of a single workspace before opening a repository. Select the repository to hold the workspace and, if desired, edit the workspace name. Click Upload.
  4. Commit Workspace: If Version Control is enabled, you are asked to commit the file(s) to version control. To commit, enable the slider and write a commit message. If version control is disabled, this dialog informs you. (Following the current upload, you can always enable version control, initiate a new upload, and commit it to version control.) To proceed, click Confirm (For more information, see Working with Version Control, below.)
  5. Configure Services: Specify which FME Flow Web Services the workspace runs. Expand a service to configure its properties when running the workspace, as follows:
  6. Note  This dialog does not appear if you create a repository from a folder of workspaces, or upload multiple workspaces from a folder. To configure services for each workspace after upload, see Working with Workspace Metrics and Metadata (below).
  7. Click Confirm.

Working with Version Control

If Version Control is enabled, you can perform the following tasks on the Workspaces page:

Accessing Versions

To access the history of additions and changes to a repository, click History. On the History dialog, you can:

  • View information about a revision, including the file name, the user who committed the addition or modification, and the date of the commit.
  • Copy the SHA hash corresponding to a Git repository commit.
  • Download a file version.
Tip  If you have configured version control with a remote Git repository, fetch the latest updates before browsing history (Version Control Manage permission required).

When viewing history, keep in mind the following:

  • Downloading a file version does not replace your working copy of that file on FME Flow. To update your working copy with a downloaded file, republish it to FME Flow.
  • The History dialog shows the history of deleted items in a repository, but it is not possible to view the history of repositories that have been deleted.
  • To limit history to a single repository, check the box beside the repository you want to view. To limit history to a single file of a repository, open a repository and check the box beside the file you want to browse.

Saving a File Version

You can save individual file versions directly from the Workspaces page.

  1. Open a repository, and check the box beside the workspace to select it.
  2. Click Commit.
  3. In the Commit Item dialog, enter a Commit Comment, if desired, and click Commit.

To access the version of the workspace you committed, see Accessing Versions, above.

Working with Workspace Metrics and Metadata

You can view useful information about workspace performance, which can help you make important decisions about how to run workspaces, particularly when configuring Queue Control. To view workspace statistics, click on a repository name to open it.

The Workspaces page for a repository displays the following columns:

Resetting Statistics

You may decide that, over time, statistics are outdated and do not reflect current conditions on your system. You can reset statistics so that they are calculated anew. Select one or more workspaces to reset, click Actions, and select Reset Statistics.

Note  Statistics must be reset manually. When an existing workspace is re-uploaded, or republished from FME Flow, workspace metrics do not reset automatically.
Warning  After statistics are reset, ensure workspaces are run enough times before applying a metric-based job routing rule to an applicable queue. For a metric-based job routing rule to take effect, the workspace must have run enough times since statistics are initially collected or reset to generate a statistically significant sample. The required minimum number of jobs to run for a significant sample may vary between 30 to 100, depending on variability of data and the degree of precision required by the rule (for example, minutes versus seconds). The more variable the input data, and the higher degree of precision that is required of this data, the larger the sample size that is required. If a job routing rule does not reference a statistically significant sample of jobs run, the next applicable rule takes effect, by priority, or the job routes to the Default queue.

Other Tasks

To create a repository

Click New. On the Create a New Repository page, provide a name and description for the new repository, and click OK.

To edit a repository description

Select a repository and click Edit. On the Editing Repository page, make your desired changes, and click Save Changes.

To share a repository

Click the Share with Others icon. Through sharing, you can grant levels of permissions on an item to other users. You can share an item if you own it, or if you are a user with Manage permission in Security, such as an administrator. For more information about sharing and ownership, see Role-Based and User-Based Access Control.

To change the job queue of a repository

If not explicitly assigned, repositories are assigned to the Default job queue. Under the Queue column, you can assign the repository to a different queue.

Note  You must have Manage permission in Engines & Licensing to change the job queue of a repository.

To remove a repository

Select one or more repositories and click Remove.