Required & Editable Text Fields on Documents in Signing Ceremony
Wednesday, August 5, 2020 at 02:06pmI have a few questions in regards to text fields on documents in the signing ceremony:
Can we make the text fields on documents Required or Optional?
Can we specify which signers we want to have Required or Optional text fields attached to?
and lastly,
Using the FieldSummaryService, are we able to retrieve values that were input by the user during the signing ceremony?
Reply to: Required & Editable Text Fields on Documents in Signing Ceremony
Wednesday, August 5, 2020 at 03:40pmHi D'Metrius,
To answer your questions inline:
Can we make the text fields on documents Required or Optional?
If you are (1)specifying x/y coordinates, (2)use position extraction or (3)text anchors, by default, the fields are optional. To mark it as required, use below code:
.WithField(FieldBuilder.TextField()
.OnPage(0)
.AtPosition(200, 400)
.WithSize(150,50)
.WithValidation(FieldValidatorBuilder.Basic().Required().Build())
)
If you are using automatically extraction methods, like text tags or document extraction, whether the field is required is determined by the syntax of your tags.
For text tags: {{*esl:signer1:textfield}} vs {{?esl:signer1:textfield}} - question mark (?) or asterisk (*) determines if the field is optional
For document extraction, you need to mark the Adobe Field as required
Can we specify which signers we want to have Required or Optional text fields attached to?
Field is Signature binded, Signature is Signer binded, so one field - whether required or optional - would only be visible to one signer.
Using the FieldSummaryService, are we able to retrieve values that were input by the user during the signing ceremony?
Yes, this API/SDK function is exactly designed to retrieve input values during signing, try below code:
List<FieldSummary> fieldSummaries = eslClient.FieldSummaryService.GetFieldSummary( packageId );
Console.WriteLine( "SignerId || DocumentId || FieldId: Value" );
foreach ( FieldSummary fieldSummary in fieldSummaries )
{
Console.WriteLine( fieldSummary.SignerId + " || " + fieldSummary.DocumentId + " || " +
fieldSummary.FieldId + ": " + fieldSummary.FieldValue );
}
Duo
Duo Liang OneSpan Evangelism and Partner Integrations Developer