This chapter describes the services available when using and customizing electronic signatures in Oracle WebCenter Content.
This chapter covers the following topics:
Electronic signature services are used to configure, get, and sign unique identifiers that Oracle WebCenter Content Server generates and stores with revision metadata for content items. Electronic signatures can be used with general content items, content items in workflows, and with PDF Watermark.
Information about what is a WebCenter Content service and how services can be used is provided in Chapter 2. Information about basic services structure, attributes, actions, and a service example is provided in Chapter 3. You should be familiar with this information before customizing current services or creating new services.
The locations for specific Electronic Signature services are listed within each individual service.
For information about using Electronic Signature, see Oracle Fusion Middleware Using Oracle WebCenter Content.
The following services can be used when the Electronic Signature component is enabled in Oracle WebCenter Content:
Service that loads the electronic signatures administration page.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
ResultSets:
ESigUserDefinedSignatureFields: Information about custom electronic signature fields.
Service that gets the electronic signatures of a document.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
ESigViewSignaturesDocID: The ID of the document.
ESigViewSignaturesRevisionID: The revision ID of the document.
ESigViewSignaturesDocName: The content ID of the document.
Additional Optional Service Parameters
ESigGetSignaturesAllRevisions: If this parameter is set, the service returns electronic signatures of all revisions of the document.
ESigCallOrigin: The call origin key.
ResultSets:
DOC_INFO: Information about the document.
ESigViewSignaturesResultSet: Information about the signatures.
Service that gets the electronic signatures of a document.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
dID: The ID of the document.
Additional Optional Service Parameters
dDocName: The content ID of the document.
ESigGetSignaturesAllRevisions: If this parameter is set, the service returns electronic signatures of all revisions of the document.
ESigCallOrigin: The call origin key.
ResultSets:
DOC_INFO: Information about the document.
ESigViewSignaturesResultSet: Information about the signatures.
Service that gets detailed information about an electronic signature.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
ESigSignatureSequence: The sequence ID of the electronic signature.
ResultSets:
ESigUserDefinedFieldValues: Information from the custom electronic signature fields.
UserAttribInfo: Electronic signer's user attributes.
Service that loads the electronic signature content form.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
dID: The ID of the document to sign.
isESigUIAction: This checks for session and cookie according to the new design of electronic signature user reauthentication, which redirects the user to the WebLogic Server login page for authentication. Always set this to 1 (one), which indicates it's a native 11g user interface action.
ESigCallOrigin: The call origin key that determines the redirected page on the native 11g user interface after the signing. Set this to DOC_INFO.
ResultSets:
DOC_INFO: Information about the document.
ESigUserDefinedSignatureFields: Information about the custom electronic signature fields.
Service that loads the Workflow electronic signature content form.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
dID: The ID of the document.
isESigUIAction: This checks for session and cookie according to the new design of electronic signature user reauthentication, which redirects the user to the WebLogic Server login page for authentication. Always set this to 1 (one), which indicates it's a native 11g user interface action.
ESigCallOrigin: The call origin key that determines the redirected page on the native 11g user interface after the signing. Set this to WORKFLOW.
Additional Optional Service Parameters
ESigWorkflowName: The workflow name.
ESigWorkflowStepname; The workflow step name.
ResultSets:
DOC_INFO: Information about the document.
ESigUserDefinedSignatureFields: Information about custom electronic signature fields.
Service that gets the information about custom electronic signature fields.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
ResultSets:
ESigUserDefinedSignatureFields: Information about the custom electronic signature fields.
Service that loads the validate file form.
Service Class: ESigHandler
Access Level: READ
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
ESigDocName: The content ID of the document.
ESigContext: Set to specific to indicate the search is on a specific content item, or set to global to indicate the search is on all the items in system.
Additional Optional Service Parameters
ESigDocTitle: Title of the electronic signature document.
Service that saves the configuration of custom electronic signatures fields.
Service Class: ESigHandler
Access Level: READ
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
fieldName_index: The custom electronic signature field name. If multiple fields are being configured, they are distinguished by index. index starts at 0 and increments.
displayLabel_index: The custom field display label.
dataType_index: The custom field data type.
hasChoiceList_index: If set to true, the custom field is a choice list.
listOfValues_index: If the custom field is a choice list, specifies the list of values.
isCheckbox_index: If set to true, the custom field is a check box.
isRequired_index: If set to true, the custom field is a required field.
Additional Optional Service Parameters
esigIsAdminUpdate: If set to true, the configuration will be updated.
ResultSets:
ESigUserDefinedSignatureFields: Information about custom electronic signature fields.
Service that signs content electronically.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
ESigSignContentDocID: The ID of the document to sign.
ESigSignContentPassword: The user's password for reauthentication.
ESigSignContentDocRevisionID: The revision ID of the document to sign.
ESigSignContentDocName: The content ID of the document to sign.
$customField: The ID of the document to sign. This field is required if a custom field is required.
Additional Optional Service Parameters
isESigUIAction: If set, the sign service checks for session and cookie information according to the electronic signature user reauthentication design, which redirects the user to the Oracle WebLogic Server login page for authentication.
ESigCallOrigin: The call origin key that determines the redirected page on the native 11g user interface after the document is signed.
ResultSets:
DOC_INFO: Information about the document.
Service that searches for a local file in the repository by matching checksum against the list of available revisions for a specified content item. This service must pass the file content as part of a request to validate. A browser request passes the file content as part of form-data, whereas RIDC requires an instance of oracle.stellent.ridc.model.TransferFile class to send the file content to the server.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
ESigDocName: The content ID of the document.
ESigValidationFile: The instance of oracle.stellent.ridc.model.TransferFile class.
Additional Optional Service Parameters
ESigDocTitle: Title of the electronic signature document.
ESigContext: To indicate the search is on a specific content item, set to specific.
ResultSets:
ESigValidateFileDocInfoResultSet: Information about the matching content item revision(s). ESigValidateFileStatus in the LocalData section indicates the status of the search. Possible values are OK and NO_MATCH.
Service that searches for a local file in the repository by matching checksum against all the items in the system. This service must pass the file content as part of a request to validate. A browser request passes the file content as part of form-data, whereas RIDC requires an instance of oracle.stellent.ridc.model.TransferFile class to send the file content to the server.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
ESigValidationFile: The instance of oracle.stellent.ridc.model.TransferFile class.
Additional Optional Service Parameters
ESigContext: To indicate the search is on a specific content item, set to specific.
ResultSets:
ESigGlobalValidationResultSe: Information about the matching content item(s). ESigValidateFileStatus in the LocalData section indicates the status of the search. Possible values are OK and NO_MATCH.
Service that signs and approves content in a workflow.
Service Class: ESigHandler
Access Level: None
Location: IdcHomeDir/components/ElectronicSignatures/resources/esig_service.htm
Additional Required Service Parameters
dID: The generated content item revision ID.
ESigSignContentDocID: The ID of the document to sign.
ESigSignContentPassword: The user's password for reauthentication.
ESigSignContentDocRevisionID: The revision ID of the document to sign.
ESigSignContentDocName: The content ID of the document to sign.
$customField: The ID of the document to sign. This field is required if a custom field is required.
Additional Optional Service Parameters
ESigWorkflowName: The name of the workflow.
ESigWorkflowStepName: The name of the workflow step.
ESigCallOrigin: The call origin key that determines the redirected page on the native 11g user interface after the document is signed.
isESigUIAction: If set, the sign service checks for session and cookie information according to the electronic signature user reauthentication design, which redirects the user to the Oracle WebLogic Server login page for authentication.