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.
Feature Types
Statistics
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 |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| num_published_parameters |
Number of workspace published parameters. This includes both user and private parameters. Range: 32-bit positive integer Default: One published parameter per reader or writer in the workspace. |
| 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_readers |
Number of workspace readers. Range: 32-bit positive integer |
| num_custom_readers |
Number of workspace custom readers. Range: 32-bit positive integer |
| num_reader_feature_types |
Number of workspace reader feature types. Range: 32-bit positive integer |
| num_writers |
Number of workspace writers. Range: 32-bit positive integer |
| num_custom_writers |
Number of workspace custom writers. Range: 32-bit positive integer |
| num_writer_feature_types |
Number of workspace writer feature types. Range: 32-bit positive integer |
| num_transformers |
Number of workspace transformers. 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_connections |
Number of workspace connections. Range: 32-bit positive integer |
Histograms
Histogram feature types include a count for each type of reader, writer, and transformer. This is useful for obtaining counts across many workspaces based on component type.
Each feature represents a data value for one type in the histogram. For example, one ReaderHistogram feature type with a reader_type of ESRISHAPE and a reader_count of 3 indicates that there are 3 Shapefile readers in the workspace.
Format "short names" are visible in the FME Workbench Reader and Writer Gallery: Select Tools > Browse Readers and Writers.
ReaderHistogram
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| reader_type |
Reader short format name. For example, ESRISHAPE or MIF. Range: text string |
| reader_count |
Number of instances for a given reader type. Range: 32-bit positive integer |
WriterHistogram
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| writer_type |
Writer short format name. For example, ESRISHAPE or MIF. Range: text string |
| writer_count |
Number of instances for a given writer type. Range: 32-bit positive integer |
TransformerHistogram
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| transformer_type |
The base type of the transformer. For example, Creator or Clipper. Range: text string |
| transformer_count |
Number of instances for a given transformer type. Range: 32-bit positive integer |
WorkspaceProperties
Each workspace contains information that includes FME build number, history, and optional, user-defined properties. In FME Workbench, these properties are found in the Workbench Navigator pane.
| Attribute Name | Description |
|---|---|
| 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 |
| workspace_description |
Arbitrary text description of workspace provided by the workspace author. Range: text string |
| modified_build_number |
The last build of FME Workbench used to save the workspace. Range: 32-bit positive integer |
| category |
Arbitrary user-defined grouping of workspaces. Optional. Range: text string |
| usage |
Any special workspace instructions. Range: text string |
| history |
The record of changes made to a workspace. Range: text string |
| 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 |
FileProperties
These feature types contain information about the files that comprise the workspace (for example, datasets).
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| 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 |
| creation_date |
Date and time the workspace file was created in the form of yyyymmddhhmmss. Range: date time |
| modified_date |
Date and time the workspace file was modified in the form of yyyymmddhhmmss. Range: date time |
| last_run_date |
Date and time the workspace file was last run in the form of yyyymmddhhmmss. Range: date time |
PublishedParameters
These feature types contain information about workspace published parameters (user and private).
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| 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 the published parameter: user or private. Range: text string Default: empty 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 |
Annotations
These feature types contain information on the text and type for any annotations read from the workspace file.
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| annotation_id |
Unique identifier for the annotation per translation. Range: 32-bit positive integer |
| annotation |
The text of the annotation. Range: text string |
| annotation_type |
What the annotation is attached to, and whether or not it is a standard component. Source, Data Flow, and Destination headers appear when Automatically generate header annotations option is checked in Tools > FME Options > Workbench > Annotation Defaults. Regular annotations are attached to any other parts of the workspace. Range: REGULAR, SOURCE_HEADER, DATAFLOW_HEADER, DEST_HEADER, UNSET Default: REGULAR |
Bookmarks
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| bookmark_name |
Name of the bookmark (as shown in the title bar of the bookmark on the Workbench canvas). Range: text string Default: “New Bookmark” |
| bookmark_description |
Description of a bookmark, if applicable. Range: text string Default: Empty string |
Breakpoints
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace 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_condition |
An expression that determines when to break. Range: text string |
| breakpoint_test_clause |
The test clause on which the breakpoint is hit, including: left/right value and operator Range: text string |
| breakpoint_enabled |
A true/false value depending on whether or not the breakpoint is enabled. Range: Boolean Value Default: True |
Connections
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_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_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_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_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 |
| 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_connection_hidden |
A Yes/No value depending on whether or not the connection is hidden. Range: Boolean Value |
Readers
| Attribute Name | Description |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| reader_id |
Unique identifier for the reader per translation. Range: 32-bit positive integer |
| reader_name |
The name of the reader. This value is the same as the name in the Workbench Navigator Pane or in the reader feature type parameters. Range: text string Default: filename[formatShortName] - countOfThisTypeOfReader |
| 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_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: 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 |
| 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 |
ReaderParameters
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. |
ReaderFeatureTypes
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_id |
Unique identifier for the reader per translation. Range: 32-bit positive integer |
| feature_type_id |
Unique identifier for the feature type per translation. Range: 32-bit positive integer |
| feature_type_qualifer |
The output table feature type prefix text for database formats. Range: text string Default: Empty string |
| feature_type_name |
Fixed name given to the reader feature type. Range: text string |
| feature_type_possible_geometries |
List of possible geometry names on the reader. Range: text string Default: fmw_none |
| feature_type_enabled |
A true/false value depending on whether or not the feature type is enabled. Range: Boolean Value Default: True |
Writers
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 |
|---|---|
| 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_name |
The name of the writer. This value is the same as the the name in the Workbench Navigation Pane or in the writer feature type parameters. Range: text string Default: filename[formatShortName] - countOfThisTypeOfWriter |
| writer_keyword |
This is the unique name for the writer. Usually this is the reader_type with a numeric suffix added for uniqueness. Range: text string Example: SHAPE_1 or W_1 |
| 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: Workbench defined type Example: CSV |
| destination_dataset |
The source absolute path for the writer. This includes the folder, file name, and extension. Range: text string |
| 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 |
WriterParameters
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 |
|---|---|
| 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. |
WriterFeatureTypes
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 |
|---|---|
| writer_id |
Unique identifier for the writer per translation. Range: 32-bit positive integer |
| feature_type_id |
Unique identifier for the feature type per translation. Range: 32-bit positive integer |
| feature_type_qualifer |
The output table feature type prefix text for database formats. Range: text string Default: Empty string |
| feature_type_name |
Fixed name given to the writer feature type. Range: text string |
| feature_type_possible_geometries |
List of possible geometry names on the writer. Range: text string Default: fmw_none |
| feature_type_enabled |
A true/false value depending on whether or not the feature type is enabled. Range: Boolean Value Default: True |
FeatureTypeUserAttributes
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_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 |
| user_attribute_exposed |
A true/false value depending on whether or not a user attribute is exposed. Range: Boolean Value |
FeatureTypeFormatAttributes
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 |
FeatureTypeParameters
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 various parameters on the feature type. Range: text string Default: One or more parameters on a feature type. |
| feature_type_parameter_type |
The type associate with the various parameters on the feature type. Range: text string |
Transformers
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 |
|---|---|
| workspace_id |
Unique identifier for the workspace per translation. Range: 32-bit positive integer |
| transformer_id |
Unique identifier for the transformer per translation. 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_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: Workbench defined type |
| transformer_aliases |
Any alternative names that refer to the transformer. Range: Comma-separated text string Example: FeatureRateLimiter,FeatureThrottler,FeatureDelayer |
| 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. |
| 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: Whichever the highest current version of the transformer type is. |
| transformer_enabled |
A true/false value depending on whether or not the transformer is enabled. Range: Boolean Value Default: True |
| transformer_last_edit_build_number |
The last build of FME Workbench used to save the transformer. Range: 32-bit positive integer |
TransformerParameters
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 |
|---|---|
| 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 |
TransformerOutputPorts
Transformer output port names are listed here for each feature for every transformer read from the workspace file.
| Attribute Name | Description |
|---|---|
| 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 |
TransformerOutputPortAttributes
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 |
|---|---|
| transformer_output_port_id |
Unique identifier for the workspace per translation. Range: Positive Integer |
| 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_attribute_type |
The type associated with the various attributes on the transformer output ports. Range: Text String |