• All Files

Run Workspace

You can perform the following from the Run Workspace page:

  • Run a workspace directly from this page.
  • 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.

To Run a Workspace

  1. Specify:
    • The repository to which the workspace belongs.
    • The workspace you want to run.
    • An FME Server service that the workspace is registered to run.
    • Optionally, an e-mail address to deliver results. This option allows you to receive e-mail notification when the translation is complete, rather than wait for a completion message on this page.

      • Note: To receive e-mail, 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.

  2. Under Published parameters, provide any published parameters or other settings specific to the FME Server service.

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

  3. (Optional) Expand Advanced. This section shows:

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

    Workspace Sharing: You can generate a token, along with URLs that use the token, which allow unauthenticated access to run the workspace in the following ways:

    • As an "app" that is run from a browser, and allows users to configure any published parameters.
    • Through a webhook that can be integrated with third-party software to programmatically run the workspace according to the published parameters configured on the Run Workspace page.

    Once created, you can access the token on the API Tokens tab of the Token Management page.

    ClosedExpand for instructions.
    1. Click Share this workspace.The Share <repository/workspace> page opens.
    2. If required, edit the 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 token that does not require logging in, and is configured with the minimal set of permissions to run the workspace. However, if this setting appears, other permissions may still be required. You may need to further test and adjust the given permissions.

      5. ClosedAbout permissions in FME Server

      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.

      ClosedRun Workspace
      ClosedJobs
      • 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 Engines & Licensing.)
      ClosedAutomations
      • Create: Create workflows.

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

        Individual Automations:

        • Write: View, edit and remove a workflow.
      ClosedSchedules
      • Access: Access the Schedules page.
      • Create: Create schedules.

        • Individual Schedules:

        • Allow: Edit or delete a schedule.
      ClosedRepositories
      • Access: Access the Repositories 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.

      ClosedWorkspace Viewer
      ClosedPublications
      • 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.
      ClosedSubscriptions
      • 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.
      ClosedTopics
      • 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.
      ClosedResources
      • 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.
      ClosedConnections
      • Access: Access the Database Connections and Web Connections pages.
      • Create: Create connections.
      • Manage: Access, create, and remove connections.

        • Individual Connections:

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

      ClosedDashboards
      ClosedEngines & Licensing
      ClosedSecurity
      ClosedSystem Cleanup
      ClosedServices
      • Manage: Configure the FME Server services.
      ClosedSystem Events

    5. Click OK. Two URLs appear under Workspace Sharing:
      • FME Server App: Enables users to run the workspace from a browser and configure any published parameters.
      • Web Service URL: A webhook that enables integrating the workspace with third-party software to programmatically run the workspace. The webhook runs according to the published parameters configured on the Run Workspace page.

        • To update the published parameters on the Run Workspace page, click Change Parameters, update as required, and click Share this workspace to generate a new webhook.

      Click the Copy icons to copy either or both URLs.

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

      Note: You can access the token that was created for these URLs on the API Tokens tab of the Token Management page.

    Published Parameters: Details of any published parameters.

  4. Click Run. You may see an intermediate page indicating that processing has begun.

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

To Unregister a Service from a Workspace

To unregister a service from a workspace, use FME Workbench to "republish" the workspace to FME Server. On the "Register Workspace Services" page of the "Publish to FME Server Wizard," unselect the service you want to unregister. For more information, see the FME Workbench help.

To Unregister a Workspace from a Repository

To unregister a workspace from a repository, use FME Workbench to "republish" the workspace to FME Server. On the "Register Workspace Services" page of the "Publish to FME Server Wizard," unselect all the FME Server Web Services. Although the workspace is still considered "published," it is no longer visible in FME Server. For more information, see the FME Desktop Help.