Section - 5 : Other Sources and Destinations

---

Sources

Use these properties to configure Documaker Connector with other sources.

BatchLoaderSource Properties

The BatchLoaderSource is a sample source component you can use with the WebCenter Content batch loader script files (although the only action supported is import). The BatchLoaderSource reads import records from batch files that it gets from a batch queue file. These records contain the data necessary to import a document into a destination (specifically, the WebCenter Content, but other destinations could be used with the proper batch files).

Configure the use of the BatchLoaderSource with:

source.name=oracle.documaker.ecmconnector.batchloadersource. BatchLoaderSource

periodic.process=oracle.documaker.ecmconnector.batchloadersource. BatchLoaderProcess

Property	Description	Default
source.batchloader.batchfile	The name of a batch file to be read for import records. This is mainly used when you are running the Connector in Singleton mode.	none
source.batchloader.batchqueuefile	The name of the batch queue file that contains the list of batch files. As the files are processed, they are removed from this file. New files can be added at any time. This is mainly used when you are running the Connector is running in Server mode.	none
source.import.delete.imported.files	Used as specified. For more information, see Table 5 on page 52.	False
source.import.delete.imported.files.count	Used as specified. For more information, see Table 5 on page 52.	Zero (0)
batchloader.source.max.records	The maximum number of records to read from the batch files before processing starts.	One (1)
source.batchloader.errordirectory	The directory where error files will be written for each batch file. The error file names will be in one of these formats: <batch file name>.SOURCEERRORS for errors in the batch file itself (bad data or action) or <batch file name>.IMPORTERRORS for errors from the import attempts.	none
source.persistence.path	See General Source Configuration Properties.

DocumentDataSource Properties

There are no properties for this source component. This component is provided only for use in custom applications written to use the Connector. It cannot be configured and used as a stand-alone source component.

Mock Source Properties

Use these properties to set up a mock source component. The mock source lets you test your implementation without having actual incoming documents. It generates fake documents and metadata based on its configuration and can also generate errors to test how Documaker Connector and the destination handle errors.

You can use it to configure and test the destination before your source is ready to generate test documents. Developers can also use it to generate test data when developing a destination.

Configure the use of the mock source with:

source.name=oracle.documaker.ecmconnector.mocksource.MockSource

Property	Description	Default
Mock Source Properties Property Name Prefix: source.mock.
.empty.lists.allowed	Determines if the empty document lists can be returned from the acquireDocuments method call.	False
.author	The author property for each mock document data.	none
.title	The title property for each mock document data.	none
.type	The document type property for each mock document data.	none
.secgroup	The security group property for each mock document data.	none
.filepath	The file path property for each mock document data.	none
.import.errors	Specifies whether to generate random import errors.	False
.import.error.threshold	The threshold value above which an import error is generated.	75 (out of 100)
.runcount	The number of import cycles to execute before the source closes itself. This is useful for testing in Singleton mode.	Zero (0), which means no limit.

Destinations

Use these properties to configure Documaker Connector with other destinations.

AssureSign Destination Properties

This destination submits/launches documents in the AssureSign system for digital signatures. You must have an AssureSign account.

Note: Visit this website for more information: http://www.assuresign.com/

Configure the use of the AssureSign Destination with:

destination.name=oracle.documaker.ecmconnector.assuresigndestination.AssureSignDestination

Property	Description	Default
AssureSign Destination Properties Property Name Prefix: destination.assuresign.
.username	The AssureSign account name you want to use to launch documents.	none
.contextidentifier	The AssureSign account context identifier.	none
.javax.net.ssl.trustStore	The trust store to use with requests to the AssureSign service.	none
.javax.net.ssl.trustStorePassword	The password for accessing the trust store that contains the AssureSign certificate.	none
Note: The trustStore and trustStorePassword properties override the defaults specified by the JVM running the Connector. You may want to erase these values all together. To do this, set the value for either or both of these properties to “(erase)”. You must specify either the destination.assuresign.template.identifier or the destination.assuresign.template.name. The identifier takes precedence

These values configure the destination component's proxy host values. These may be needed to access the AssureSign service. If not, they should not be configured.

Property	Description	Default
.https.proxyHost	The name of the proxy host necessary to read the AssureSign service.	none
.https.proxyPort	The port number at which to access the proxy host.	none
.https.proxyUser	(Optional) the user name for accessing the proxy host.	none
.https.proxyPassword	(Optional) The password for accessing the proxy host.	none
.template.identifier	The default template identifier you want to use when launching each document.	none
.template.name	(Optional) The default template name used to determine the template ID.	none

You must specify either the destination.assuresign.template.identifier or the destination.assuresign.template.name. The identifier takes precedence. Each template parameter has a name and a value. An identifier is prepended to this prefix and also to the destination.assuresign.template.parameter.value property to link the two. Here is an example:

Property	Description	Default
.template.parameter.name	The prefix defining a template parameter name.	none
.template.parameter.value	The prefix defining a template parameter value. Here is an example: destination.assuresign.template.parameter.name.sig1= Signatory 1 Name destination.assuresign.template.parameter.value.sig1=John Smith	none
.import.method	This property specifies the method for acquiring the document's contents. You can enter file or stream.	none
.agreement.statement	The default agreement statement text you want added to the standard AssureSign agreement text. Choose from file or stream.	file
.compliance.statement	The default compliance statement text you want added to the standard AssureSign compliance text.	none
.extended.disclosures	The default extended disclosures text you want added to the standard AssureSign extended disclosures text.	none

You can override many of these values in the document data you provide with each import request.

Property	Description	Default
.document.type	This property specifies the type of document to be imported, such as PDF, DOC, or DOCX.	none
.order.number	(Optional) The order number associated with the launched document.	none
.document.name	The document's name.
.expiration.date	(Optional) The expiration date for signatories of the launched document. See the AssureSign documentation for more information.	none

The system returns these values in the document's data after an import or launch:

Property	Description	Default
.document.identifier	The AssureSign identifier for this document.	none
.authorization.token	The authorization token associated with a particular document in the AssureSign system.	none

Silanis Destination Properties

This destination submits/launches documents in the Silanis system for digital signatures. You must have an Silanis account.

Configure the use of the Silanis Destination with:

destination.name=oracle.documaker.ecmconnector.silanisdestination. silanisDestination

Property	Description	Default
destination.silanis.username	Username to access the Silanis System	Username
destination.silanis.password	Password to access the Silanis System	Password
destination.silanissign.proxyhost	The proxy server (optional)	Hostname
destination.silanissign.proxyport	The proxy server port (optional)	Port
destination.silanissign.url	The Silanis signing web service URL	URL
destination.silanissign.referencetext	The reference line in the email generated by Silanis.	Reference Text

Note: The Silanis system expects PDF documents so be sure the batch is configured with the correct print and MIME type.

File Destination Properties

Use the File destination to write output documents into a file system directory. By default, the system creates subdirectories in the specified base directory based on each batch identifier.

Note: The File destination includes functionality previously in the FilePlus destination.

Optionally, you can have the system write separate side-car files, which contain some or all of the metadata for each document, to a destination directory you specify. The metadata files are requested by specifying a pattern for their names.

The default output file names and the optional side-car metadata file content can be formatted and controlled using a simple template tag-substitution language. The template tag values are drawn from each document's metadata and the batch identifier (BATCHID).

Note: See Using templates for more information.

Once the system writes a document into the destination directory, its new file name is added to the document's metadata as the value of this name:

destination.file.generated.file.name

If you specified a side-car metadata file, its name is added using this name:

destination.file.generated.side.file.name

Using this destination as an intermediate stop can be a convenient aide in constructing a bridge to another destination that is not directly supported. Stand-alone, possibly custom, import programs can pick up the files and process them into an archive system.

Configure the use of the File destination with:

destination.name=oracle.documaker.ecmconnector.filedestination.FileDestination

Property	Description	Default
File Destination Properties Property Name Prefix: destination.file.
.base.directory	The root directory where the output document files will be placed. The system creates this directory if it does not exist.	none
.side.base.directory	The root directory where the metadata files will be placed. The system creates this directory if it does not exist.	Same as base.directory
.name.pattern	The pattern for the destination file name. This pattern can use the document metadata items as well as the batch ID. If this property is not provided, the source document name is used.	source document name
.side.name.pattern	(Optional) The metadata file name pattern. If you do not want the metadata file included in the output, leave this property empty. If this property is provided, you must also provide the.template or.template.path.	none
.subdirectory.pattern	The pattern for the destination file subdirectory to be used or created under the.base.directory location.	${BATCHID}
.side.subdirectory.pattern	The pattern for the metadata file subdirectory to be used or created under the.side.base.directory location.	${BATCHID}
.template.path	The path to a template file for the side metadata file to be written with each output document.	none
.template	Used if the.template.path property is unspecified. This is the metadata file contents template as a single string.	none

Using templates

The templates referenced in the File Destination Properties use simple tag substitutions. You can use the value of any file metadata property in a template expression by enclosing the property name in braces and preceding it with a dollar sign. This creates a tag such as the one shown here:

${name}

This tag is then replaced with the value of the specified property for the document.

All incoming property values are converted to strings of characters when referenced in a tag. The substr function provides a way to use only a portion of a value string. The substr function and parameters replace the property name in the tag and are written this way:

${substr(name, start[,end])}

Parameter	Description
name	The name of the parameter to substring.
start	The zero-based position of the first character to use.
end	The optional one-based position of the last character to use. The default is the end of the value.

For example, if an incoming property name is USER_ID and the value is user:John Doe, then the following tag produces the value John Doe:

${substr(USER_ID,5)}

Likewise, this tag becomes John when processed:

${substr(USER_ID,5,9)}

Date (time) values retain their type as a date when carried in parameters. When referenced as a template tag, however, the date is converted to a string. The default format of this conversion is influenced by the locale and date settings on the system running Documaker Connector.

Use this syntax to control the date and time format:

${name?string.dateformat[_timeformat]}

Parameter	Description
name	The name of the date parameter to format
xxxformat	Specify one of these options: short, medium, long, full, short_long, or long_short. short : 4/27/12 12:34 PM medium: Apr 27, 2012 12:34:56 PM long: April 27, 2012 12:34:56 PM EDT full: Friday, April 27, 2012 12:34:56 PM EDT short_long: 4/27/12 12:34:56 PM EDT long_short: April 27, 2012 12:34 PM

How everything looks exactly is affected by your local system settings. Instead of using the default formats, you can specify the exact format using the Java date format syntax for pattern:

${name?string(pattern)}

Here are some examples:

${myDate?string("yyyy-MM-dd HH:mm:ss zzzz")}

2012-04-27 12:34:56 Eastern Daylight Time

${myDate?string("EEE, MMM d, ''yy")}

Fri Apr 27, '12

${myDate?string("EEEE, MMMM dd, yyyy, hh:mm a '('zzz')'")}

Friday, April 27, 2012, 12:34 PM (EDT)

Documaker Connector uses an open source library called FreeMarker to provide much of the template functionality. For more information, see the FreeMarker documentation located at this website:

http://freemarker.sourceforge.net/docs/ref_builtins_date.html

Keep in mind you can only use the capabilities of the library that are supported by our implementation within Documaker Connector. For example, parameter values are all strings or dates. All other types are converted to strings.

FTP Destination Properties

You can use this destination component in a limited production environment or for debugging purposes. The FTP Destination configures an FTP site as the document destination. Documents are copied by batch to the receiving site as an archive.

Configure the use of the FTP Destination with:

destination.name=oracle.documaker.ecmconnector.ftpdestination. FTPDestination

Property	Description	Default
FTP Destination Properties.
.server	The FTP server name.	none
.username	The user name needed to log onto the FTP server.	none
.password	The password needed to log into the FTP server. You can encrypt the password using the ~ENCRYPT function.	none
.base.directory	The root directory on the FTP server where files should be copied.	none
server.protocol.type	Identifies the communication protocol, either FTP or Secure FTP (SFTP). Default value is "FTP".	none

Mock Destination Properties

Use these properties to set up a mock destination. A mock destination simply accepts the incoming documents and discards them. Use this destination to test your source configuration with test documents before your destination is ready to receive documents or to test without cluttering your destination system with test documents.

Developers building a custom source can use this destination to discard test data. You can also set this destination to generate random errors to test up-stream error processing while developing a custom source.

Configure the use of the Mock Destination with:

destination.name=oracle.documaker.ecmconnector.mockdestination. MockDestination

Property	Description	Default
Mock Destination Properties Property Name Prefix: destination.mock.
.import.errors	Specifies whether to generate random import errors.	False
.import.error.threshold	The threshold value above which an import error should be generated.	75 (out of 100)