Actions of Electronic Signature (COOSIGNATURE@1.1)

ReferenceName
COOSIGNATURE@1.1:AllowedClassesFilter
COOSIGNATURE@1.1:AttrSignaturesGetDisp
COOSIGNATURE@1.1:CheckAuthentication
COOSIGNATURE@1.1:CompleteManualSignature
COOSIGNATURE@1.1:CopySignatures
COOSIGNATURE@1.1:CopySignaturesManual
COOSIGNATURE@1.1:EnterManualSignature
COOSIGNATURE@1.1:FilterAllowedSignatures
COOSIGNATURE@1.1:GetAdditionalSignatureModifications
COOSIGNATURE@1.1:GetAllowedSignatures
COOSIGNATURE@1.1:GetManualSignaturesMenu
COOSIGNATURE@1.1:GetPersonDisp
COOSIGNATURE@1.1:GetSignatureMenu
COOSIGNATURE@1.1:GetSignatureProperty
COOSIGNATURE@1.1:GetSignatureSettings
COOSIGNATURE@1.1:GetSignatureType
COOSIGNATURE@1.1:GetUsableSignatureTypes
COOSIGNATURE@1.1:IsAllowedSignature
COOSIGNATURE@1.1:ModifyPage
COOSIGNATURE@1.1:ObjectCommitted
COOSIGNATURE@1.1:PrepareManualSignature
COOSIGNATURE@1.1:PrepareSignature
COOSIGNATURE@1.1:PropagateManualSignature
COOSIGNATURE@1.1:PropagateSignature
COOSIGNATURE@1.1:SetConfigEntries
COOSIGNATURE@1.1:SetSignatures
COOSIGNATURE@1.1:SetSignaturesManual
COOSIGNATURE@1.1:SignObject
COOSIGNATURE@1.1:SignSelectedObjects
COOSIGNATURE@1.1:SignSelectedObjectsManual
COOSIGNATURE@1.1:VerificationNeeded

COOSIGNATURE@1.1:AllowedClassesFilter

This action can be called on a signature type to remove the classes not allowed by signature configurations from the list of object classes, that is passed as parameter. This action can be used by software components to pre-check, if a certain signature type is available. It is not called by the signature component itself to evaluate signature configurations.
ParameterTypeIn/OutOptionalDescription
classesCOOSYSTEM@1.1:OBJECTLISTin/outfalse On input the list of object classes to check. On output the list of object classes allowed for the current user in the current role.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:AttrSignaturesGetDisp

Display action to format the signatures for display in columns

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetDispPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:CheckAuthentication

ParameterTypeIn/OutOptionalDescription
signtypeCOOSYSTEM@1.1:OBJECTinfalse
selobjectsCOOSYSTEM@1.1:OBJECTLISTinfalse
remarkCOOSYSTEM@1.1:STRINGin/outtrue
hwndCOOSYSTEM@1.1:INTEGERintrue
contextCOOSYSTEM@1.1:COMINTERFACEintrue
dispatcherCOOSYSTEM@1.1:OBJECTintrue
argumentintrue
verifyactionintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:CompleteManualSignature

This action is used to perform an manual signature on an object
ParameterTypeIn/OutOptionalDescription
propagatetoobjectsCOOSYSTEM@1.1:OBJECTLISTintrue The objects where the signature is propagated to
nodefaultpropagationCOOSYSTEM@1.1:BOOLEANintrue if the parameter propagatetoobjects is not set the default signature propagation do by COOSYSTEM@1.1:GetModifyPropagation can be disabled.
signatureusecasecontextCOOSYSTEM@1.1:OBJECTintrue an object to identify in which use case the signature was performed. E.g.: The activity instance which performs the signature. The signature usecase context is stored in the signature.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:CopySignatures

Additional Information

Prototype: COOSYSTEM@1.1:AttrCopyPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:CopySignaturesManual

Additional Information

Prototype: COOSYSTEM@1.1:AttrCopyPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:EnterManualSignature

Usecase to record a manual signature
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue
indexCOOSYSTEM@1.1:INTEGERintrue
objclassCOOSYSTEM@1.1:OBJECTintrue
focusattrCOOSYSTEM@1.1:OBJECTintrue
domodalCOOSYSTEM@1.1:BOOLEANintrue
oleitemCOOSYSTEM@1.1:STRINGintrue
attrsCOOSYSTEM@1.1:OBJECTLISTintrue
formsobjCOOSYSTEM@1.1:OBJECTintrue
checkactionCOOSYSTEM@1.1:OBJECTintrue
lockedCOOSYSTEM@1.1:BOOLEANintrue
internal11intrue
internal12intrue
handleparentCOOSYSTEM@1.1:INTEGERintrue
itempathCOOSYSTEM@1.1:STRINGintrue

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:FilterAllowedSignatures

ParameterTypeIn/OutOptionalDescription
objlistCOOSYSTEM@1.1:OBJECTLISTinfalse
signlistCOOSYSTEM@1.1:OBJECTLISTin/outfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetAdditionalSignatureModifications

Get additional signature modification to the modifications configured on the signature type
ParameterTypeIn/OutOptionalDescription
signobjectsCOOSYSTEM@1.1:OBJECTLISTinfalse the objects which should be signed
modificationsCOOSIGNATURE@1.1:SignatureModificationListoutfalse the signature modifications

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetAllowedSignatures

ParameterTypeIn/OutOptionalDescription
objlistCOOSYSTEM@1.1:OBJECTLISTinfalse
signlistCOOSYSTEM@1.1:OBJECTLISToutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetManualSignaturesMenu

This action is used as menu get action for a menu for manual signatures objects.

Additional Information

Prototype: COODESK@1.1:MenuGetActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetPersonDisp

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetDispPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetSignatureMenu

This action is used as menu get action for a menu of signature types. It is called by the desk, when the menu tree is built with regard to the selected objects.

Additional Information

Prototype: COODESK@1.1:MenuGetActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetSignatureProperty

ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTinfalse
valueoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetSignatureSettings

Get the signature settings for a specific sign type
ParameterTypeIn/OutOptionalDescription
verificationCOOSIGNATURE@1.1:SignatureVerificationoutfalse
genavailCOOSYSTEM@1.1:BOOLEANoutfalse
versionkindCOOSIGNATURE@1.1:SignatureVersionKindoutfalse
propagateCOOSYSTEM@1.1:BOOLEANoutfalse
propversionkindCOOSIGNATURE@1.1:SignatureVersionKindoutfalse
useremarkCOOSYSTEM@1.1:BOOLEANoutfalse
mustremarkCOOSYSTEM@1.1:BOOLEANoutfalse
disablemenuCOOSYSTEM@1.1:BOOLEANouttrue
propagatechangeableCOOSYSTEM@1.1:BOOLEANouttrue
signobjectsCOOSYSTEM@1.1:OBJECTLISTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetSignatureType

This action is used to retrieve the signature type object, that is represented by a dynamic menu entry.
ParameterTypeIn/OutOptionalDescription
menudynkeyCOOSYSTEM@1.1:INTEGERinfalse The key in the dynamic menu entry.
signtypeCOOSYSTEM@1.1:OBJECToutfalse The corresponding signature type object.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:GetUsableSignatureTypes

ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTinfalse
signtypesCOOSYSTEM@1.1:OBJECTLISToutfalse
searchCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:IsAllowedSignature

ParameterTypeIn/OutOptionalDescription
selobjectsCOOSYSTEM@1.1:OBJECTLISTinfalse
allowedCOOSYSTEM@1.1:BOOLEANoutfalse
manualCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:ModifyPage

Additional Information

Prototype: COOATTREDIT@1.1:FormPageItemPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:ObjectCommitted

This action is used as pre-wrapper for the action COOSYSTEM@1.1:ObjectCommitted, which is called by the kernel on every object changed in a transaction after these changes are persisted in the Fabasoft Components stores.
ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTinfalse The list of properties changed in the transaction.
changedatCOOSYSTEM@1.1:DATETIMEinfalse The date and time of the change of the object.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:PrepareManualSignature

ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:COMINTERFACEintrue
dispatcherCOOSYSTEM@1.1:OBJECTintrue
argumentintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:PrepareSignature

This action is called to prepare the creation of versions of a signed object as configured in the specified signature type.
ParameterTypeIn/OutOptionalDescription
signtypeCOOSYSTEM@1.1:OBJECTinfalse The signature type used.
propagatetoobjectsCOOSYSTEM@1.1:OBJECTLISTintrue
nodefaultpropagationCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:PropagateManualSignature

ParameterTypeIn/OutOptionalDescription
manualsignatureCOOSIGNATURE@1.1:SignatureManualListinfalse

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:PropagateSignature

Check workflow action, if and how it is usable in a Web environment.
ParameterTypeIn/OutOptionalDescription
signatureCOOSIGNATURE@1.1:SignatureListinfalse

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:SetConfigEntries

This action is used as property set action for the property COOSIGNATURE@1.1:sgconfentries. It is called by the kernel before that property is saved.

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:SetSignatures

This action is used as property set action for the property COOSIGNATURE@1.1:signatures. It is called by the kernel before the values in this property are saved.

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:SetSignaturesManual

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:SignObject

This action is used and can be called to sign an object with the specified signature type. It authenticates the current user and updates the signature list with the new signature.
ParameterTypeIn/OutOptionalDescription
signtypeCOOSYSTEM@1.1:OBJECTinfalse The signature type.
contextCOOSYSTEM@1.1:COMINTERFACEintrue If used in a Web environment, this parameter has to contain the calling context, to be able to authenticate the user.
remarkCOOSYSTEM@1.1:STRINGintrue The remark provided for the signature.
propagatetoobjectsCOOSYSTEM@1.1:OBJECTLISTintrue The objects where the signature is propagated to
dispatcherCOOSYSTEM@1.1:OBJECTintrue in a Web environment, this parameter is used for authentication of the signature
argumentintrue in a Web environment, this parameter is used for authentication of the signature
nodefaultpropagationCOOSYSTEM@1.1:BOOLEANintrue if the parameter propagatetoobjects is not set the default signature propagation do by COOSYSTEM@1.1:GetModifyPropagation can be disabled.
signaturequalityCOOSYSTEM@1.1:STRINGintrue an additional description for the quality of the signature which is stored at the signature
signatureusecasecontextCOOSYSTEM@1.1:OBJECTintrue an object to identify in which use case the signature was performed. E.g.: The activity instance which performs the signature. The signature usecase context is stored in the signature.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:SignSelectedObjects

This is the dynamic menu action, that is used in the dynamic menu entries returned by COOSIGNATURE@1.1:GetSignatureMenu. It is called by the desk, when the user triggers one of these menu entries.

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOSIGNATURE@1.1:SignObject
Prototype: COODESK@1.1:MenuDynActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:SignSelectedObjectsManual

Usecase to record a manual signature

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOSIGNATURE@1.1:PrepareManualSignature
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSIGNATURE@1.1:VerificationNeeded

ParameterTypeIn/OutOptionalDescription
doverifyCOOSYSTEM@1.1:BOOLEANoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]