CHECKIN_CONFIRM_FORM CHECKIN_LIST CHECKIN_NEW

Core Oracle Content Server Services 4-21 ■ webViewableFile: If a content item has a web-viewable file associated with it, the conversion format is the format of the web-viewable file the parameter webViewableFile:format and the extension is the web-viewable files extension 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 setting these additional parameters. ■ Optional custom fields: Custom metadata fields that are not required can also be specified. Example IdcService=CHECKIN_BYNAME dDocName=test1000 dSecurityGroup=public dDocAuthor=sysadmin dDocType=ADENG dDocTitle=another test doFileCopy=true primaryFile=c:test.txt

4.3.8 CHECKIN_CONFIRM_FORM

Service that returns confirmation upon successful checkin through a browser. Access Level: Write, Global, Scriptable 50 Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ dID: The content ID. ■ dDocAuthor: The document author. ■ dDocName: The document name. ■ dDocTitle: The document title. Results ■ Local Data: – dDocAuthor – dDocName – dDocTitle – dID ■ Response Template: CHECKIN_CONFIRM checkin_confirm.htm Used By ■ Redirect service for: CHECKIN_NEW, CHECKIN_SEL, CONTINUE_CHECKIN

4.3.9 CHECKIN_LIST

Service that returns a list of checked-out items those that are not checked in or deleted. The most likely error is when the checkout list cannot be retrieved from the database. Access Level: Write, Global, Scriptable 50 4-22 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management Queries Executed: QcheckinCachesForUser Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Optional Service Parameters ■ userOnly: When 1 true, returns only items checked out to the current user. ■ MaxQueryRows: Controls the number of items returned in the list. Results ■ Result Sets: – CHECKIN_LIST All Fields from Revisions and DocMeta for checked-out revisions. – CHECKIN_CACHES All Fields from DatedCaches. ■ Local Data: – copyAborted – DataSource ■ Response Template: CHECKIN_LIST checkin_list.htm Used By ■ Resource Includes: – pne_nav_management_links – std_doc_man_pages – checkin_multiuploadapplet_processing_functions ■ Standard Navigation: – commonNav.js – commonBundle.js ■ Other: – SoapCustom:Wsdl:CheckIn:Services – Redirect service for: DELETE_CHECKIN_CACHE

4.3.10 CHECKIN_NEW

Service that checks in a new content item. This service calls the CHECKIN_NEW_SUB subservice. Access Level: Write 2 Location: IdcHomeDirresourcescoretemplatesstd_services.htm ■ If you attempt to set the author dDocAuthor to someone other than the currently logged in user, you must have Admin permission to the security attributes being assigned to the document. ■ If the content uses entity security, the user must have at least Write permission granted by the entities, unless the user has Admin rights to the security group being assigned to the document. ■ If metafile generation is enabled by setting the AllowPrimaryMetaFile or AllowAlternateMetaFile environment variables, or both and the metafile Core Oracle Content Server Services 4-23 generation variables createPrimaryMetaFile and createAlternateMetaFile are true, a real file cannot be associated with the current content item. Only one metafile can be associated with a content item: if createPrimaryMetaFile is true, createAlternateMetaFile must be false and vice-versa. ■ The most likely error is when the content item was not properly defined. ■ This service executes the subservice CHECKIN_NEW_SUB. This subservice checks in a new content item revision. ■ 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 system. ■ To disallow the checkin of empty files, set the following: ValidatePrimaryFileNotEmpty=1 Required additional parameter metadata checkin: createPrimaryMetaFile=true Required Oracle Content Server configuration entry metadata checkin: AllowPrimaryMetaFile=true Additional Required Service Parameters ■ 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 overrides 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. ■ dDocType: The content item Type. ■ dSecurityGroup: The security group such as Public or Secure. ■ dDocAccount: The account for the content item. Required only if accounts are enabled. ■ 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 converts the alternate file. Otherwise, the primary file is converted. – If a primary file is not specified, you can use a metafile in its place. Only one metafile can exist 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. – Required custom fields: Custom metadata fields that are required must also be specified. 4-24 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management Optional Service Parameters ■ alternateFile: The alternate file for conversion. – Only one metafile can exist 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 converts the alternate file. Otherwise, the primary file is converted. ■ AutoNumberPrefix: This is a configuration entry but can be specified as a parameter. The auto prefix script is evaluated after the revision class ID is generated and before metadata validation. ■ createAlternateMetaFile: To enable alternate metafile generation, the AllowAlternateMetaFile environment value must be set to true and the parameter createAlternateMetaFile must be set to true. ■ createPrimaryMetaFile: To enable primary metafile generation, the AllowPrimaryMetaFile environment value must be true and the parameter createPrimaryMetaFile must be set to true. ■ DirectReleaseNewCheckinDoc: Directs content items being checked in to bypass Inbound Refinery, workflow, and indexing. The default is 0. To enable, set DirectReleaseNewCheckinDoc=1 . This parameter can be used to support a high ingestion rate when transferring content items from an external repository into Content Server storage. Because this setting increases the speed of content checkin, it increases the number of check-ins that Content Server can support at a time. This capability is highly desirable in applications for example, scanning applications where large numbers of items are expected to be checked in at once. Before you enable this setting, take into account the following important considerations. – A content item checked in this way can only be found by searching with DATABASE.METADATA. However, other content items can still go through regular checkin and be FULLTEXT indexed. – A rebuild of the index does not cause content checked in with this parameter to go through indexing. – Content modification updating or checking in a new revision causes indexing to occur on a document checked in with this parameter. ■ dConversion: The conversion algorithm is determined by this parameter. If the conversion type is not Passthru or NoConversion default value and the content is not web-viewable or has a publish state, the content gets added to the queue to get converted. Otherwise, the server looks for the web-viewable if applicable and the vault file and updates the processing state to say that the file has already been converted. If the file mime-type is applicationFDF, the server sets the conversion to exchange-fdf. ■ dCreateDate: The date the content item was created. By default, this is the current date. ■ dFormat: The formatting process used to create the web-viewable version of the content item. For example, applicationhcsf or applicationdoc. Core Oracle Content Server Services 4-25 ■ dInDate: The release date. By default, this is the current date. If the content release date dInDate is not specified, the creation date dCreateDate is used. This value is auto generated if it is not supplied. ■ dOutDate: The expiration date. By default, this is blank and does not specify an expiration date. If the content expiration date dOutDate is not entered, the value remains empty. This is a valid state. ■ dRendition: Used to specify an additional rendition of the content item. ■ dRevClassID: The revision class ID. ■ dRevisionLabel: The revision label for the content item. If set, the label is used to locate the specified revision. ■ IsAutoNumber: This is a configuration entry but can be specified as a parameter. If the configuration variable IsAutoNumber is set to true, the Content ID dDocName is generated by concatenating the auto prefix with the revision class ID dRevClassID, the counter of uniquely differentiated content items, pre-filled with leading zeroes to be six digits long. Auto numbering is not performed if the Content ID dDocName is already specified. ■ webViewableFile: If a content item has a web-viewable file associated with it, the conversion format is the format of the web-viewable file the parameter webViewableFile:format and the extension is the web-viewable files extension 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 setting these additional parameters. ■ Optional custom fields: Custom metadata fields that are not required can also be specified. Results ■ Local Data: – dAction – dActionDate – dClbraName – dConversion If refinery-processes, contains information about what conversion occurred. – dCreateDate – dDocAccount – dDocAuthor – dDocID – dDocName – dDocTitle – dDocType – dExtension – dFileSize – dFormat – dID: Internal reference to ID for the new content item. 4-26 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management – dInDate – dIsWebFormat – dIsPrimary – dLocation – dOriginalName – dOutDate – dpAction – dpEvent – dProcessingState – dPublishState – dPublishType – dRawDocID – dReleaseState – dRevClassID – dRevisionID – dRevLabel – dRevRank – dSecurityGroup – dStatus – dUser – dWorkflowState – isDocProfileUsed – isEditMode – isNew – isStatusChanged – prevReleaseState – primaryFile – StatusCode – StatusMessage – VaultfilePath – WebfilePath – xClbraAliasList – xClbraUserList – Plus any custom metadata related to the item checked in ■ Response Templates: – REDIRECT_TEMPLATE redirect_template.htm – Default redirect service: CHECKIN_CONFIRM_FORM Core Oracle Content Server Services 4-27 Used By ■ Resource Includes: std_doc_page_definitions Example IdcService=CHECKIN_NEW dDocName=test1111 dDocTitle=test information dDocAuthor=john dSecurityGroup=public primaryFile=c:test.txt doFileCopy=1

4.3.11 CHECKIN_NEW_FORM