Esri ArcSDE Raster Catalog Writer Parameters
WARNING: The Esri Legacy ArcSDE format will be deprecated in FME 2019+. Please consider upgrading to an Esri Geodatabase reader. For more information, see http://fme.ly/sde30.
Database Connection
- OS Authentication provides the necessary information to connect to the SDE server, by validating the username and password through the operating system. If you choose Parameters, you will have to fill in the username and password fields.
- Populate from Connection File… will fill in the Database Connection parameters with values extracted from an Esri Connection File. If selected, a file chooser dialog will open, and you can navigate to and select the desired connection file.
Once selected and confirmed, all the Database Connection parameters except the password will be populated from the data in the connection file. This option is particularly useful for ensuring that the Instance parameter is correct for direct connections.
Note that this option requires the installation of a compatible and licensed version of ArcGIS.
Enter the ArcSDE server name.
This field identifies the SDE database from which features are retrieved. In SDE, the dataset is referred to as the Database. The Source Dataset area of the Set Translation Parameters dialog box will default to sde, which is the dataset name you will use most often. This field is required no matter what the underlying RDBMS of the SDE. Some RDBMSes, such as Oracle, do not require a value, whereas others, such SQLServer, do. For databases that do not require the value, the field will be ignored.
Enter the username and password to access the service.
The instance to which FME is to connect. The usual value for systems with a single SDE instance is esri_sde. The instance can also be of the form port:<port-number>, which is usually port:5151 (you may have to confirm this with your System Administrator).
Table Parameters
This field sets the default value for the configuration parameter SDE_CONFIG_KEYWORD. It specifies the storage parameters for the raster column.
If not specified, the keyword DEFAULTS will be used.
Tip: For more information, search parameter name-configuration string pairs in Esri ArcGIS Server help files.
Advanced
Instructs FME to operate in a specific mode:
- Insert: The features being written to the database are not checked to see if duplicate key values are in the database. This is useful when loading new data into the SDE.
- Update or Delete: The writer will check to see if the format attribute fme_db_operation exists on the feature and, then, if it does the specified operation will be used. If the attribute is set to Insert, the feature will be inserted; if the value is Update, the feature will be updated if present, otherwise it will be inserted; and if the value is Delete, the feature will be deleted. If the
fme_db_operation
is not found then the operation performed will be based on the value of this parameter.
The writer needs some way to identify which rows to update or delete. It will first look on the feature for a WHERE clause in the format attribute fme_where. If the fme_where attribute is not present, the columns given in Update Key Columns (SDE_UPDATE_FIELDS) configuration parameter will be used to make up a key. If neither the fme_where attribute nor the Update Key Columns parameters are present, the writer will use ArcSDE-maintained (Object Id) column as the key, provided the table is registered or is spatially enabled. To avoid updating or deleting multiple features all at once, the user is responsible for ensuring that the specified key uniquely identifies a single feature within the SDE database. It is strongly recommended for performance reasons that the columns referenced in fme_where or in Update Key Columns are properly indexed using RDBMS indices.
If this parameter is not specified, then Insert mode is used.
Instructs the SDE writer module to use transactions when loading data into the SDE.
The writer does not write any features to the SDE until the feature is reached that belongs to Last Successful Transaction.
Specifying a value of 0 causes the SDE writer to use transactions and to write every feature to the SDE. Usually, the value specified is zero – a non-zero value is only specified when a data load operation is being rerun.
If this parameter is not specified, then transactions are not used during the data load operation.
The number of features to place in each transaction before a transaction is committed to the database.
This statement instructs the FME where to find the pipeline file(s) to be used. A pipeline is used when a failure occurs in writing a feature. When this parameter is specified and there was an error in writing a feature, the writer first attempts to open a pipeline specific to the current table. The writer looks for a file called <tableName>_pipeline.fmi in the specified folder. If the file is not found, then the writer looks for a default pipeline called default_pipeline.fmi in the same folder. If neither of these files are found, then the translation is stopped.
If a pipeline file is found, then an FME pipeline is created. The pipeline can do almost anything a regular FME pipeline can do. However, only the first feature from the pipeline is retrieved. If the pipeline does not return any feature, then the writer does not insert into SDE the row that corresponds to the feature. At the present time, the feature is recorded as written in the statistics portion of the FME log, whether or not it was actually inserted into SDE.
If this parameter is used with the Skip Bad Data parameter set to Yes or ROLLBACK_THEN_CONTINUE, and a feature is returned from the pipeline, then if the returned feature causes an error while being written to the SDE, it will not cause the translation to stop. Rather a warning message, explaining why the feature couldn’t be written, will be logged and the translation will continue. If ROLLBACK_THEN_CONTINUE was specified, the current transaction will be rolled back instead of committed when it comes time to commit the transaction.
If this parameter is not specified, then no pipeline will be created by the writer for features rejected by SDE. A pipeline is only created if this parameter is specified and a failure occurs in writing a feature
Value: The absolute or relative path of a folder containing pipeline files. If the path contains spaces, the path should be double-quoted.
Instructs the writer to continue a translation even when an error occurs while attempting to load the data (the error may or may not be related to the data). A warning message explaining what went wrong will be output for each feature that could not be written to SDE.
This parameter is useful when trying to load bad data.
When set to ROLLBACK_THEN_CONTINUE, if a feature fails to be written, then the current transaction will be rolled back rather than committed when it is time to commit the transaction. This means that none of the features in the rolled back transaction will be written to SDE. The translation will continue regardless of the error encountered. Transactions must be used when this value is specified. When used in conjunction with the Rejected Pipeline Folder parameter, if a feature returned from a pipeline fails to be written, then the current transaction will be rolled back instead of committed.
If set to Yes and transactions are being used, all transactions will be committed; however, failed features will not be written to SDE.
Specifies the maximum number of streams that can be open simultaneously.
Each stream writes to a particular table and so this parameter determines the maximum number of tables that can be open and written to simultaneously.
If this parameter is not specified, or is given the value 0, then the SDE writer will set the maximum number of streams open simultaneously to 4 less than the number specified by MAXSTREAMS in giomgr.defs.
Specifies a definition to use for all integer column types when creating new tables.
Any of the allowed FME attribute types for the ArcSDE Writer can be used as values. Additionally, you can also use number(<width>) or number(<width>, <decimal>).
By default, this parameter is not set, and so integer columns are stored using the C language long integer data type.
When specified, the buffered writing of the SDE is used; this dramatically decreases the load time of data into SDE.