DATASET
The dataset from which feature data is to be read.
Required/Optional
Required
Workbench Parameter
Source Autodesk AutoCAD DWG/DXF File(s)
INTERPRET_EXTENDED_DATA
Required/Optional
Optional
Values
Yes | No
Workbench Parameter
Read Interpreted Extended Entity Data
LIST_EXTENDED_DATA
Required/Optional
Optional
Values
Yes | No
Workbench Parameter
Read Extended Entity Data As List
LIST_ATTRIBUTE_ENTITY_DATA
Required/Optional
Optional
Values
Yes | No
Workbench Parameter
Read Attribute Entity Data As List
STORE_BULGE_INFO
This directive allows the creation of autocad_start_width and autocad_end_width attributes to represent the width properties of Polyline and LWP entities. This is generally set to Yes only when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Values
YES | NO (default)
STORE_SPLINE_DEFS
When specified, the AutoCAD Reader, in addition to vectorizing the splines, stores the spline coefficients as attributes. See the description of Spline below for the attribute names used to store the spline definition. This is generally set to Yes when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Values
YES (default) | NO
Workbench Parameter
Store Spline Definitions
RESOLVE_BLOCKS
Specifies whether the reader will resolve (or explode) the block entities when processing inserts, or if it should just treat inserts as a point feature. This is generally set to No when performing AutoCAD-to-AutoCAD translations.
When the reader resolves blocks, it outputs a feature for each of the AutoCAD entities that are part of the block definition. The original insert is not output. This results in the full graphical representation of the block transferred through FME. The exact insertion point of the block is lost unless the STORE_INSERT_POINT directive is also used.
Each block member feature is given the attribute autocad_block_number which is set to the same value for each block so that the features comprising each block may be combined in subsequent processing. Arbitrarily deep block nesting is permitted, however, the autocad_block_number attribute is only updated for each block at the outermost level. The feature type of the block members is determined by the USE_BLOCK_HEADER_LAYER directive, and the attributes storing layer information for the block members is determined by the USE_BLOCK_LAYER_INFO directive.
If the block contains “Attribute” then each instance of “Attribute” in the block insert will be returned as “Text” entity along with a non-spatial feature containing information about that “Attribute” definition and its value for that block.
If the exact insertion point of the block is desired, then block resolution should be turned off and the insert entities for each block should be translated into point features in the output system. Alternatively, the STORE_INSERT_POINT directive may be specified to keep the insert point on the attributes of block member features.
Required/Optional
Optional
Values
YES (default) | NO
Workbench Parameter
Explode Blocks into Entities
RESOLVE_SELECTED_BLOCKS
This directive is a list of the blocks that are to be exploded, and is processed only when RESOLVE_BLOCKS is specified. Blocks that occur in both this list and DO_NOT_RESOLVE_BLOCKS will not be exploded, DO_NOT_RESOLVE_BLOCKS takes precedence. This is a space delimited list of the block names.
Required/Optional
Optional
Values
space-delimited list of block names
Default value
empty list
Workbench Parameter
Explode Selected Blocks
DO_NOT_RESOLVE_BLOCKS
This directive is an exception list of the blocks that are not to be exploded, and is processed only when RESOLVE_BLOCKS is specified. Blocks that occur in both this list and RESOLVE_SELECTED_BLOCKS will not be exploded, this directive takes precedence.
Required/Optional
Optional
Values
space-delimited list of block names
Default value
empty list
Workbench Parameter
Not applicable
STORE_INSERT_POINT
Specifies whether the reader should add the insert point location as attributes to the block component entities when resolving (or exploding) inserts entities.
This is generally set to No when performing AutoCAD-to-AutoCAD translations.
When the reader resolves blocks, it outputs a feature for each of the AutoCAD entities that are part of the block definition. The original insert is not output, but this directive allows the insert location to still be represented.
This results in each block member feature having the following attributes: autocad_block_insert_[xyz].
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter
Store Insert Location on Components
USE_BLOCK_HEADER_LAYER
Specifies how the reader may set the feature type of the block component entities when resolving (or exploding) insert entities.
This directive applies only if RESOLVE_BLOCKS is set to Yes. It is generally set to No when performing AutoCAD-to-AutoCAD translations.
When the reader resolves blocks, it outputs a feature for each of the AutoCAD entities that are part of the block definition. When set to Yes, this directive indicates that all block members will be on the same layer-based feature type as that of the original block. Otherwise, the block members will appear on their respective layer-based feature types.
This directive is useful when resolving components when using a layer-based schema, and it is desirable for block component features to share a layer-based feature type. This does not change the layer information on the component features to match their layer-based feature type. That is the role of the USE_BLOCK_LAYER_INFO directive.
Required/Optional
Optional
Values
YES (default) | NO
Workbench Parameter
Use Block Feature Type for Components
USE_BLOCK_LAYER_INFO
Specifies how the reader should set the layer information attributes of the block component entities when resolving (or exploding) insert entities.
This directive applies only if RESOLVE_BLOCKS is set to Yes. It is generally set to No when performing AutoCAD-to-AutoCAD translations.
When the reader resolves blocks, it outputs a feature for each of the AutoCAD entities that are part of the block definition. When set to Yes, this directive indicates that all block members will have the same layer information as that of the original block. Otherwise, the block members will have the layer information of their respective layers.
The layer specific attributes are those such as autocad_layer, autocad_layer_hidden, autocad_layer_color etc. This also affects related symbology attributes such as autocad_lineweight or autocad_color which may have ByLayer values.
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter
Use Block Layer Information for Components
RESOLVE_DIMENSIONS
Specifies whether or not to resolve (explode) dimensions into their individual pieces.
If the value is yes, each geometric piece of the dimension will be output as a separate feature, as well as a non-geometric autocad_dimension_def feature.
If the value is no, an aggregate containing all the pieces of the original dimension will be output (i.e., an autocad_dimension).
This is generally set to no when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Values
YES (default) | NO (default)
Workbench Parameter
Explode Dimensions
PRESERVE_INSERTS
Required/Optional: Optional
If the value for RESOLVE_BLOCKS is yes, and this directive is also yes, then block insert points are output as point features.
Values
YES | NO (default)
CONVERT_ZERO_LENGTH_ARCS_TO_POINTS
Specifies whether a zero length arc should be converted into a point feature (i.e., autocad_point). If the feature becomes a point, it will still retain all the attributes it had while it was an arc. This is generally set to no only when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Values
YES (default) | NO
Workbench Parameter
Convert Zero Length Arcs to Points
OUTPUT_BLOCKS_AT_START
Specifies that the reader will output all the block definitions at the beginning of the translation before any other features are output. After the blocks are output, the rest of the translation is run without the blocks being resolved. When specified, this value overrides the value specified by RESOLVE_BLOCKS.
When set, all features that are part of a block definition have the attribute autocad_block_definition, with the value of the attribute being the name of the block which they are a component.
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter
Output Blocks at Start
IGNORE_FROZEN_LAYERS
Specifies whether the reader will ignore all features on the frozen layers. If set to yes, then features located on the frozen layers are not read from the input data set. If set to no, then the features are read from the frozen layer.
Required/Optional
Optional
Values
YES | NO (default)
IGNORE_LOCKED_LAYERS
Specifies whether the reader will ignore all features on the locked layers. If set to yes, then features located on the locked layers are not read from the input data set. If set to no, then the features are read from the locked layer.
Required/Optional
Optional
Values
YES | NO (default)
IGNORE_HIDDEN_LAYERS
Specifies whether the reader will ignore all features on the hidden layers. If set to yes, then features located on the hidden layers are not read from the input dataset. If set to no, then the features are read from the hidden layer. If this option is specified at the time of workspace or mapping file generation, and the schema mode is by layer, then no schema information from hidden layers will be used to generate the workspace or mapping file. This is generally set to No when performing AutoCAD-to-AutoCAD translations.
Note: Hidden layers are different from individual entity visibility; however, either may cause an entity to not appear.
Required/Optional
Optional
Values
YES (default) | NO
VISIBLE_ATTRIBUTES_AS_TEXT
Specifies whether the reader should return visible attributes as separate text features or whether they should be returned as attributes of an insert feature.
When this directive is set to Yes, each attribute entity with a visibility setting indicating that it is visible is returned as a single text feature.
Note: Multi-line attributes are represented as text strings with embedded line feed characters.
This directive is generally set to No when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Optional
Values
YES (default) | NO
Workbench Parameter
Read Visible Attributes as Text Entities
EXTENDED_ENTITY_FORMAT
Note: Deprecated: Extended entity data formatting is now automatic.
Instructs FME to use the specified manner when decoding the extended entity data. This directive disables the automatic parsing.
Values: ALTERNATE_NAME_VALUE | CSV(<SEPARATOR>)
where <SEPARATOR> specifies the character used to delimit the attribute name from the attribute value.
When ALTERNATE_NAME_VALUE is specified, then it is assumed that the values stored with each feature in the extended entity portion of the feature alternate between specifying the attribute name and attribute value.
When CSV(<SEPARATOR>) is specified, then an attribute name value pair is specified in each extended entity value. The values are separated by <SEPARATOR>.
Required/Optional
Optional
READ_PROXY_GRAPHICS
Values
YES (default) | NO
Required/Optional
Optional
Workbench Parameter
Read Proxy Entity Graphics
READ_SYS_VARS
Determines whether FME will attempt to read certain AutoCAD System Variables that are stored within the drawing.
Values
YES | NO (default)
Required/Optional
Optional
Workbench Parameter
Read Drawing System Variables
READ_MODEL_SPACE
Required/Optional
Optional
Instructs FME to read the entities from the model space.
Values
YES (default) | NO
Workbench Parameter
Read Model Space
READ_PAPER_SPACE
Required/Optional: Optional
Values
YES | NO (default)
Workbench Parameter
Read Paper Space
READ_SELECTED_PAPER_SPACE
Required/Optional
Optional
Values
Space-delimited list of paper space names
Workbench Parameter
Read Selected Paper Spaces
RESOLVE_VIEWPORT
Required/Optional: Optional
Values
YES | NO (default)
Workbench Parameter
Read Model Space Entities Through Viewport
READ_ACTIVE_PAPER_SPACE_ONLY
Instructs FME to read from the active paper space only.
Values:
YES (default) | NO
Required/Optional
Optional
Workbench Parameter
Read Active Paper Space Only
READ_GROUPS
Determines whether or not AutoCAD groups will be read. By default, FME will not read groups.
Required/Optional
Optional
Values:
YES | NO (default)
Workbench Parameter
Read Groups
READ_XREFS
Determines whether or not AutoCAD entities which represent External References will be read.
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter
Read External References
EVALUATE_MLINE_GEOM
Determines how Multi-line entities are read. When this directive is absent or set to NO, then Multi-Line geometry is constructed of lines containing only the explicit vertexes of the base line, and the relative vertexes of additional lines. When this directive is set to YES, additional evaluation of Multi-line properties is done, and this may result in additional vertexes and gaps in the geometry. The evaluated geometry form is a more complete geometric representation of an Multi-line entity, but cannot be written without loss by the AutoCAD Writer.
Values
YES | NO (default)
Required/Optional
Optional
Workbench Parameter
Evaluate Multi-line Entity Geometry
IGNORE_UCS
Instructs FME to ignore the user defined coordinate system of the file being read.
By default, FME applies the UCS when reading the coordinate data. This is generally set to Yes only when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter
Ignore UCS
USE_DXF_HEADER
When reading DXF files, this directive instructs the reader to use the specified dxf header file as the header for the file being read.
This option is used in situations where organizations produce headerless dxf files to save storage space.
Required/Optional
Optional
Values
<DXF_HEADER_FILE>
where <DXF_HEADER_FILE> specifies the full pathname to the dxf header file.
If this is specified when reading a DWG file, the translation is terminated with an error.
Workbench Parameter
DXF Header File
SKIP_TO_SECTION
When USE_DXF_HEADERS is specified above, this specifies how much of headerless file is to be skipped. In some cases, the headerless file has a placeholder which has to be removed before concatenating the above header file to the dataset. If not specified, then no lines are skipped.
Required/Optional
Optional
Values
one of the AutoCAD SECTIONs as specified in AutoCAD files
PRESERVE_COMPLEX_HATCHES
Specifies whether or not to read hatches and mpolygons in a way that preserves their complex properties.
Values
YES | NO (default)
Specifies whether or not to read hatches and MPolygons in a way that preserves their complex properties. If Preserve Complex Hatches and MPolygons is not selected, then the loops of each hatch entity will be converted to areas and aggregated together, and polyline bulge arcs will be interpolated into lines. If Preserve Complex Hatches and MPolygons is selected, then the loops will be aggregated together as polygons, and ordered such that any enclosing loop will be stored before any enclosed loop. Attributes will may be added to store polyline bulge arc information.
Required/Optional
Optional
Workbench Parameter
Preserve Complex Hatches and MPolygons
READ_AS_2_5D
Determines whether polylines should have their elevation attribute treated as a Z coordinate; when this occurs the autocad_elevation attribute will not be present. Applies to lightweight polylines and 2D polylines.
Note: This option should not be set when performing AutoCAD-to-AutoCAD translations as the elevations converted to Z coordinates when read in will not be converted back to elevation attributes when written out.
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter: Read Polylines as 2.5D
RESOLVE_ENTITY_COLOR
Specifies whether or not to resolve the color of the entity to the color of the layer for that entity or block of that entity. This resolution only affects entities that already have a color that is set to COLOR_BYLAYER which is indicated by a color of ByLayer (index 256), or COLOR_BYBLOCK which is indicated by a color of ByBlock (index 0).
If the value of this directive is YES, and the entity has a color of COLOR_BYLAYER, then the autocad_original_color attribute is set to ByLayer, and the autocad_color attribute is set to the color index for the layer that the entity is on.
Similarly, If the value of this directive is YES, and the entity has a color of COLOR_BYBLOCK, then the autocad_original_color attribute is set to ByBlock, and the autocad_color attribute is set to the color index for the block that the entity is in.
If the value of this directive is NO, then both the autocad_color attribute and the autocad_original_color attribute will remain unresolved as a value of ByLayer or ByBlock.
This is generally set to NO when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Values
YES (default) | NO
Workbench Parameter: Resolve Entity Color
APPLY_WORLD_FILE
Use this directive when you have an Esri World file (*.wld) that you want FME to use when determining the coordinates for features in your dataset.
When this directive has a value of YES, FME will search the folder of the dataset for a file with the same name as your dataset but with a .wld extension. If it cannot find a file with that name, it will then look for the file “esri_cad.wld” within the dataset folder. If either file exists, then FME will use the information in the files to translate the coordinates of the features in the dataset to their new geospatial coordinates. If the files cannot be found, then the translation will continue, using the coordinate information found in the dataset, without performing any additional transformation.
Required/Optional
Optional
Values
YES (default Workbench value) | NO (default mapping file value)
Workbench Parameter
Apply World File
EXPLODE_MTEXT
Specifies whether the reader will explode the mtext entities into separate text entities.
When exploding, the resulting text features represent fragments of text with the same mtext properties such as style. Such text features are created from the mtext location and attachment point to have default justified locations.
When not exploding, the mtext entity will be read as a single text feature. Such mtext features have a geometry that is default justified, but which specifies an autocad_attach_point relative to the geometry. This is generally set to No when performing AutoCAD-to-AutoCAD translations.
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter
Explode MText
STORE_LAYER_INFO
When specified, the AutoCAD Reader will add additional attributes describing the layer properties for the layer of each feature. These include
- autocad_layer_linetype,
- autocad_layer_color, and
- autocad_layer_lineweight
Required/Optional
Optional
Values
YES | NO (default)
Workbench Parameter
Store Layer Properties on Features
XRECORD_READING
Required/Optional
Optional
Values
None | Lists
Workbench Parameter
Entity XRecord Data Reading
PRESERVE_CLIPPED_RASTERS
Specifies whether the reader should leave a raster unclipped and only store the clipping information as attributes or to actually apply the clipping.
Required/Optional
Optional
Values
YES | NO (default)
- NO: Clipped rasters being read will have their clipping information applied, and anything outside the clipping bounds will be lost.
- YES: The raster will not be clipped and the clipping information may be retrieved from the feature attributes, this allows clipped raster features to pass through FME with no loss of data.
This is generally set to YES when performing AutoCAD-to-AutoCAD translations.
Workbench Parameter
Not applicable
SEARCH_ENVELOPE
Using the minimum and maximum x and y parameters, define a bounding box that will be used to filter the input features. Only features that interact with the bounding box are returned.
If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE <minX> <minY> <maxX> <maxY>
Note: If all four coordinates of the search envelope are specified as zero, the search envelope will be disabled.
Required/Optional
Optional
Workbench Parameter
Minimum X, Minimum Y, Maximum X, Maximum Y
SEARCH_ENVELOPE_COORDINATE_SYSTEM
This directive specifies the coordinate system of the search envelope if it is different than the coordinate system of the data.
The COORDINATE_SYSTEM directive, which specifies the coordinate system associated with the data to be read, must always be set if the SEARCH_ENVELOPE_COORDINATE_SYSTEM directive is set.
If this directive is set, the minimum and maximum points of the search envelope are reprojected from the SEARCH_ENVELOPE_COORDINATE_SYSTEM to the reader COORDINATE_SYSTEM prior to applying the envelope.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE_COORDINATE_SYSTEM <coordinate system>
Workbench Parameter
Search Envelope Coordinate System
CLIP_TO_ENVELOPE
This directive specifies whether or not FME should clip features to the envelope specified in the SEARCH_ENVELOPE directive.
Values
YES | NO (default)
Mapping File Syntax
<ReaderKeyword>_CLIP_TO_ENVELOPE [yes | no]
Workbench Parameter
Clip To Envelope
EXPOSED_ATTRS
This directive allows the selection of format attributes to be explicitly added to the reader feature type.
This is similar to exposing format attributes on a reader feature type once it has been generated; however, it is even more powerful because it enables schema-driven applications other than Workbench to access and leverage these attributes as if they were explicitly on the schema as user attributes.
The result of picking a list of attributes is a comma-separated list of attribute names and types that will be added to the schema features. Currently all reader feature types will receive the same set of additional schema attributes for a given instance of the reader.
Required/Optional
Optional
Mapping File Syntax
Not applicable.
While it is possible for FME Objects applications to invoke this directive, the required format is not documented.
This directive is intended for use in our GUI applications (for example, Workbench) only.
Workbench Parameter
Additional Attributes to Expose