CHECKIN_BYNAME Doc Services Core Oracle Content Server

4-18 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management

4.3.6 CHECKIN_ARCHIVE_NO_NOTIFY

A general checkin service used by client applications. It is generally used when the client application knows it will be checking in a large number of files and it does not want the indexer to be initiated by the check-in activity. NO_NOTIFY indicates that this service does not notify the Oracle Content Server subjects that are normally notified during a checkin. This service suppresses the Released Documents subject, which starts the indexer. The user of this service should notify the indexer subject to proceed to do work by calling the NOTIFY_INDEXER service. This service is not used by the archiver. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters For additional parameters, see CHECKIN_ARCHIVE . Optional Service Parameters For additional parameters, see CHECKIN_ARCHIVE . Example IdcService=CHECKIN_ARCHIVE_NO_NOTIFY Action=insert dDocAuthor=user1 dDocName=test dDocTitle=new content dSecurityGroup=Public primaryFile=c:test.txt doFileCopy=true

4.3.7 CHECKIN_BYNAME

Service that checks in a content item revision based on the content item name or Content ID. Location: IdcHomeDirresourcescoretemplatesstd_services.htm A user must have Admin permission to the content items security settings to change the security group dSecurityGroup, account dDocAccount, or author dDocAuthor. ■ If the content item 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 the content item is in a workflow, the user must be a reviewercontributor for the current step. ■ If metafile generation is enabled by setting the AllowPrimaryMetaFile or AllowAlternateMetaFile environment variables, or both and the metafile 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 a revision failing to insert or when the refinery was not successfully initiated. Core Oracle Content Server Services 4-19 To disallow the check in of empty files, set the following: ValidatePrimaryFileNotEmpty=1 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. – doFileCopy: 1 true: The file is not deleted from the hard drive after checkin. – 0 false: The file is removed from the hard drive after checkin. ■ Required custom fields: Custom metadata fields that are required must also be specified. Optional Service Parameters ■ dID: The generated content item revision ID. ■ 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. Important: Either the content item name or the content item revision ID must be specified. 4-20 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management ■ createAlternateMetaFile: To enable alternate metafile generation, the AllowAlternateMetaFile environment value must be true and the parameter createAlternateMetaFile must be true. ■ createPrimaryMetaFile: To enable primary metafile generation, the AllowPrimaryMetaFile environment value must be true and the parameter createPrimaryMetaFile must be true. ■ 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. ■ dExtension: The file extension such as hcsf, doc, txt. ■ dFormat: The formatting process used to create the web-viewable version of the content. For example, applicationhcsf or applicationdoc. ■ dInDate: The content release date. The date the content item is to be released to the Web. 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 content 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. ■ dPublishState: The publish state. If the content item exists in the system dPublishState must be empty. ■ dReleaseState: The release state used to indicate the Web state of the revision. ■ dRevClassID: The revision class ID. ■ dRevLabel: The revision label for the content item. If set, the label is used to locate the specified revision. ■ dWfType: The workflow type such as Basic or Criteria. ■ 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. ■ IsEditRev: If set to true, this entry checks if the content revision is in a workflow and enables editing. ■ IsWorkflowInfo: This is a configuration entry but can be specified as a parameter. If set to true, this entry checks for workflow information and checks allowable actions for the workflow steps. 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