FME Flow: 2024.2

Run Workspace

You can perform the following from the Run Workspace page:

  • Run or Share a Workspace

    • You can run a workspace directly from this page, or share a workspace as an "app" that is run from a browser, or as a webhook that is integrated with third-party software.

    Note  Workspace templates cannot be run from FME Flow.
    1. Repository: The repository that holds the workspace you want to run.
    2. Workspace: The workspace you want to run.
    3. Service: An FME Flow service that the workspace is registered to run.
      4. Note  To edit the FME Flow services for a workspace, select Workspace Actions > Edit Services. For more information, see Edit Workspace Services (below).
    4. Email results to (optional): An email address to deliver results. This option allows you to receive email notification when the translation is complete, rather than wait for a completion message on this page.
      5. Note  To receive email, the following FME Flow email subscribers must be properly configured: DataDownload_Email_JobFailure, DataDownload_Email_JobSucess, JobSubmitter_Email_JobFailure, JobSubmitter_Email_JobSuccess. For more information, see Monitoring FME Flow Events from Topics.
    5. Published Parameters: Provide any published parameters or other settings specific to the FME Flow service.

      6. When providing published parameters, keep in mind the following:

      • Any published parameters that are conditioned for visibility may not appear, depending on the value provided for the parameter specified in the If clause of the Conditional Visibility settings. For more information, see Controlling the Visibility of Published Parameters in the FME Workbench help.
      • If any published parameters represent data files, this page allows you to upload files to FME Flow, making use of the Data Upload Service behind the scenes. This service works in conjunction with the Data Download, Data Streaming, and Job Submitter services to upload files.
      • If any parameters were published to FME Flow as type Geometry, click the corresponding map icon to open an interface for specifying the desired geometry. For more information, see Using the Geometry Parameter in FME Flow.
      • Any "Feature Types to Read" published parameters that contain spaces must be enclosed in double quotes. For example, "Bus Routes".
      • Resources connections to Amazon Web Services (AWS) S3 buckets cannot be accessed.
      • For information about configuring published parameters in workspaces, see Working with User Parameters in the FME Workbench help.
    6. Advanced:
      • Job Queue (optional): The queue in which to run the job. The specified queue overrides the queue that would otherwise be assigned based on Queue Control job routing rules. If not specified, job routing rules apply. To view the queues to which FME Engines are assigned, open the Engines page.
      • Queued Job Expiry Time (optional): The length of time after which a job that is waiting in queue does not execute. If the job does not execute before this time is reached, it remains in the queue until it is ready to execute, but execution is not attempted. This directive is useful for time-sensitive jobs that you do not want to run after the specified time is exceeded.
      • Running Job Expiry Time (optional): The time a job will remain in the running state. This directive is used to ensure that a job does not hang and block an FME Engine indefinitely. The minimum allowable value is 1.
      • Log Debug: When enabled, records additional information to FME Job Logs. This setting is best used when an error has previously occurred and you seek further information.
        • Note  Log Debug may cause slower workspace performance and large log file sizes.

      Other Ways to Run this Workspace

      (Optional) You can generate a security token for the workspace, along with URLs that use the token. These URLs allow unauthenticated access to run the workspace in the following ways:

      • FME Flow App: A URL that runs the workspace as an "app" from a browser, and allows users to configure any published parameters.

        • To create an app URL, click Create an FME Flow App or Workspace Actions > Create Server App, and complete the settings on the Workspace Apps page.

      • Webhook URL: A URL that can be integrated with third-party software to run the workspace.
        1. Click Create a Webhook or Workspace Actions > Create Webhook. The Create Webhook page opens.
        2. If required, edit the Token Name, Description, and Expiration of the token.
        3. 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.
        4. Parameters: Configure any published parameters with the values you want the workspace to run when the webhook is invoked.
        5. Click OK. The webhook is created and URLs are provided for Authorization Header and Query String Authorization. Click the Copy icons to copy either or both URLs.
          Note  You can access the token that was created for these URLs, and view the permissions for it, on the API Tokens tab of the Token Management page.

          To download all of the information about this webhook, including token ID, URLs, and header values, click Download Webhook.

          Warning  This is your only opportunity to download complete webhook metadata. After navigating away from this page, it is no longer available.

          6. To update the published parameters, click Change Parameters, update as required, and click Create a Webhook to generate a new webhook.

          To return to the Run Workspace page, click Run Workspace on the breadcrumb at top.

      Topics to Notify

      Displays the Notification Service topics that are notified on success or failure of running the workspace, by registered service. For more information, see Monitoring FME Flow Events from Topics.

      Published Parameters

      Displays details of any published parameters.

    7. Click Run or Workspace Actions > Run Workspace. You may see an intermediate page indicating that processing has begun.

    The resulting web page indicates whether the job submission was successful.

  • Edit Workspace Services

    • You can configure the FME Flow Web Services that a workspace is registered to run. Select Workspace Actions > Edit Services.

    Send HTTP Message Body to Reader

    The reader feature type that receives HTTP content, in place of the actual dataset.

    Note   This field does not specify the flow of notification data.

    Include Writers in Download/Stream

    The writer for outputting data after the workspace runs. If the workspace includes multiple writers, you may want to change the writer selected by default to one that is better configured for downloading or streaming data.

    For example, consider a workspace with two writers. One writer inserts a single timestamp record into an Oracle table each time the workspace is run. The other writer supports downloading all of the data users want in AutoCAD. In this case, you will likely specify the AutoCAD writer as the desired output writer.

    Note  This field does not specify the flow of notification data.

    Network Link Name

    Specify a name for the KML Network Link.

    Visibility

    If 1, features are drawn in the Google Earth 3D viewer. Otherwise, specify 0.

    Network Link Description

    Provide a description for the KML Network Link.

    View Refresh Mode

    Specifies how the KML Network Link is refreshed when the Google Earth Camera view (that is, the viewer's location in space) changes.

    • never: Disregard changes in the camera view
    • onStop: Refresh the link n seconds after camera movement stops, where n is specified by View Refresh Time.
    • onRequest: Refresh the link only when explicitly requested in Google Earth.
    • onRegion: Refresh the link when the Region becomes active.

    View Refresh Time

    If View Refresh Mode is onStop, specifies the number of seconds to wait before refreshing the view.

    View Format

    The format of the query string that is appended to the Link's <href> tag before the file is fetched.

    Refresh Mode

    Specifies a time-based refresh mode.

    • onChange: Refresh when the KMZ file is loaded and whenever the Link parameters change.
    • onInterval: Refresh every n seconds, where n is specified by View Refresh Interval.
    • onExpire: Refresh when the expiration time is reached. If a fetched file has a NetworkLinkControl, the <expires> time takes precedence over expiration times specified in HTTP headers. If no <expires> time is specified, the HTTP max-age header is used, if present. If max-age is not present, the Expires HTTP header is used, if present.

    View Refresh Interval

    If Refresh Mode is onInterval, specifies the number of seconds to wait before refreshing the view.

    North, South

    Specifies the latitude of the north and south edge of the bounding box, in decimal degrees from 0 to ±90.

    East, West

    Specifies the longitude of the east and west edge of the bounding box, in decimal degrees from 0 to ±180. (For overlays that overlap the meridian of 180° longitude, values can extend beyond that range.)

    Minimum Level of Detail Pixels

    Defines a square in screen space, with sides of the specified value in pixels. For example, 128 defines a square of 128 x 128 pixels. The region's bounding box must be larger than this square, and smaller than Maximum Level of Detail Pixels, in order for the Region to be active.

    Maximum Level of Detail Pixels

    Measurement in screen pixels that represents the maximum limit of the visibility range for a given Region. A value of −1 indicates "active to infinite size."

  • Download or View a Workspace

    • Select Workspace Actions > Download Workspace or View Workspace.

See Also