Electronic signatures (IRPCElectronicSignatures)

View as Markdown

An interface for working with electronic signatures.

Overview

Administrative repair operations for electronic signatures that are stored as separate signature objects. Users sign by running a workflow state transition that requires an electronic signature; these two methods only add placeholder signatures to an object or detach signatures from it, for example to fix an object whose signatures are out of step with its workflow.

• AddEmptyElectronicSignature creates unsigned (empty) signature objects for the signatures that the object's workflow defines.
• DisconnectElectronicSignature removes signatures from the object, optionally marking them invalidated.

Prerequisites shared by both methods:

• The caller needs the vault rights license_allows_modifications, see_all_objects and edit_and_delete_all_objects (VaultAccess). Normal users get "Access denied.".
• The vault must have the metadata structure for separate signature objects: an object type with the alias M-Files.QMS.Signature.ObjectType and property definitions such as M-Files.QMS.Signatures (the object's reference to its signatures), M-Files.QMS.Signature.Identifier, M-Files.QMS.Signature.Signer, M-Files.QMS.Signature.Reason and M-Files.QMS.Signature.Meaning. Without it the calls fail with "Not found." naming the missing alias.
• obj_ver must name a specific version (OBJ_VER_VERSION_TYPE_SPECIFIC); the latest-version form fails with "The parameter is incorrect.".
• A signature is identified by the signature_identifier of the state transition that requires it (StateTransition.signature_settings.signature_identifier, see ElectronicSignatureSettings).

Both methods update the object's signatures property like a property change and return the object after the change.

Methods