FME Workspace Feature Representation

In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Type Attributes), this format also adds format-specific attributes (Format Attributes).

Attribute Name

Contents
fmw_type

The type of geometric entity stored within the feature:

  • fmw_none
Reader-Generated IDs: In order to associate the features produced by the reader with each other, the reader will generate several types of unique IDs. For example, most feature types and resultant features will contain a workspace_id, reader_id, writer_id, or transformer_id attribute.

Values for these attributes are generated per translation and may change if the order of input datasets, feature types, or transformers changes in a workspace.

These feature types contain information on the text and type for any annotations read from the workspace file.

Attribute Name Description

annotation

The HTML text of the annotation.

Range: text string

annotation_id

Unique identifier for the annotation per translation.

Range: 32-bit positive integer

annotation_type

The type of the annotation.

This attribute is deprecated and hard-coded to REGULAR for backwards compatibility.

Range: text string

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer
Attribute Name Description

bookmark_contents

If the Contents: Move With Bookmark option has been enabled in Bookmark Parameters, this will list the IDs of all elements inside the bookmark that will be moved with it.

Range: text string

bookmark_id

Unique identifier for the bookmark per translation.

Range: 32-bit positive integer

bookmark_description

Description of a bookmark, if applicable.

Range: text string

Default: Empty string

bookmark_name

Name of the bookmark (as shown in the title bar of the bookmark on the FME Workbench canvas).

Range: text string

Default: “New Bookmark”

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer
Attribute Name Description

breakpoint_condition

An expression that determines when to break.

Range: text string

breakpoint_enabled

A true/false value depending on whether or not the breakpoint is enabled.

Range: Boolean value

Default: True

breakpoint_id

Unique identifier for the breakpoint per translation.

Range: 32-bit positive integer

breakpoint_name

Optional name that is given to the breakpoint.

Range: text string

Default: OutputTransformerName [OutputTransformerType]: OutputAttributeName->InputTransformerName[InputTransformerType]: InputAttributeName

Example: ParseWorkspaceFile [PythonCaller] : Output -> FeatureMerger_2 [FeatureMerger] : Requestor

breakpoint_test_clause

The test clause on which the breakpoint is hit, including: left/right value and operator

Range: text string

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

Connections connect Reader Feature Types, Transformer Input Ports, Transformer Output Ports, and Writer Feature Types. They can be enabled or disabled.

Attribute Name Description

connection_enabled

A Yes/No value depending on whether or not the connection is enabled.

Range: Boolean value

connection_execution_index

An integer identifier for the execution order from the source of the connection. This value that starts at zero and is relative to each specific output port.

Range: 32-bit positive integer

connection_hidden

A Yes/No value depending on whether or not the connection is hidden.

Range: Boolean value

connection_id

Unique integer identifier for the connection in the workspace per translation.

Range: 32-bit positive integer

connection_source_id

Unique integer identifier for the reader feature type or transformer output port at the source of the connection.

Range: 32-bit positive integer

connection_source_port_desc

The name of the reader feature type or transformer output port at the source of the connection. Note that default transformer output ports do not have a name and will have an empty string value.

Range: text string

connection_target_id

Unique integer identifier for the writer feature type or transformer input port at the target of the connection.

Range: 32-bit positive integer

connection_target_port_desc

The name of the writer feature type or transformer input port at the target of the connection. Note that default transformer input ports do not have a name and will have an empty string value.

Range: text string

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type contains the name and type of the format attributes on each of the feature types defined in a source workspace.

Attribute Name Description

feature_type_id

Unique identifier for the feature type per translation.

Range: 32-bit positive integer

format_attribute_name

The name of the various format attributes on the feature type.

Range: text string

Default: Either comes for a schema file if it is a fixed schema or from the input file if dynamic schema

format_attribute_type

The value associate with the various format attributes on the feature type.

Range: text string

Default: Either comes for a schema file if it is a fixed schema or from the input file if dynamic schema

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type represents a pair of parameters for a feature type in workspace. Each feature type parameter pair belongs to a specific feature type for a specific reader or writer in the workspace.

Attribute Name Description

feature_type_id

Unique identifier for the feature type per translation.

Range: 32-bit positive integer

feature_type_parameter_name

The name of the parameters on the feature type.

Range: text string

Default: One or more parameters on a feature type.

feature_type_parameter_value

The value of the parameters on the feature type.

Range: text string

Default: One or more parameters on a feature type.

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type contains the name and type of the user attributes on each of the feature types defined in a source workspace.

Attribute Name Description

feature_type_id

Unique identifier for the feature type per translation.

Range: 32-bit positive integer

user_attribute_exposed

A true/false value depending on whether or not a user attribute is exposed.

Range: Boolean value

user_attribute_name

The name of the various user attributes on the feature type.

Range: text string

user_attribute_type

The value associate with the various user attributes on the feature type.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

These feature types contain information about the files that comprise the workspace (for example, datasets).

Attribute Name Description

creation_date

Date and time the workspace file was created, according to the file system, in the form of yyyymmddhhmmss.

Range: date time

file_path

The absolute path for the source dataset .fmw file.

Range: text string

file_size

The size of the source dataset file in kilobytes.

Range: 32-bit positive integer

last_run_date

Date and time the workspace file was last accessed, according to the file system, in the form of yyyymmddhhmmss.

Note  It is possible that on Windows file systems, the accessed date may not change when a file is simply executed depending on the registry settings. Specifically, if HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisableLastAccessUpdate is set to 1, in order to minimize disk I/O and performance impacts of running processes, the file system will not update the last accessed date.

Range: date time

modified_date

Date and time the workspace file was modified, according to the file system, in the form of yyyymmddhhmmss.

Range: date time

password_protected

Indicates whether or not the workspace is password protected.

Range: Boolean value

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type contains information about workspaceuser parameters.

Note  Although this feature type is named PublishedParameters, each feature may describe either a published parameter or a private parameter.

Each feature in this type provides a duplicate of the information in a UserParameters feature, but with the older GUI line representation of the type instead of the full JSON definition.

Attribute Name Description

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

published_parameter_containing_group

If the parameter is not at the root level of its structure, this provides the parameter name of the group that immediately contains it.

Range: text string

published_parameter_default_value

Default value of the published parameter.

The value will vary in range based on the parameter type.

Range: text string

published_parameter_name

Name of the parameter that will prompt the user for information when a workspace is run.

Range: text string

published_parameter_type

Type of parameter: published or private.

Range: text string

Default: empty string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

Each feature produced by this feature type represents a reader feature type in the source workspace. This feature type contains information about the attributes for each feature, including: qualifier, name, possible geometries, and whether the feature type is enabled.

Attribute Name Description

reader_feature_type_enabled

A true/false value depending on whether or not the feature type is enabled.

Range: Boolean value

Default: True

feature_type_id

Unique identifier for the feature type per translation.

Range: 32-bit positive integer

reader_feature_type_name

Fixed name given to the reader feature type.

Range: text string

reader_feature_type_possible_geometries

List of possible geometry names on the reader.

Range: text string

Default: fmw_none

reader_feature_type_qualifer

The output table feature type prefix text for database formats.

Range: text string

Default: Empty string

reader_id

Unique identifier for the reader per translation.

Range: 32-bit positive integer

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

ReaderHistogram feature types include a count for each type of reader. This is useful for obtaining counts across many workspaces based on component type (reader, writer, and transformer).

Each feature represents a data value for one type in the histogram. For example, one ReaderHistogram feature type with a reader_type of SHAPEFILE and a reader_count of 3 indicates that there are three Shapefile readers in the workspace.

Format "short names" are visible in the FME Workbench Reader and Writer Gallery: Select Tools > Browse Readers and Writers.

Attribute Name Description

reader_count

Number of instances for a given reader type.

Range: 32-bit positive integer

reader_type

Reader short format name. For example, SHAPEFILE, CSV, XML.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

Each feature produced by this feature type represents a reader parameter in the source workspace. This feature type contains information about each parameter name and value pair.

Attribute Name Description

reader_id

Unique identifier for the reader per translation.

Range: 32-bit positive integer

reader_parameter_name

The name of the various parameters on the reader.

Range: text string

reader_parameter_value

The value associated with the various parameters on the reader.

Range: text string

Default: Zero or one reader parameter values per reader in the workspace.
Attribute Name Description

reader_enabled

A true/false value depending on whether the reader is enabled.

Range: Boolean value

Default: True

reader_generate_build_number

The build number that was assigned to the reader when it was generated.

Range: 32-bit positive integer

reader_id

Unique identifier for the reader per translation.

Range: 32-bit positive integer

reader_keyword

This is the unique name for the reader. This is usually the reader_type with a numeric suffix added for uniqueness.

Range: text string

Example: SHAPE_1 or R_1

reader_name

The name of the reader. This value is the same as the name in the FME Workbench Navigator Pane or in the reader feature type parameters.

Range: text string

Default: filename[formatShortName] - countOfThisTypeOfReader

reader_type

This is the built-in defined type for the reader found in the reader name. This is usually the format short name (format type identifier).

Range: text string

Default:FME Workbench defined type

Example: CSV

source_dataset

The source absolute path for the reader. This includes the folder, file name, and extension.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type contains statistics information about the number of various components of a workspace. Note that this does not currently account for components in custom transformers or formats.

Additional data on the types of elements can be found in histogram feature types per reader, writer, and transformer below.

Attribute Name Description

num_annotations

Number of workspace annotations.

Range: positive integer

num_bookmarks

Number of workspace bookmarks.

Range: 32-bit positive integer

num_breakpoints

Number of workspace breakpoints.

Range: 32-bit positive integer

num_connections

Number of workspace connections.

Range: 32-bit positive integer

num_custom_transformers

Number of workspace custom transformers.

Range: 32-bit positive integer

num_out_of_date_transformers

Number of workspace out of date transformers.

Range: 32-bit positive integer

num_published_parameters

Number of workspace published parameters. This includes both published and private parameters.

Range: 32-bit positive integer

Default: One published parameter per reader or writer in the workspace.

num_reader_feature_types

Number of workspace reader feature types.

Range: 32-bit positive integer

num_readers

Number of workspace readers.

Range: 32-bit positive integer

num_transformers

Number of workspace transformers.

Range: 32-bit positive integer

num_writer_feature_types

Number of workspace writer feature types.

Range: 32-bit positive integer

num_writers

Number of workspace writers.

Range: 32-bit positive integer

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

TransformerHistogram feature types include a count for each type of transformer. This is useful for obtaining counts across many workspaces based on component type (reader, writer, and transformer).

Each feature represents a data value for one type in the histogram. For example, one TransformerHistogram feature type with a transformer_type of CREATOR and a a transformer_count of 3 indicates that there are three Creator transformers in the workspace.

Attribute Name Description

transformer_count

Number of instances for a given transformer type.

Range: 32-bit positive integer

transformer_type

The base type of the transformer. For example, Creator, Logger.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

Transformer output port attribute name and type pairs are listed here for each feature for every transformer read from the workspace file.

Attribute Name Description

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

transformer_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

transformer_output_port_attribute_constant_value

Value of the attribute added to the port. (Right-click and select Add Attribute.)

Range: text string

transformer_output_port_attribute_enabled

Indicates whether the output port attribute is enabled.

Range: Boolean

transformer_output_port_attribute_name

The name of the various attributes on the transformer output ports.

Range: text string

Default: Zero or more attribute names per transformer output port in the workspace.

transformer_output_port_id

Unique identifier for the workspace per translation.

Range: positive integer

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

Transformer output port names are listed here for each feature for every transformer read from the workspace file.

Attribute Name Description

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

transformer_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

transformer_output_port_id

Unique identifier for the transformer output port per translation. Values may change if the order of input datasets varies.

Range: positive integer

Default: One published parameter per reader or writer in the workspace.

transformer_output_port_name

Default/user-defined name given to the transformer output port.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type represents a pair of parameters for a transformer in workspace. Each transformer parameter pair belongs to a specific transformer in the workspace.

Attribute Name Description

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

transformer_id

Unique identifier for the workspace per translation.

Range: positive integer

transformer_parameter_name

The name of the various parameters on the transformers.

Range: text string

Default: Built-in defined FME parameter names

transformer_parameter_value

The type associate with the various parameters on the transformers.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type represents a transformer in the source workspace. This feature type includes information about transformer name, transformer type, transformer version, the build number on last edit of transformer, and whether the transformer is enabled or disabled in the workspace.

Custom transformers will also be detected and will set a specific transformer_type attribute. Embedded custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. Sub-components will be tagged with the custom_transformer_parent_name attribute identifying the containing custom transformer name.

Attribute Name Description

current_transformer_version

The current version of the transformer in the workspace.

Range: 8-bit positive integer

Default: Usually the max transformer version supported in the build.

custom_transformer_order

The processing order of the transformer within the containing custom transformer, starting at 1. This attribute is only present when reading a transformer in a sub-component.

Range: 32-bit positive integer

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

max_transformer_version

The most current version of a transformer in FME, useful to indicate whether an update is required.

Range: 8-bit positive integer

Default: The highest current version of the transformer type.

transformer_aliases

Any alternative names that refer to the transformer.

Range: Comma-separated text string

Example: FeatureRateLimiter,FeatureThrottler,FeatureDelayer

transformer_enabled

A true/false value depending on whether or not the transformer is enabled.

Range: Boolean value

Default: True

transformer_id

Unique identifier for the transformer per translation.

Range: 32-bit positive integer

transformer_last_edit_build_number

The last build of FME Workbench used to save the transformer.

Range: 32-bit positive integer

transformer_name

The name given to the transformer. Usually this is the transformer_type with a numeric suffix added for uniqueness.

Range: text string

Example: Creator2

transformer_order

The processing order of the transformer within the main workspace, starting at 1. When processing a sub-component, this attribute is only present if the sub-component is directly within the main workspace.

Range: 32-bit positive integer

transformer_type

This is the built-in defined type for the transformer.

Note that for custom transformers, this value can be either SubDocumentTransformer for Embedded Custom Transformers, or ExternalTransformer for Linked Custom Transformers.

Range: text string

Default:FME Workbench defined type

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type contains information about workspace user parameters (published or private).

Each feature in this type provides a duplicate of the information in a PublishedParameters feature, but with the full JSON definition of the type instead of the older GUI line information.

Attribute Name Description

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

user_parameter_default_value

Default value of the user parameter.

The value will vary in range based on the parameter type.

Range: text string

user_parameter_definition

JSON string representing the parameter’s complete definition.

Range: text string

user_parameter_name

Name of the parameter that will prompt the user for information when a workspace is run.

Range: text string

user_parameter_parent_group

If the parameter is not at the root level of its structure, this provides the parameter name of the group that immediately contains it.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

This feature type describes the structure for a set of related user parameters. The structure defines the full definition of all parameters, in the order in which they appear, along with any structure formed by nested “group” parameters. (The individual parameter definitions from the structure are also duplicated in the separate UserParameters features.)

There is one UserParameterStructures feature which defines the structure for the global parameters, in addition to one for each custom transformer defined in the workspace. (The features representing custom transformers’ structures will also be tagged with the custom_transformer_parent_name attribute identifying the containing custom transformer name.)

Attribute Name Description

custom_transformer_parent_name

Custom transformers will also have their sub-components read including transformers, annotations, bookmarks, breakpoints, connections, and global parameters. If applicable, this attribute will indicate the custom transformer name in which the feature is embedded.

Range: text string

structure_definition

JSON definition representing the definitions and entire structure for the user parameters in the structure

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

A list of all the parameters associated with the workspace. Each workspace contains information that includes FME build number, history, and optional, user-defined properties. In FME Workbench, these properties are found in the Navigator pane under Workspace Parameters.

Attribute Name Description

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

workspace_parameter_name

Name of the parameter

Range: text string

workspace_parameter_value

Value of the parameter

Range: text string

Each workspace contains information that includes FME build number, history, and optional, user-defined properties. In FME Workbench, these properties are found in the Navigator pane.

Attribute Name Description

begin_python

Startup script to execute before the workspace is run.

Range: text string

category

Arbitrary user-defined grouping of workspaces. Optional.

Range: text string

end_python

Shutdown script to execute when the workspace is finished running.

Range: text string

help

Optional help text provided by the workspace author to assist in using the workspace.

Range: text string

history

The record of changes made to a workspace.

Range: text string

last_save_date

Date and time the workspace file was last saved, in the form of yyyy-mm-ddThh:mm:ss.

Range: date time

legal

Legal terms and conditions.

Range: text string

modified_build_number

The last build of FME Workbench used to save the workspace.

Range: 32-bit positive integer

requirement

Requirements that must be met before using the workspace.

Range: text string

requirements_flag

An option on the requirement that indicates whether additional requirements exist to run the workspace.

Range: None, workspace, Third Party

Default: None

use_markdown

Indicates whether markdown is used for the workspace description.

Range: text string

workspace_description

Arbitrary text description of workspace provided by the workspace author.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

workspace_name

Name of workspace derived from the base name of the workspace file.

Range: text string

Each feature type represents a writer feature type in the source workspace. These feature types contains information about the attributes for each feature including the type qualifier, name, possible geometries, and whether the feature type is enabled.

Attribute Name Description

feature_type_id

Unique identifier for the feature type per translation.

Range: 32-bit positive integer

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

writer_feature_type_enabled

A true/false value depending on whether or not the feature type is enabled.

Range: Boolean value

Default: True

writer_feature_type_name

Fixed name given to the writer feature type.

Range: text string

writer_feature_type_possible_geometries

List of possible geometry names on the writer.

Range: text string

Default: fmw_none

writer_feature_type_qualifer

The output table feature type prefix text for database formats.

Range: text string

Default: Empty string

writer_id

Unique identifier for the writer per translation.

Range: 32-bit positive integer

WriterHistogram feature types include a count for each type of writer. This is useful for obtaining counts across many workspaces based on component type (reader, writer, and transformer).

Each feature represents a data value for one type in the histogram. For example, one WriterHistogram feature type with a writer_type of XML and a writer_count of 3 indicates that there are three XML writers in the workspace.

Format "short names" are visible in the FME Workbench Reader and Writer Gallery: Select Tools > Browse Readers and Writers.

Attribute Name Description

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

writer_count

Number of instances for a given writer type.

Range: 32-bit positive integer

writer_type

Writer short format name. For example, SHAPEFILE, CSV, XML.

Range: text string

This feature type represents one writer parameter in the source workspace, and contains information about each writer parameter name and value pair.

Attribute Name Description

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

writer_id

Unique identifier for the writer per translation.

Range: 32-bit positive integer

writer_parameter_name

The name of the various parameters on the writer.

Range: text string

writer_parameter_value

The value associated with the various parameters on the writer.

Range: text string

Default: Zero or one writer parameter values per writer in the workspace.

This feature type represent one writer in the source workspace. Information includes: writer name, writer keyword, writer type, destination dataset, and the build number on writer generation.

Attribute Name Description

destination_dataset

The source absolute path for the writer. This includes the folder, file name, and extension.

Range: text string

workspace_id

Unique identifier for the workspace per translation.

Range: 32-bit positive integer

writer_enabled

A true/false value depending on whether or not the writer is enabled.

Range: Boolean value

Default: True

writer_generate_build_number

The build number that was assigned to the writer when it was generated.

Range: 32-bit positive integer

writer_id

Unique identifier for the writer per translation.

Range: 32-bit positive integer

writer_keyword

This is the unique name for the writer. Usually this is the writer_type with a numeric suffix added for uniqueness.

Range: text string

Example: SHAPE_1 or W_1

writer_name

The name of the writer. This value is the same as the name in the FME Workbench Navigation Pane or in the writer feature type parameters.

Range: text string

Default: filename[formatShortName] - countOfThisTypeOfWriter

writer_type

This is the built-in defined type for the writer found in the writer name. Usually the format short name.

Range: text string

Default: FME Workbench defined type

Example: CSV