Annotation Related Parameters for the FileImageDataProvider
The following parameter settings are used to enable annotation:
- artConnectionStringName - (Optional) If this attribute is not provided then the default value is the one provided with "connectionStringName" attribute. Specifying artConnectionStringName is useful if the annotations data is stored on a separate database server.
- sqlArtParameter -(Required) Represents the column / data field being searched in the query.
For the built-in SqlImageDataProvider, we recommend that this column / data field contain unique values. The sqlArtParameter does not have to be a primary key or foreign key. You may choose any column for the query in your command. However, if your query results in multiple row fetches, only the first row will be processed. Other rows will be ignored.
- sqlArtReadCommand - (Required) SQL query to retrieve annotations data. It can be edited to suit your database. This query should retrieve annotations data associated with the DocumentIdentifer of the image document being retrieved.
- sqlArtReadCommandType - (Required) A SQL command can either be in a command format or a stored procedure call. This attribute specifies if it is a Text (syntax "Text") command or a stored procedure (syntax "StoredProcedure").
- sqlArtUpdateCommand - (Required) A SQL query that is run to update the annotations data.
- sqlArtUpdateCommandType - (Required) Specifies if the sqlArtUpdateCommand is in a Text format (syntax "Text") or a stored procedure call (syntax "StoredProcedure").
- sqlArtDataField - (Required) Represents the database table field/column that holds the annotation data. If using the built-in SqlImageDataProvider, even when images are stored as files, the annotations data are expected to be stored as CLOBs (character large objects or VARCHAR(MAX) Sql data type.
- artFieldParameterLength - (Optional) This specifies the length of the art data Field (sqlArtDataField). This parameter is useful for preventing SQL injection if you are using a stored procedure in your query. For a detailed description of SQL Injection, refer to the article on MSDN:
- artFieldParameterDbType - (Optional) Specifies the Sql Database type of the sqlArtDatafield parameter. This attribute is used in conjunction with the above attribute (artFieldParameterLength) to prevent SQL injection attacks.
