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 Server.

    1. Repository: The repository that holds the workspace you want to run.
    2. Workspace: The workspace you want to run.
    3. Service: An FME Server service that the workspace is registered to run.

      4. Note: To edit the FME Server 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 Server email subscribers must be properly configured: DataDownload_Email_JobFailure, DataDownload_Email_JobSucess, JobSubmitter_Email_JobFailure, JobSubmitter_Email_JobSuccess. For more information, see Monitoring FME Server Events from Topics.

    5. Published Parameters: Provide any published parameters or other settings specific to the FME Server service.

      6. If any published parameters represent data files, this page allows you to upload files to FME Server, 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.

      Note: Any "Feature Types to Read" published parameters that contain spaces must be enclosed in double quotes. For example, "Bus Routes".

      Note: Resources connections to Amazon Web Services (AWS) S3 buckets cannot be accessed.

    6. Advanced:
      • Job Queue (optional): The job queue in which to run the job. The specified queue overrides the queue of the repository to which the workspace belongs. If not specified, the job is placed in the job queue of the repository.
      • 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.
      • Run Until Cancelled (optional): If checked, the job runs continuously, even after a server shutdown or crash, until it is explicitly canceled.

      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 Server 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 Server App or Workspace Actions > Create Server App, and complete the settings on the Server 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. Additional Permissions: FME Server generates a security token that does not require logging in, and is configured with the minimal set of permissions to run the workspace. These permissions include Read and Run in the applicable repository, and Full Access in the Services to which the workspace is registered. However, if this setting appears, other permissions may still be required. You may need to further test and adjust the given permissions.

          5. 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 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.)
          • 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.

          • Access: Access the Schedules page.
          • Create: Create schedules.

            • Individual Schedules:

            • Full Access: Edit or delete a schedule.
          • 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.

          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.
          • 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.
          • 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 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.
          • 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 Database Connections and Web Connections pages.
          • Create: Create connections.
          • Manage: Access, create, and remove connections.

            • Individual Connections:

            • Access: Manage web services.
          • 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.

          • Manage: Configure the FME Server services.

            • Individual Services:

            • Full Access: Manage FME Server services.
          • Upload: Allow publishing FME packages from FME Desktop to FME  Server.

        5. Parameters: Configure any published parameters with the values you want the workspace to run when the webhook is invoked.
        6. 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 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.

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

          7. 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 Server 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 Server 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.