CANCEL_ARCHIVE CHECKIN_ARCHIVE

Archive Services 6-5 Example IdcService=ADD_COLLECTION IDC_Name=new_collection aCollectionLocation=c:oraclearchives aVaultDir=c:oraclevalue aWeblayoutDir=c:oracleweblayout

6.2.3 ADD_PROXIEDCOLLECTION

Service used to add an archive collection from another server. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ psIDC_Name: The name of the provider proxied connection. ■ IDC_Name: The name of the archive collection.

6.2.4 CANCEL_ARCHIVE

Service that cancels the current archive request. Location: IdcHomeDirresourcescoretemplatesstd_services.htm

6.2.5 CHECKIN_ARCHIVE

Service that checks a content item revision into an archive. Access Level: Admin 8 Location: IdcHomeDirresourcescoretemplatesstd_services.htm ■ This service executes one of the following subservices, based on parameters and conditional variables: – DELETE_BYREV: If the Action parameter is Delete and the content item revision exists in the system. – DELETE_BYCLASS: If the Action parameter is Delete and the content item revision does not exist in the system. – CHECKIN_NEW_SUB: If the content item does not exist in the system, the Action parameter is not Delete, and the conditional variable IsPublish is set to true. – INSERT_NEW: If the content item does not exist in the system, the Action parameter is not Delete, and the conditional variable IsPublish is set to false or not specified. – UPDATE_DOCINFO_BYREV: If the Action parameter is not Delete and the primaryFile parameter is not empty. Additionally, the conditional variable IsPublish must be true or the content item revision must exist in the system. – UPDATE_BYREV: If the Action parameter is not Delete and the primaryFile parameter is empty. Additionally, the conditional variable IsPublish must be true or the content item revision must exist in the system. Important: The IsPublish variable is set by the server when a workflow or project is unregistered. This value cannot be set as a parameter or as a configuration entry in this service. 6-6 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management ■ If the IsNative parameter is true, the service executes one of the following subservices: – DELETE_BYREV: If the content item exists in the Revisions table and Action parameter is Delete. – UPDATE_BYREV: If the content item exists in the Revisions table, the content has not been deleted, and the Action parameter is Update. – INSERT_NATIVE: If the content item does not exist in the server and the action parameter is not Delete. ■ If a content item already exists in the system and has not been deleted, the server cannot update or insert the entry; an error will be thrown. ■ The most likely error is when the content item name is not unique or when the service is unable to check in the specified file. ■ A primary file is required. If you do not want to check in a primary file and want to check in only metadata, an additional parameter must be included and a configuration entry added in the Oracle Content Server instance. ■ Required additional parameter metadata checkin: createPrimaryMetaFile=true ■ Required Oracle Content Server configuration entry metadata checkin: AllowPrimaryMetaFile=true Example: IdcService=CHECKIN_ARCHIVE Action=insert dDocTitle=my_test dDocAuthor=sysadmin dDocType=ADACCT dSecurityGroup=Public createPrimaryMetaFile=true Additional Required Service Parameters ■ Action: Must be set to a value as specified earlier. ■ dDocName: The Content ID for the content item. – If Content ID auto generation is enabled, this parameter is not required. If dDocName is defined, it will override the auto generated Content ID. – The Content ID cannot contain spaces or invalid characters ; \?:=+~|[ ]. ■ dDocAuthor: The content item author contributor. ■ dDocTitle: The content item title. ■ dSecurityGroup: The security group such as Public or Secure. ■ dDocAccount: The account for the content item. Required only if accounts are enabled. Archive Services 6-7 ■ primaryFile: The absolute path to the location of the file as seen from the server. Use the slash as the file separator. A primary file must be specified unless checking in metadata only. If an alternate file is specified with the primary file, the content refinery will convert the alternate file. Otherwise, the primary file will be converted. – If a primary file is not specified, you can use a metafile in its place. Only one metafile can exist though for each content item a primary AND alternate meta file cannot coexist. – If both a primary and alternate file is specified, their extensions must be different. – doFileCopy: 1 true: The file will not be deleted from the hard drive after checkin. 0 false: The file will be removed from your hard drive after checkin. ■ Required custom fields: Custom metadata fields that are required must also be specified. Optional Service Parameters ■ alternateFile: The alternate file for conversion. – Only one metafile can exist though for each content item a primary AND alternate meta file cannot coexist. – If an alternate file is specified with the primary file, the content refinery will convert the alternate file. Otherwise, the primary file will be converted. ■ dCreateDate: The date the content item was created. By default, this is the current date. ■ dRevLabel: The revision label for the content item. If set, the label will be used to locate the specified revision. ■ doDocSecurityCheck: Enables the document security check. By default this entry is false. ■ dPublishState: The publish state. If the content item exists in the system, this parameter must be empty. ■ dReleaseState: The release state used to indicate the web state of the revision. ■ IsNative: This is a configuration entry but can be specified as a parameter. – If the IsNative parameter is true and the content item exists in the system, the specified Content ID dDocName must coincide with the content name in the database. Otherwise, the command is not native and the service will be determined as if the IsNative parameter is false. – If the IsNative parameter is true and the Action parameter is Delete, the content item must exist in the system. Otherwise, the command is not native and the service will be determined as if the IsNative parameter is false. ■ webViewableFile: If the content is marked as web-viewable the file format is determined by the parameter webViewableFile:format and the extension is determined by the parameter dWebExtension. Otherwise, the extension and file format are determined by the parameters dExtension and dFormat, respectively. The user can override the file format and extension by overriding these parameters. ■ Optional custom fields: Custom metadata fields that are not required can also be specified. 6-8 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management Results ■ Local Data: – Action – dRevClassID – dRevisionID, – dRendition2 – dRendition1 – dDocAuthor – DocExists – isCheckin – StatusMessage – primaryFile – dStatus – dRevLabel – dWorkflowState – dDocTitle – StatusCode – dpEvent – isNew – dUser – isEditMode – dDocName Used By ■ Applets: Batch Loader Example IdcService=CHECKIN_ARCHIVE Action=insert dDocAuthor=user1 dDocName=test dDocTitle=new content dSecurityGroup=Public primaryFile=c:test.txt doFileCopy=true Archive Services 6-9

6.2.6 COPY_ARCHIVE