Update Values and Properties of Document Fields

This page describes how to update values and properties of document fields.

The following code is a sample of updating values and properties of three fields of the document identified by Document ID.

This code includes the following parameters:

• sessionId: A string that uniquely identifies the session for the current logged on user. If the session ID is invalid, an exception is raised.
• docId: The ID of the document to be updated.
• field1: The ID or name of a document field to be updated.
• field1Value: The value to set for field1.
• field1Error: The error message to set for field1.
• field2: The ID or name of a second document field to be updated.
• field2Value: The value to set for field2.
• field2ExtractionConfident: The ExtractionConfident value to set for field2.
• field3: The ID or name of a third document field to be updated.
• field3Row: The row of the third document field to be updated.
• field3Col: The column of the third document field to be updated.
• field3Value: The value to set for field3.
• field3Width: The width value to set for field3.

Sample code for UpdateDocumentFieldPropertyValues:

public void UpdateDocumentFieldPropertyValuesSample(string sessionId, string docId, string field1,
    string field1Value, string field1Error, string field2, string field2Value, bool field2ExtractionConfident,
    string field3, int field3Row, int field3Col, string field3Value, string field3Width)
{
    var cds = new sdk.CaptureDocumentService();

    try
    {
        // Update the given system field.
        cds.UpdateDocumentFieldPropertyValues(sessionId, null, docId, new FieldPropertiesCollection {
            new FieldProperties {
                Identity = new RuntimeFieldIdentity(field1),
                PropertyCollection = new FieldSystemPropertyCollection {
                    new FieldSystemProperty {
                        SystemFieldIdentity = new FieldSystemPropertyIdentity {
                            Name = "Value"
                        },
                        Value = field1Value
                    },
                    new FieldSystemProperty {
                        SystemFieldIdentity = new FieldSystemPropertyIdentity {
                            Name = "ErrorDescription"
                        },
                        Value = field1Error
                    }
                }
            },
            new FieldProperties {
                Identity = new RuntimeFieldIdentity(field2),
                PropertyCollection = new FieldSystemPropertyCollection {
                    new FieldSystemProperty {
                        SystemFieldIdentity = new FieldSystemPropertyIdentity {
                            Name = "Value"
                        },
                        Value = field2Value
                    },
                    new FieldSystemProperty {
                        SystemFieldIdentity = new FieldSystemPropertyIdentity {
                            Name = "ExtractionConfident"
                        },
                        Value = field2ExtractionConfident
                    }
                }
            },
            new FieldProperties {
                Identity = new RuntimeFieldIdentity(field3, field3Row, field3Col),
                PropertyCollection = new FieldSystemPropertyCollection {
                    new FieldSystemProperty {
                        SystemFieldIdentity = new FieldSystemPropertyIdentity {
                            Name = "Value"
                        },
                        Value = field3Value
                    },
                    new FieldSystemProperty {
                        SystemFieldIdentity = new FieldSystemPropertyIdentity {
                            Name = "Width"
                        },
                        Value = field3Width
                    }
                }
            }
        });
    }
    catch (Exception ex)
    {
        // Unhandled exceptions will terminate processing from progressing through the remaining nodes on the process map.
        throw;
    }
}

---