Developer

Signature Property Type

The signature property type stores a signature entered by a user on the Agentry Client. This is an actual, written signature that can be entered on the device using a stylus or some other electronic pen. This signature is stored internally as a bitmap image. Normally only transaction definitions contain signature properties.

Signature properties may not be initialized to the value of another property. Also, it is outside the normal usage to target an object property with a transaction property of type signature. The primary intent of the signature property is to capture a signature in bitmap format on the client device and to then transfer that bitmap image to the back end system as a part of the transaction’s synchronization processing.

This property type includes definable behaviors covering the control that will display the property, and the minimum height and width of the bitmap image captured to treat as a valid signature.

This property type has several associated SDML data tags for accessing its bitmap data. The information on these should be reviewed when working with this property type.

Signature Property Attributes

General Attributes
  • Name: This is the unique identifier for the property definition. This value must be unique among all properties within the same parent definition.
  • Display Name: This attribute sets the default display name to label or otherwise identify the property value on the Client. This will also be the default label for any screen control that displays this property.
  • Required: This attribute specifies whether or not the signature is required. For a transaction when this attribute is true, the user will not be able to advance the wizard until the signature has been captured. This includes meeting the Minimum Signature Size Requirements attribute settings.
  • Time and Date: This attribute specifies whether to embed the client device’s current date and time in the image.
  • Update Rule: This attribute references a rule definition, the return value from which is expected to be a string. This value will be embedded in the bitmap image with the signature.
  • Signed: This attribute contains the text value displayed in the detail screen field targeting the property when the signature has been captured.
  • Get Signature: This attribute contains the text value displayed in the detail screen field targeting the property before the signature has been captured.
Maximum Window Size
  • Height: This attribute specifies the maximum height of the window, in pixels, where the signature is entered.
  • Width: This attribute specifies the maximum width of the window, in pixels, where the signature is entered.
Minimum Required Signature Size
  • Height: This attribute specifies the minimum height, in pixels, for the signature value. If the signature does not meet this minimum, the signature will not be accepted. If the signature is required, the user will not be able to advance the wizard until the signature has been entered with this minimum height.
  • Width: This attribute specifies the minimum width, in pixels, for the signature value. If the signature does not meet this minimum, the signature will not be accepted. If the signature is required, the user will not be able to advance the wizard until the signature has been entered with this minimum width.