EDIT_TRANSFEROPTIONS EXECUTE_BATCH EXPORT_ARCHIVE

Archive Services 6-11

6.2.12 EDIT_ARCHIVEDATA

Service used to edit the data as specified in the EditItems parameter. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ EditItems: A comma-delimited list of keys that are used to define the archive. Any key used must also be specified as a parameter. For example, if EditItems=aValueMaps, then aValueMaps is a required parameter to this service. ■ KeyValue: Value for key in the EditItem parameter. ■ IDC_Name: The name of the collection. If you are using the default collection, this is the name of the Oracle Content Server instance. Example IdcService=EDIT_ARCHIVEDATA IDC_Name=Master_on_server01

6.2.13 EDIT_EXPORTERS

Service that edits the archive data for the specified archive. If specified, it registers or unregisters the archive. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ EditItems: The only values accepted are aIsAutomatedExport and aRegisteredExporters. By setting EditItems, these parameters are also required: – aIsAutomatedExport – aRegisteredExporters

6.2.14 EDIT_TRANSFEROPTIONS

Service used to edit transfer options for an archive process. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ IDC_Name: The name of the collection. If you are using the default collection, this is the name of the Oracle Content Server instance. Important: Most archive services use the underlying method used by EDIT_ARCHIVEDATA and consequently require the EditItems parameter set to the appropriate value. The user interface usually controls what is put into this parameter. If necessary, the user should exercise these services through the user interface with Filter Debug flags enabled to determine how the values should be set. By using the Filter Debug flags, the request as it is sent to the server can be captured. 6-12 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management

6.2.15 EXECUTE_BATCH

Service that executes a batch operation for an archive. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ aBatchFile: The path and name of the batch file to be executed.

6.2.16 EXPORT_ARCHIVE

Service that exports an archive. ■ The export will read in the archives definition file and will follow the export rules specified. This includes specifying the export query, whether users or document configuration information should be exported or both, and whether previous batch files should be deleted. ■ The Oracle Content Server system executes this service asynchronously. The server must be running for the services to be even executed and that IdcCommand will exit announcing success, when actually all it has done is told the server to perform the action. ■ The Oracle Content Server system can only export archives one at a time. A batch file that has multiple exports will declare success on the first and failure on all subsequent commands until it has finished the first. A batch file should have only one export in it, and some external process will need to determine that the action has completed before issuing another export command. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ IDC_Name: The name of the collection. If you are using the default collection, this is the name of the Oracle Content Server instance. ■ aArchiveName: The archive name. ■ dataSource: Must be set to RevisionIDs. This is the query stub which, along with the export query, will be used to create the list of revisions to export. Optional Service Parameters ■ aDoDelete: – 1 true: Revisions are deleted after successful export. – 0 false: Revisions are not deleted after export. Note: The EXPORT_ARCHIVE service only starts the archive export and provides confirmation that the request to start the export has been made. No notification is sent regarding the status or completion of the archive export. A custom component could be created to provide notification of the status and completion of the archive export. Archive Services 6-13 Example ■ IdcCommand command file format exports the archive archive_test in the collection Master_on_server01: To export an archive IdcService=EXPORT_ARCHIVE aArchiveName=archive_test IDC_Name=Master_on_server01 dataSource=RevisionIDs ■ HDA format with optional parameter: Properties LocalData IdcService=EXPORT_ARCHIVE aArchiveName=archive_test IDC_Name=Master_on_server01 dataSource=RevisionIDs aDoDelete=1 end

6.2.17 GET_ARCHIVECOLLECTIONS