Core Oracle Content Server Services 4-29
– dpEvent
– dProcessingState
– dPublishState
– dPublishType
– dRawDocID
– dReleaseState
– dRevClassID
– dRevisionID
– dRevLabel
– dRevRank
– dSecurityGroup
– dStatus
– dUser
– dWorkflowState
– isDocProfileUsed
– isEditMode
– isNew
– isStatusChanged
– prevReleaseState
– primaryFile
– StatusCode
– StatusMessage
– VaultfilePath
– xClbraAliasList
– xClbraUserList
– WebfilePath
– Plus any custom metadata related to the item checked in
Used By
■
Services: CHECKIN_NEW
4.3.13 CHECKIN_SEL
Service that checks in a revision to an existing content item. This calls the CHECKIN_ SEL_SUB subservice.
Access Level: Write 2 Location: IdcHomeDirresourcescoretemplatesstd_services.htm
■
The content item must be checked out for this service to execute.
■
If the content item is in a workflow, the user must be a reviewercontributor for the current step.
4-30 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management
■
A user must have Admin permission to the content items security settings to change the security group dSecurityGroup, account dDocAccount, or author
dDocAuthor.
■
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 content item cannot be in the published state.
■
The current user must be the Author of the content item or have Admin permission to check in a revision.
■
The most likely error is when the content item is no longer in the system.
■
This service executes the subservice CHECKIN_SEL_SUB. This subservice checks in a revision to a content item.
■
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.
■
dID: The generated content item revision ID.
■
dRevLabel: The content item revision label.
■
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.
Core Oracle Content Server Services 4-31
■
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 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.
■
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 set to true and the parameter
createPrimaryMetaFile must be set to true.
■
dConversion: The conversion algorithm is determined by the parameter dConversion.
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. 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.
■
dRevClassID: The revision class ID.
■
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.
■
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.
4-32 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management
■
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.
■
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.
■
RedirectUrl: Used to display another page after a topic file has been changed. If omitted, the user is redirected to the Oracle Content Server home page.
■
Optional custom fields: Custom metadata fields that are not required can also be specified.
■
Results
■
Local Data:
– dConversion: If refinery-processed, this contains information about what
conversion occurred.
– dID: Internal reference ID for the new content item.
– IsWorkflow: Returns 1 true if item entered workflow upon checkin.
■
Response Templates:
– REDIRECT_TEMPLATE redirect_template.htm
– Default redirect service: CHECKIN_CONFIRM_FORM
Used By
■
Resource Includes: std_doc_page_definitions
Example
IdcService=CHECKIN_SEL dDocName=test_000036
dDocTitle=my test dDocAuthor=sysadmin
dDocType=ADENG dSecurityGroup=Public
dID=49 dRevLabel=1
doFileCopy=1
4.3.14 CHECKIN_SEL_FORM
