Oracle WebCenter Content Document Transfer Utility - Oracle Fusion Applications 11g

DownloadTool Program Options (for FA)
-------------------------------------

--url               Content Server Protocol-Specific Connection URL
--username          Username to leverage
--password          Password supplied on command-line
--passwordFile      Password read from text file on first line
--policy            JAX/WS Client Policy - e.g. oracle/wss_username_token_over_ssl_client_policy

--dID               ID uniquely identifying a specific revision of a content item to download; ID is unique across repository

Alternatively, provide dDocName and RevisionSelectionMethod to identify the dID to leverage

--dDocName          ID identifying a content item; multiple revisions of a doc can share the same dDocName value - but otherwise it is unique;
--RevisionSelectionMethod Which revision to download; Valid values: Latest / LatestReleased.  Defaults to Latest

--outputFile        Output/Destination local file to write; if not provided dOriginalName of file provided at checkin time is utilized.

Notes:
A content item is comprised of one or more revisions of a file.
Revisions of a content item share the same dDocName value.
Every revision in the system has a unique dID value allowing direct access.

To download a specific revision of a content item, specify the unique dID identifier.
To download the latest (or latest released) revision of a content item, specify a dDocName value and a revision selection method.


UploadTool Program Options (for FA)
-----------------------------------

--url               Content Server Protocol-Specific Connection URL
--username          Username to leverage
--password          Password supplied on command-line
--passwordFile      Password read from text file on first line
--policy            JAX/WS Client Policy - e.g. oracle/wss_username_token_over_ssl_client_policy

--primaryFile       Fully-qualified path of local primary file to upload

--dDocAccount       Destination Security Account

--dDocTitle         Document Title

--dDocName          If wanting to version an existing document - provide existing document's dDocName value
--checkout          Perform checkout first if adding a new revision [true/false(default)]
----ignoreCheckoutErrorNeg22 ignore error -22 when performing a checkout. This indicates the user has already checked-out the document. [true(default)/false]

Notes:
A content item is comprised of one or more revisions of a file.
Revisions of a content item share the same dDocName value.
Every revision in the system has a unique dID value allowing direct access.

When creating a new content item, system generated dDocName and dID values will be returned.
To add a version/revision to an existing content item, specify --dDocName when performing the checkin.
Note that the existing content item must be checked out in order to add a new revision.


SearchTool Program Options (for FA)
-----------------------------------

--url               Content Server Protocol-Specific Connection URL
--username          Username to leverage
--password          Password supplied on command-line
--passwordFile      Password read from text file on first line
--policy            JAX/WS Client Policy - e.g. oracle/wss_username_token_over_ssl_client_policy

--allDocs           Search all documents including old revisions [true/false(default)]; By default we search only the latest released

--dID               field expression - Search on unique id (number)
--dDocName          field expression - Search on content item identifier (string)
--dDocTitle         field expression - Search on document title (string)

--QueryText         Explicit query text to invoke to locate documents
--SearchQueryFormat Format the supplied search query text was provided in; defaults to UNIVERSAL

--SortField         Sort search query results based on the specified metadata field
--SortOrder         The sort order: ASC (ascending) / DESC (descending); defaults to ASC
--SortSpec          Sort search query results based on multiple criteria using the specified custom ORDER BY

--StartRow          The row to begin the search results display (after having applied any sort); defaults to 1
--EndRow            The row to end the search results display
--ResultCount       Maximum number of search results to return to client; defaults to 20
                    See notes below regarding the upper limit for this setting.

--defaultFields     Output core metadata fields (dID, dDocName, dDocTitle, dDocLastModifiedDate, dDocLastModifier) [true(default)/false]
--moreFields        Output a more detailed set of metadata fields (fields above plus dOriginalName, VaultFileSize etc) [true/false(default)]
--fields            User-specified fields to render e.g. --fields=dID,dOriginalName,VaultFileSize --delimiter=, --defaultFields=false

Notes:
The tool accepts either a full --QueryText query string from the caller, or will dynamically synthesize one by ANDing together
individual field search expressions (dID/dDocName/etc) supplied as program options.

Standard search configuration employed by the server limits the maximum number of results that can be returned in a search.
For DATABASE.METADATA and DATABASE.FULLTEXT engines, this is 10000 items, and for the ORACLETEXTSEARCH engine, 2000 items.

See Advanced SearchTool Program Options for information on available query operators, additional search field expressions and formatting of output data.


StorageTool Program Options (for FA)
------------------------------------

--url               Content Server Protocol-Specific Connection URL
--username          Username to leverage
--password          Password supplied on command-line
--passwordFile      Password read from text file on first line
--policy            JAX/WS Client Policy - e.g. oracle/wss_username_token_over_ssl_client_policy

--dryRun            Candidates for storage rule switch are identified but no actual migration to securefile is performed. [true(default)/false]
                    
--abortOnFirstFailure  Abort the migration process should an individual document migration fail [true/false(default)]

--reindex           Documents migrated should be completely reindexed [true/false(default)]

--allDocs           Old revisions of documents should be included in the search for candidate documents [true(default)/false]

--ResultCount       Maximum number of candidate documents to identify for storage rule switch for this invocation of the tool.
                    e.g. --ResultCount=100 will throttle the tool and restrict candidate documents to a maximum of 100.
                    See SearchTool notes above regarding the upper limit for this setting.

Notes:
This tool works by first invoking a search for candidate documents, followed by iterating through the results and individually triggering on each
document the storage rule switch. The server-imposed limit on maximum number of results that can be returned in a search consequently applies.

Documents will not actually be migrated to securefile storage unless --dryRun=false is specified.

Should a specific document fail migration, documents migrated prior to the failure remain migrated regardless of the --abortOnFirstFailure setting.

Unless otherwise recommended by Oracle, reindex should be set to false (or not provided) - meaning document should bypass refinery and indexer stages.

--socketTimeout     Override socket timeout (value is specified in seconds)

--proxyHost         HTTP[S] proxy host
--proxyPort         HTTP[S] proxy port number

--nonProxyHosts     No-proxy pattern defining hosts to which the proxy should not be applied - e.g. login.acme.com|*.internal.acme.com

--proxyUsername     Username (if applicable) for authenticating with the proxy
--proxyPassword     Password supplied on command-line for authenticating with the proxy
--proxyPasswordFile Password read from text file on first line for authenticating with the proxy

--version           Print out tool revision/version

--ping              Perform PING_SERVER test to validate connection URL and credentials

--verbose           Verbose Output - log full Request/Response DataBinders
--quiet             Minimal Log Output
--silent            Log Messages Silenced

--log_file_name     Send program output to specified log file (rather than System.out)
--log_file_append   When value is true, log file is appended versus overwritten.

--simpleRIDCLogging RIDC debug messages are logged to the console

Common to all tools:

--properties        Obtain program options from a properties file in classpath at the specified package-qualifed resource location
--propertiesFile    Obtain program options from a properties file at the specified file-path

Advanced DownloadTool Program Options
-------------------------------------

--outputDir         Can be leveraged in place of --outputFile to stream contents to a local file in specified output directory using dOriginalName provided at checkin time as the file name.
--md5               Return an MD5 message-digest of the downloaded stream as a 32 digit hexadecimal; --md5lowercase/--md5uppercase options are supported.
--md5Only           Whether to only perform MD5 operation without saving download stream to file system [true/false]
--rendition         Specify rendition to download: Primary / Web / Alternative

It is possible to include up to 10 custom key/value pairs in the service request binder provided to WebCenter Content using the following technique:
--k0                Custom binder metadata key - supplied to GET_FILE / DOC_INFO / DOC_INFO_BY_NAME
--v0                Custom binder metadata value associated with key (k0) above; e.g. --k0=XFND_EXPIRES --v0=1393231938509
...                 k1,v1,k2,v2,k3,v3,...
--k9                Custom binder metadata key; e.g. --k9=XFND_RANDOM
--v9                Custom binder metadata value associated with key (k9) above; e.g. --v9=8675309


Advanced UploadTool Program Options
-----------------------------------

--progressBar       (RIDC-based tool only) Present a progress bar showing upload progress

--primaryFileName   dOriginalName of primary file; If not specified defaults to filename of local source file being uploaded
--primaryContentType Content type of primary file; If not specified defaults to application/octet-stream

--dSecurityGroup    Destination Security Group; For FA import/export use-cases this is set by default to FAFusionImportExport
--dDocType          Destination Doc Type: Application / Binary / Document / System

--generateAlternate  A small text file is checked in as the "alternate" file alerting the user to consult the native/primary file. [true/false]; For FA import/export this defaults to true.
                    Enabling this option will significantly reduce post-processing checkin time should no rendition of the primary file be required.

--alternateFile     Fully-qualified path of local alternate file to upload; The file extension of the alternate file cannot be the same as that of the primary file.

--directory         Upload all files from the specified local directory
--threads           Number of concurrent upload worker threads to leverage when uploading files from a local directory
--throwOnThreadException whether in the event any task fails, the tool throws an exception at completion [true(default)/false]
                    Setting --throwOnThreadException=false can be useful in programmatic situations for processing UploadResults maps.

--Tool.AccountRequired Must a dDocAccount (Document Account) be specified at checkin [true/false]; For FA import/export this is intentionally set to true.

--Tool.AccountTransformed Should supplied account value be transformed [true/false]; For FA import/export this defaults to true.
                    When enabled, an input account value like "ACME/sales" is transformed to "ACME$/sales$"

It is possible to include up to 10 custom key/value pairs in the service request binder provided to WebCenter Content using the following technique:
--k0                Custom binder metadata key - supplied to CHECKIN_UNIVERSAL
--v0                Custom binder metadata value associated with key (k0) above; e.g. --k0=xComments --v0="Some Comments"
...                 k1,v1,k2,v2,k3,v3,...
--k9                Custom binder metadata key; e.g. --k9=dInDate
--v9                Custom binder metadata value associated with key (k9) above; e.g. --v9="2014-05-30 10:30:05Z"


Advanced SearchTool Program Options
-----------------------------------
As an alternate to --QueryText, one or more field search expressions can be provided:

--dID               Search on document id (number)
--dDocName          Search on document content name (string)
--dDocTitle         Search on document title (string)
--dOriginalName     Search on document original name /filename (string)
--dExtension        Search on document extension (string)
--xComments         Search on document comments field (string)

--dFileSize         Search on file size (number)

--dDocCreatedDate   Search on document create date (date)
--dDocLastModifiedDate Search on document last modified date (date)
--dInDate           Search on document release date (date)

--dSecurityGroup    Search on document security group (string)
--dDocAccount       Search on document account (string)

--dDocType          Search on document type (string)
--dFormat           Search on document format (string)

--dDocCreator       Search on document creator (string)
--dDocLastModifier  Search on document last modifier - revision specific (string)
--dDocAuthor        Search on document author - revision specific (string)

--dRevisionID       Search on document revision id (number); likely requires --allDocs option be set

--xStorageRule      Search on document storage rule (string)

--xCollectionID     Search on document stored in specified Folders_g collection


Supported operators for number fields: =, <=, >=, !=
Supported operators for string fields: =, !=, %=, !%=, ^=, $= 
Supported operators for date fields: <=, >=

Examples: 
--dID=5          : dID equals 5
--dID!=50        : dID not equal to 50
--dID<=100       : dID less than or equals 100
--dID>=100       : dID greater than or equals 100
--dDocName=FA123 : dDocName matches FA123
--dDocName^=FA   : dDocName starts with FA
--dDocName$=23   : dDocName ends with 23
--dDocName%=123  : dDocName contains substring 123
--dDocName!%=789 : dDocName does not contain substring 789
--dDocName!=FAFA : dDocName does not match FAFA
--dInDate>=2013-12-22 11:17:44Z : dates passed are always in iso8601 format with client time zone set to UTC


--collectionPath    Search for documents present in the Folders_g collection with the specified xCollectionPath; e.g. /Contribution Folders/CRM
                    The collection associated with the specified path is retrieved and its collection id is subsequently supplied to the ensuing search by way of an xCollectionID expression.

Formatting options:
--padData           whether to pad/crop search result data [true(default)/false] - applies to both field headers and the field values.
--writeFieldHeading write field headings out prior to the actual search results [true(default)/false]
--writeFieldNames   prefix each output search field with its field name [true/false(default)]

--delimiter         the delimiter string to output between each search result field (and field header)

--writeRowPrefix    whether to output row prefix string at the start of each row of results [true/false(default)]
--rowprefix         the string to output at the start of each row of results when writeRowPrefix flag is set

--writeRowSuffix    whether to output row suffix string at the end of each row of results [true/false(default)]
--rowsuffix         the string to output at the end of each row of results when writeRowSuffix flag is set

--fields            user supplied output fields to render; The --defaultFields is by default enabled which results in core fields always getting rendered;
                    If the caller specifies --defaultFields=false (and --moreFields=false), then only the fields listed in the --fields property will get output;
                    If on the other hand the default fields are set to render, fields listed in the --fields property augment/override the default included fields.
                    Fields are typically specified in the format dID,dDocName etc; they can also optionally include left/right pad information which is used when --padData is enabled.
                    e.g. dID#r10,dDocName#l30  means to right pad dID so that it is 10 characters in size, left pad 30 dDocName etc

--writeCounts       whether to output search result set size and total rows count matched by the query [true(default)/false]

--triggerRowsCount  whether the server should perform a count(*) query so as to accurately populate the total rows count [true(default)/false]

Advanced StorageTool Program Options
------------------------------------

--QueryText         An explicit query to invoke to locate candidate documents for storage migration
                    If no query text is supplied, the tool defaults to finding documents that don't match the target storage rule
--SearchQueryFormat Format the supplied search query text was provided in; defaults to UNIVERSAL

--SortField         Sort search query results based on the specified metadata field
--SortOrder         The sort order: ASC (ascending) / DESC (descending); defaults to ASC
--SortSpec          Sort search query results based on multiple criteria using the specified custom ORDER BY

--StartRow          The row to begin the search results display (after having applied any sort); defaults to 1
--EndRow            The row to end the search results display

--targetRule        Target storage rule; For FA this is intentionally set to FusionStorageRule.

As an alternate to --QueryText, one or more field search expressions can be provided:

--dID               Search on document id (number)
--dDocName          Search on document content name (string)
--dSecurityGroup    Search on document security group (string)
--dDocCreatedDate   Search on document create date (date)
--dDocLastModifiedDate Search on document last modified date (date)
--dInDate           Search on document release date (date)
--dFileSize         Search on file size (number)
--xStorageRule      Search on document storage rule (string)

Supported operators for number fields: =, <=, >=, !=
Supported operators for string fields: =, !=, %=, !%=, ^=, $= 
Supported operators for date fields: <=, >=

Examples: 
--dID=5          : dID equals 5
--dID!=50        : dID not equal to 50
--dID<=100       : dID less than or equals 100
--dID>=100       : dID greater than or equals 100
--dDocName=FA123 : dDocName matches FA123
--dDocName^=FA   : dDocName starts with FA
--dDocName$=23   : dDocName ends with 23
--dDocName%=123  : dDocName contains substring 123
--dDocName!%=789 : dDocName does not contain substring 789
--dDocName!=FAFA : dDocName does not match FAFA
--dInDate>=2013-12-22 11:17:44Z : dates passed are always in iso8601 format with client time zone set to UTC