1. Implementing Applications
  2. Document Transfer Utility

Document Transfer Utility

The WebCenter Content Document Transfer Utility for Oracle Fusion Applications is a feature-set Java library that provides programmatic access to the content repository.

Use the utility to import and export documents, such as import files that contain external data that you want to load into interface and application tables.

The library includes:

  • Oracle WebCenter Content client command line tool

  • Oracle WebCenter Content remote intradoc client (RIDC)

  • Oracle HTTPClient

  • Oracle Fusion Applications branding and defaults

Options for the WebCenter Content Document Transfer Utility for Oracle Fusion Applications fall into these categories:

  • DownloadTool program options

  • UploadTool program options

  • Debugging and silent invocation options

DownloadTool Program Options

This table describes the download tool program options:

Option

Description

url

Protocol-specific connection URL of content server

user name

User name to leverage

password

Password, supplied in command line

passwordFile

Password, supplied in text file on the first line of the file

dID

ID of document revision to download

dID is unique across repository

dID changes with each revision

Note: Alternatively, specify the dDocName and RevisionSelectionMethod to identify the dID to leverage.

dDocName

Content name

Multiple revisions of a document can share the same dDocName value, otherwise it is unique.

Note: You should also provide RevisionSelectionMethod value.

RevisionSelectionMethod

Revision to download

Valid values: Latest, LatestReleased

Default value: Latest

outputFile

Path and name of local file to write

Here you see a sample download invocation command:

java -classpath "oracle.ucm.fa_client_11.1.1.jar" oracle.ucm.client.DownloadTool
url=http://ucmserver.com:16200/cs/idcplg username=weblogic password=we1com3i 
dID=21537 outputFile="/tmp/output.doc"

Here you see sample output:

Oracle WebCenter Content Document Transfer Utility
Oracle Fusion Applications
Copyright (c) 2013, Oracle.  All rights reserved.
Performing download (GET_FILE) ...
Download successful.

UploadTool Program Options

This table describes the upload tool program options:

Option

Description

url

Protocol-specific connection URL of content server

username

User name to leverage

password

Password, supplied in command-line

passwordFile

Password, supplied in text file on the first line of the file

primaryFile

Fully-qualified path of local primary file to upload

dDocAccount

Destination account

dDocTitle

Document title

checkout

If uploading a document revision, check out the document from the repository before uploading the revision

Valid values: true, false

Default value: false

ignoreCheckoutErrorNeg22

Ignore error -22 (user has already checked-out the document) when checking-out the document.

Valid values: true, false

Default value: true

Here you see a sample upload invocation command:

java -classpath "oracle.ucm.fa_client_11.1.1.jar" oracle.ucm.client.UploadTool 
url=http://ucmserver.com:16200/cs/idcplg username=weblogic password=we1com3i 
primaryFile="/tmp/resume.doc" dDocTitle="Resume of MSMITH" -dDocAccount=/acme/sales

Here you see sample output:

Oracle WebCenter Content Document Transfer Utility
Oracle Fusion Applications
Copyright (c) 2013, Oracle.  All rights reserved.
Performing upload (CHECKIN_UNIVERSAL) ...
Upload successful.
[dID=21537 | dDocName=UCMFA021487]

Debugging and Silent Invocation Options

This table describes the usable options which are common to all tools.

Option

Description

verbose

Verbose output

Log filled with Request/Response DataBinders

quiet

Minimal output

version

Print tool revision or version

log_file_name

Send program output to specified log file instead of the System.out log file

log_file_append

Append log to existing log file rather than overwrite it

Valid values: true, false

Default value: false

socketTimeout

Override time out of socket

Specify override time in seconds

You can use the tools to test the connection. Provide only the url, user name, and password as you see in this sample test:

java -classpath "oracle.ucm.fa_client_11.1.1.jar" oracle.ucm.client.DownloadTool 
url=http://ucmserver.com:16200/cs/idcplg username=weblogic password=we1com3i

Here you see the sample output:

Oracle WebCenter Content Document Transfer Utility
Oracle Fusion Applications
Copyright (c) 2013, Oracle.  All rights reserved.
Performing connection test (PING_SERVER) ...
Connection test successful.

Related Topics