5.3 Doc Services (Core Content Server)

Doc services perform actions on documents, such as checkin, checkout, subscription actions, and accessing document information. Frequently used services are marked with an asterick (*) in the following list.

This section describes these services:

5.3.1 ASSIGN_DOCINFO_FORM

Service that retrieves the DOCINFO_FORM and assigns it to content.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.2 CACHE_CHECKIN_NEW

Service used with preview. When a user performs a preview during a checkin the information is cached on the server side. This service is modeled after the non-cache version and uses the same parameters as CHECKIN_NEW.

To disallow the check in of empty files, set the following: ValidatePrimaryFileNotEmpty=1

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.3 CACHE_CHECKIN_SEL

Service used with preview. When a user performs a preview during a checkin the information is cached on the server side. This service is modeled after the non-cache version and uses the same parameters as CHECKIN_SEL.

To disallow the check in of empty files, set the following: ValidatePrimaryFileNotEmpty=1

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.4 CACHE_SUBMIT_HTML_FORM

Service used with preview. When a user performs a preview during a checkin the information is cached on the server side. This service is modeled after the non-cache version and uses the same parameters as SUBMIT_HTML_FORM.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.5 CACHE_WORKFLOW_CHECKIN

Service used with preview. When a user performs a preview during a checkin the information is cached on the server side. This service is modeled after the non-cache version and uses the same parameters as WORKFLOW_CHECKIN.

To have the service return an error if the content item file is empty, use the configuration setting: ValidatePrimaryFileNotEmpty=1.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.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 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: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

See "CHECKIN_ARCHIVE" for additional parameters.

Optional Service Parameters

See "CHECKIN_ARCHIVE" for additional parameters.

Example

IdcService=CHECKIN_ARCHIVE_NO_NOTIFY
Action=insert
dDocAuthor=user1
dDocName=test
dDocTitle=new content
dSecurityGroup=Public
primaryFile=c:/test.txt
doFileCopy=true

5.3.7 CHECKIN_BYNAME

Service that checks in a content item revision based on the content item name or Content ID.

Location: IdcHomeDir/resources/core/templates/std_services.htm

A user must have Admin permission to the content item's 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 reviewer/contributor 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.

    Important:

    Either the content item name or the content item revision ID must be specified.

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.

  • 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 application/FDF, 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, application/hcsf or application/doc.

  • 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.

  • 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 file's 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

5.3.8 CHECKIN_CONFIRM_FORM

Service that returns confirmation upon successful checkin through a browser.

Access Level: Write, Global, Scriptable (50)

Location: IdcHomeDir/resources/core/templates/std_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

5.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)

Queries Executed: QcheckinCachesForUser

Location: IdcHomeDir/resources/core/templates/std_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

5.3.10 CHECKIN_NEW

Service that checks in a new content item. This service the CHECKIN_NEW_SUB subservice.

Access Level: Write (2)

Location: IdcHomeDir/resources/core/templates/std_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 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 Content Server.

  • To disallow the checkin of empty files, set the following: ValidatePrimaryFileNotEmpty=1

Required additional parameter (metadata checkin):

createPrimaryMetaFile=true

Required 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.

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 true and the parameter createPrimaryMetaFile must be set to 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 application/FDF, 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, application/hcsf or application/doc.

  • 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.

  • dProjectID: The Content Publisher project ID generated by the Content Server.

  • dPublishType: The publish type (used with content created by Content Publisher). These values can be assigned:

    • H - Home

    • N - Navigation

    • S - Query results pages

    • P - Pages

    • G - Gallery Graphics

    • C - Contributor embedded graphics

    • O - All others

  • 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.

  • 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.

  • 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 file's 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.

    • 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

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

5.3.11 CHECKIN_NEW_FORM

Service that returns the check-in form for a new content item in a browser. The most likely error is when the content item was not properly defined.

Access Level: Write, Global, Scriptable (50)

Location: IdcHomeDir/resources/core/templates//std_services.htm

Results

  • Result Sets:

    • DocFormats (dFormat, dConversion, dDescription)

    • DocTypes (dDocType, dDescription, dGif)

  • Response Template: CHECKIN_NEW_FORM (checkin_new.htm)

Used By

  • Applets:

    • Repository Manager

    • Workflow Admin

    • User Admin

    • Configuration Manager

  • Resource Includes:

    • pne_nav_management_links

    • pne_nav_bookmark_links

    • calculate_doc_profile_urls

    • std_doc_man_pages

  • Standard Navigation:

    • commonNav.js

    • commonBundle.js

5.3.12 CHECKIN_NEW_SUB

Subservice that checks in a new content item revision. Depending on which service calls this subservice, other validation is done, such as determining if this content item belongs in a criteria workflow. Also includes computing of derived fields, adding of renditions, and initiation of refinery processing. A security check against group and account may need to be performed before executing this subservice.

Access Level: Subservice (N/A)

Inputs: All standard required fields for content checkin must be provided, plus any optional content metadata.

Queries Executed:

  • QnextRevID

  • UnextRevID

  • Irevision

  • Imeta

  • Idocument

  • IdocHistory

Location: IdcHomeDir/resources/core/templates//std_services.htm

Results

  • Local Data:

    • dAction

    • dActionDate

    • dClbraName

    • dConversion

    • dCreateDate

    • dDocAccount

    • dDocAuthor

    • dDocID

    • dDocName

    • dDocTitle

    • dDocType

    • dExtension

    • dFileSize

    • dFormat

    • dID

    • dInDate

    • dIsPrimary

    • dIsWebFormat

    • 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

    • xClbraAliasList

    • xClbraUserList

    • WebfilePath

    • Plus any custom metadata related to the item checked in

Used By

  • Services: CHECKIN_NEW

5.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: IdcHomeDir/resources/core/templates/std_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 reviewer/contributor for the current step.

  • A user must have Admin permission to the content item's 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.

  • 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 application/FDF, 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, application/hcsf or application/doc.

  • 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.

  • dProjectID: The Content Publisher project ID generated by the Content Server.

  • dPublishState: The publish state. If the content item exists in the system dPublishState must be empty.

  • dPublishType: The publish type (used with content created by Content Publisher). These values can be assigned:

    • H - Home

    • N - Navigation

    • S - Query results pages

    • P - Pages

    • G - Gallery Graphics

    • C - Contributor embedded graphics

    • O - All others

  • 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.

  • 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 file's 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 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

5.3.14 CHECKIN_SEL_FORM

Service that returns the check-in form for a content item revision in a browser. It loads the current content information for the item. The form page is displayed with old metadata information.

The most likely error is when the content item is no longer in the system, information about the content item cannot be found, or when the system is unable to check revision properties.

Access Level: Write, Scriptable (34)

Queries Executed: QdocID, Qrevisions, QdocInfo

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Optional Service Parameters

  • dDocName

  • dWfName

Results

  • Result Sets:

    • DOC_INFO (All fields from Revisions and DocMeta for the specified revision.)

    • DocFormats (dFormat, dConversion, dDescription)

    • DocTypes (dDocType, dDescription, dGif)

  • Local Data:

    • CurRevCheckoutUser

    • CurRevID

    • CurRevIsCheckedOut

    • dDocAccount

    • dDocAuthor

    • dDocName

    • defaultAccount

    • dID

    • DocUrl

    • dPublishState

    • dReleaseState

    • dRevClassID

    • dRevLabel

    • dSecurityGroup

    • dStatus

    • dUser

    • dWorkflowState

    • isCurRevEmpty

    • IsNotLatestRev

    • IsWorkflow

    • latestID

    • Plus all DocMeta fields

  • Response Template: CHECKIN_SEL_FORM (checkin_sel.htm)

Used By

  • Resource Includes:

    • classic_info_page_content

    • workflow_action_popup

    • checkin_list_action_popup

    • legacy_checked_out_content_table

    • workflow_doc_action_links

    • docinfo_checkin_similar_option

    • setup_checked_out_content_action_popups

    • wf_reviewer_doc_action_links

  • Templates:

    • CHECKOUT_OK (chkook.htm)

    • WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

Example

IdcService=CHECKIN_SEL_FORM
dID=55

5.3.15 CHECKIN_SEL_SUB

Subservice used if a content item being checked in already exists, is checked out, or if it is not in a workflow.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.16 CHECKIN_SIMILAR_FORM

Service that returns the check-in form for a new content item in a browser, with metadata from a similar content item filled in. The most likely error is when the content item was not properly defined.

Access Level: Write, Global, Scriptable (50)

Queries Executed: QdocInfoSimilarCheckin

Location: IdcHomeDir/resources/core/templates/std_services.htm

Results

  • Result Sets:

    • DOC_INFO_SIMILAR (dDocTitle, dDocType, dSecurityGroup, dDocAccount for the specified revision)

    • DocFormats (dFormat, dConversion, dDescription)

    • DocTypes (dDocType, dDescription, dGif)

  • Local Data:

    • dDocAccount

    • dDocType

    • dSecurityGroup

  • Response Template: CHECKIN_NEW_FORM (checkin_new.htm)

Used By

  • Resource Includes:

    • search_results_action_popup

    • docinfo_checkin_similar_option

    • doc_file_checkin_similar

    • setup_search_results_action_popups

  • Templates: CHECKIN_CONFIRM (checkin_confirm.htm)

5.3.17 CHECKIN_UNIVERSAL

Service that performs a Content Server-controlled checkin.

Access Level: Write (2)

Location: IdcHomeDir/resources/core/templates/std_services.htm

  • This service sends the check-in request to one of the following subservices, which are the same subservices called during checkin through the browser or Repository Manager application. (These subservices are not called during a Batch Loader or Archive import.)

    • CHECKIN_NEW_SUB - If the content item does not exist in the server. This subservice validates the check-in data and determines if this content item belongs to a criteria workflow.

    • CHECKIN_SEL_SUB - If the content item exists on the system, the content item is checked out, and the content item is not in a workflow.

    • WORKFLOW_CHECKIN_SUB - If the content item exists and is in a workflow.

  • This service checks security to determine if the user has sufficient permission to check in the content item.

  • Determines if the content item is new or already exists in the system by querying the database using the Content ID (dDocName) as the key.

  • If the content item exists in the system, the publish state (dPublishState) must be empty.

  • If the item exists and is checked out, a new revision is checked in.

  • The most likely errors are mismatched parameters or when the content item was not successfully checked in.

    Note:

    All paths use the slash (/) as the file separator. This is because the backslash (\) is an escape character. For example, primaryFile=d:/temp/myfile.txt.

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 specified and exists in the Content Server, a revision is checked in. If dDocName is specified and does not exist in the Content Server, a new content item is checked in.

    • 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

  • 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.

  • dCreateDate: The date the content item was created. By default, this is the current date.

  • 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.

  • dRevLabel: The revision label for the content item. If set, the label is used to locate the specified revision. If a revision label (dRevLabel) is specified, this service checks if the content revision exists in the system; an exception is thrown if it exists.

  • isFinished: Set to true (1) if this is a workflow checkin and you have finished editing it.

  • See "WORKFLOW_CHECKIN" for additional information.

    Note:

    Do not confuse the Content ID (dDocName) with the internal content item revision identifier (dID). The dID is a generated reference to a specific rendition of a content item.

Results

  • Local Data:

    • dConversion: If refinery-processed, 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.

Used By

  • Resource Includes: std_doc_page_definitions

  • Other:

    • SoapCustom:Esdl:CheckIn:Services

    • SoapCustom:Wsdl:Workflow:Services

Example

  • IdcCommand command file format:

    IdcService=CHECKIN_UNIVERSAL
    dDocName=adsales
    dDocType=ADACCT
    dDocTitle=Advertising Sales
    dSecurityGroup=Secure
    dDocAuthor=user1
    dRevLabel=1
    dDocType=ADACCT
    primaryFile=c:/temp/docs/mydoc.txt
    doFileCopy=1
    
    # If this is a workflow check-in and you have finished editing it, mark it as finished.
    #isFinished=true
    
    #Required depending on configuration
    dDocAccount=mainaccount
    
    #Optional fields:
    #dCreateDate=
    #dInDate=
    #dOutDate=
    #alternateFile=
    
    #Custom metadata fields:
    xComments=
    xLocation=
    xProjects=
    
  • HDA format (check in the content item myDocName):

    @Properties LocalData
    IdcService=CHECKIN_UNIVERSAL
    doFileCopy=1
    dDocName=myDocName
    dDocTitle=My document title
    dDocType=ADACCT
    dSecurityGroup=Secure
    dDocAuthor=user1
    primaryFile=c:/temp/docs/mydoc.txt
    dDocAccount=mainaccount
    xComments=
    xLocation=
    xProjects=
    @end
    

5.3.18 CHECKOUT

Service that checks out the latest revision of a content item from a browser.

  • The service fails if the content item does not exist in the system, if the content item is already checked out, or if the user does not have sufficient permission to check out the content item.

  • The most likely error is when the content no longer exists in the system or when the system is unable to retrieve revision information.

  • This service executes the subservice CHECKOUT_SUB. This subservice checks out a content item revision.

Access Level: Write, Scriptable (34)

Calls Subservice: CHECKOUT_SUB

Queries Executed:

  • QdocID

  • Qrevisions

  • QdocInfo

Location: IdcHomeDir/resources/core/templates/std_services.htm

Note:

This service only marks the content item as locked. It does not perform a download.

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Optional Service Parameters

  • dDocTitle: The content item title.

  • RedirectUrl: Used to display another page. If omitted, the user is redirected to the Content Server home page.

Results

  • Local Data:

    • CurRevCheckoutUser

    • CurRevIsCheckedOut

    • CurRevID

    • dAction

    • dActionDate

    • dActionMillis

    • dCheckoutUser

    • dClbraName

    • dDocName

    • dIsCheckedOut

    • dPublishState

    • dReleaseState

    • dRevClassID

    • dRevLabel

    • dSecurityGroup

    • dStatus

    • dWorkflowState

    • isCurRevEmpty

    • isFinished

    • IsNotLatestRev

    • IsWorkflow

    • latestID

    • prevReleaseState

    • RedirectParams

    • wfAction

  • Response Templates:

    • REDIRECT_TEMPLATE (redirect_template.htm)

    • Default redirect service: CHECKOUT_OK

Used By

  • Applets:

    • Repository Manager

    • Workflow Administrator

  • Resource Includes

    • classic_search_result_item_checkout

    • clbra_active_doc_display

    • doc_file_checkout

    • docinfo_checkout_form

    • searchapi_result_table_content_end

    • search_results_action_popup

    • setup_search_results_action_popups

    • wf_reviewer_doc_action_links

    • wips_list_action_popup

    • workflow_action_popup

    • workflow_doc_action_links

    • workflow_docs_table

    • workflow_in_queue_table

    • work_in_progress_table

  • Template: WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

  • Other: SoapCustom:Wsdl:CheckIn:Services

Example

  • IdcCommand command file format:

    IdcService=CHECKOUT
    dID=55
    
  • HDA format with optional parameter:

    @Properties LocalData
    IdcService=CHECKOUT
    dID=55
    dDocTitle=Sample Title
    @end
    

5.3.19 CHECKOUT_BY_NAME

Service that checks out a content item from an applet or application.

Location: IdcHomeDir/resources/core/templates/std_services.htm

  • The service fails if the content item does not exist in the system, if the content item is already checked out, or if the user does not have sufficient permission to check out the content item.

  • The most likely error is a content item name not in the system.

  • This service executes the subservice CHECKOUT_SUB. This subservice checks out a content item revision.

    Note:

    This service only marks the content item as locked. It does not perform a download.

Additional Required Service Parameters

  • dDocName: The Content ID of the content item.

Optional Service Parameters

  • dDocTitle: The content item title.

Example

  • IdcCommand command file format:

    IdcService=CHECKOUT_BY_NAME
    dDocName=myDocument
    
  • HDA format with optional parameter:

    @Properties LocalData
    IdcService=CHECKOUT_BY_NAME
    dDocName=myDocument
    dDocTitle=Just a title
    @end
    

5.3.20 CHECKOUT_OK

Called as a redirect service by the service(s) that check out a content item from a browser and display a checkout confirmation page.

Access Level: Write, Scriptable (34)

Queries Executed: QdocInfo

Location: IdcHomeDir/resources/core/templates/std_services.htm

  • The most likely error is when the revision no longer exists or when the system is unable to retrieve revision information.

  • This service executes the subservice CHECKOUT_SUB. This subservice checks out a content item revision.

Additional Required Service Parameters

  • dID: The generated content item revision ID.

  • CurRevCheckoutUser: The user who checked out the item.

Optional Service Parameters

  • CurRevID: The ID of the current revision, usually the same as dID.

Results

  • Result Sets: DOC_INFO (All Fields from Revisions and DocMeta for the specified version.)

  • Response Template: CHECKOUT_OK (chkook.htm)

Used By

  • Other: Redirect service for CHECKOUT, CHECKOUT_BY_NAME

Example

IdcService=CHECKOUT_OK
dID=48

5.3.21 CHECKOUT_SUB

Subservice that checks out a content item revision. Requires that the binder contain a result set named DOC_INFO that contains the results of QdocInfo (or equivalent) for the most recent version of a content item.

Access Level: Subservice (N/A)

Queries Executed:

QworkflowDocInfo

  • IdocHistory

  • UcheckoutRevision

Location: IdcHomeDir/resources/core/templates/std_services.htm

Results

  • Local Data:

    • CurRevCheckoutUser

    • dAction

    • dActionDate

    • dActionMillis

    • dCheckoutUser

    • dClbraName

    • dIsCheckedOut

    • hasUserAccessChanged

    • isCurRevEmpty

    • isFinished

    • IsNotLatestRev

    • prevReleaseState

    • wfAction

Used By

  • Services:

    • CHECKOUT

    • CHECKOUT_BY_NAME

    • FORM_PROCESS (indirectly through the processForm method)

5.3.22 CONTINUE_CHECKIN

Service that completes a checkin that was started with the CACHE_CHECKIN_NEW or CACHE_CHECKIN_SEL service.

After a preview has been performed and the check-in data is cached the user can decide to finish or continue the checkin using this service.

The cached data must be provided to this service to perform a successful checkin. Filters are provided to customize the cache and check-in behavior.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

5.3.23 CONTINUE_SUBMIT_HTML_FORM

Service that completes a checkin that was started with the CACHE_SUBMIT_HTML_FORM service.

After a preview has been performed and the check-in data is cached the user can decide to finish or continue the checkin using this service.

The cached data must be provided to this service to perform a successful checkin. Filters are provided to customize the cache and check-in behavior.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

5.3.24 CREATE_SUBSCRIPTION_TYPE

Service that creates a new subscription type. The most likely error is when the subscription type name is not unique.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • scpType: The subscription type.

  • scpDescription: The subscription description.

  • scpEnabled: 1 (true): Subscription notifications are enabled. 0 (false): Subscription notifications are disabled.

  • scpFields: The metadata fields that define the subscription criteria. For example, dDocAuthor, dDocType.

Example

IdcService=CREATE_SUBSCRIPTION_TYPE
scpType=subscription_test
scpFields=dDocType
scpDescription=testing the subscription
scpEnabled=1

5.3.25 DELETE_BYCLASS

Subservice used to delete content items based on specific parameters.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.26 DELETE_BYNAME

Subservice used to delete content items based on specific parameters.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.27 DELETE_BYREV

Subservice used to delete content items based on specific parameters.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.28 DELETE_BYREV_REVISION

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.29 DELETE_CHECKIN_CACHE

Subservice used to delete content items based on specific parameters.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.30 DELETE_DOC

Service that deletes the entire content item and all revisions. The user must have permission to delete the content item. The most likely error is when the content item no longer exists in the system.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item ID.

  • dDocName: The documentID for the document; the actual content ID.

Example

IdcService=DELETE_DOC
dID=48
dDocName=test1000

5.3.31 DELETE_REV

Service that deletes an existing content item revision from a browser. The most likely errors are mismatched parameters, when the content item no longer exists in the system, or when the content item is part of a workflow.

Access Level: Read, Write (3)

Calls Subservice: DELETE_BYREV_REVISION

Queries Executed: QdocInfo

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Results

  • Result Sets: DOC_INFO (All fields from Revisions and DocMeta for the specified revision.)

  • Local Data:

    • Content Server:

    • currentReleaseState

    • dAction (returns 'Delete Revision')

    • dReleaseState

    • isAllRevisionsDeleted (returns true when the last revision of an item is deleted)

    • isCurRevEmpty

    • newReleaseState

    • prevID

    • If the item being deleted is currently in a workflow, the operation fails and the following workflow info is returned:

    • dWfCurrentStepID

    • dWfDocState

    • dWfID

    • dWfName

    • dWfStatus

    • dWfStepDescription

    • dWfStepID

    • dWfStepIsAll

    • dWfStepName

    • dWfStepType

    • dWfStepWeight

    • dWfType

    • dWorkflowState

    • IsWorkflow

    • wfStepCheckinType

  • Response Templates:

    • REDIRECT_TEMPLATE (redirect_template.htm)

    • Default redirect service: DOC_INFO

Used By

  • Resource Includes:

  • delete_rev_form

    • delete_revision_form

Example

IdcService=DELETE_REV
dID=51

5.3.32 DELETE_REV_EX

Service that deletes an existing content item revision from an applet or application. The most likely errors are mismatched parameters, when the content item no longer exists n the system, or when the content item is part of a workflow.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Example

IdcService=DELETE_REV_EX
dID=56

5.3.33 DELETE_SUBSCRIPTION_TYPE

Service that deletes an existing subscription type. The most likely error is a subscription type that is not in the system.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • scpType: The subscription type.

Example

IdcService=DELETE_SUBSCRIPTION_TYPE
scpType=subscription_test

5.3.34 DOC_FORMATS_WIZARD

Service that retrieves content item format extensions. Used to load the content item configuration information and set the default content item format extension.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.35 DOC_INFO

Service that retrieves content item information for a specific revision of a content item. The most likely errors are when the content item no longer exists in the system or when the user does not have the security level to perform this action.

Limited information is provided for other revisions through the REVISION_HISTORY result set.

This service returns subscription information and workflow information if the item is in workflow.

Access Level: Read, Scriptable (33)

Queries Executed:

QdocInfo

  • QdocFormats

  • QisSubscribed

  • QrevHistory

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Results

  • Result Sets:

    • DOC_INFO (all fields from Revisions and DocMeta for the specified revision)

    • REVISION_HISTORY (dFormat, dInDate, dOutDate, dStatus, dProcessingState, dRevLabel, dID, dDocName, dRevisionID for all non-deleted revisions)

    • If item is in workflow: WF_INFO (all fields from Workflows and WorkflowDocuments for the specified revision)

  • Local Data:

    • Content Server:

    • AuthorAddress

    • dDocFormats

    • dDocTitle

    • dID

    • DocUrl

    • dStatus

    • dSubscriptionAlias

    • dSubscriptionID

    • dSubscriptionType

    • dUser

    • If item is in workflow:

    • dWfCurrentStepID

    • dWfDocState

    • dWfID

    • dWfName

    • dWfStatus

    • wfStepCheckinType

    • dWfStepDescription

    • dWfStepID

    • dWfStepIsAll

    • dWfStepName

    • dWfStepType

    • dWfStepWeight

    • dWfType,

    • IsWorkflow

  • Response Template: DOC_INFO (doc_info.htm)

Used By

  • Resource Includes:

    • checkin_list_action_popup

    • checkin_multiuploadapplet_processing_functions

    • classic_doc_rev_info

    • clbra_active_doc_display

    • clbra_wf_doc_list

    • dam_result_table_content_row

    • doc_info_action_image

    • docinfo_page_title

    • doc_rev_info

    • doc_revisions_table

    • email_docinfo_body_by_id

    • email_docinfo_body_by_name

    • legacy_basic_subscriptions_table

    • legacy_checked_out_content_table

    • legacy_expired_content_table

    • legacy_work_in_progress_table

    • my_view_result_table_cells

    • searchapi_result_doc_href_start

    • searchapi_result_table_content_end

    • search_result_info_button

    • search_results_action_popup

    • setup_checked_out_content_action_popups

    • setup_search_results_action_popups

    • setup_subscription_action_popups

    • setup_work_in_progress_action_popups

    • slim_result_table_content_row

    • subscription_action_popup

    • trays_search_result_section

    • wf_in_queue_display

    • wf_reviewer_mail_link

    • wips_list_action_popup

  • Templates:

  • CHECKIN_CONFIRM (checkin_confirm.htm)

    • DOCUMENT_PROBLEMREPORTS (doc_problemreports.htm)

    • DOC_SUB_LIST (doc_sub_list.htm)

    • PR_CONTRIBUTOR_MAIL (pr_contributor_mail.htm)

    • PROBLEMREPORT_INFO (pr_info.htm)

    • QUERY_NOTIFICATION (query_notification_mail.htm)

    • SUBSCRIPTION_MAIL (subscription_mail.htm)

    • WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

    • WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)

  • Other:

  • Link in LC Variable: wwCommentOnRevision

    • SoapCustom:Wsdl:DocInfo:Services

    • SoapCustom:Wsdl:DocInfo:Service:DocInfoByID:ResponseParams

    • SoapCustom:Wsdl:DocInfo:Service:DocInfoByName:ResponseParams

    • SoapCustom:Wsdl:GetFile:Service:GetFileByID:ResponseParams

    • Redirect service for:

    • DELETE_REV

    • RESUBMIT_FOR_CONVERSION

    • SUBSCRIBE

    • UNDO_CHECKOUT

    • UNSUBSCRIBE

    • UPDATE_DOCINFO_BYFORM

Example

IdcService=DOC_INFO
dID=54321

5.3.36 DOC_INFO_BY_NAME

Service that retrieves information about the latest revision of a content item based on the content ID (the dDocName) as a parameter rather than the revision-specific dID parameter, which is required by the DOC_INFO service. The RevisionSelectionMethod parameter can be set to specific to return information about a specific revision.

By default, this service returns information for the Latest revision, whether it is released or not. An item is not released until it is out of workflow. Results returned for a given revision are identical to those of the DOC_INFO service.

Access Level: Read, Scriptable (33)

Queries Executed:

  • QdocInfo

  • QdocFormats

  • QisSubscribed

  • QrevHistory

  • QlatestIDByName (if RevisionSelectionMethod is empty or 'Latest')

  • QlatestReleasedIDByName (if RevisionSelectionMethod is 'LatestReleased')

Location: IdcHomeDir/resources/core/templates/std_services.htm

Important:

Either the content item name (dDocName) must be specified or a Content ID (dDocName) with the RevisionSelectionMethod parameter must be specified.

Additional Required Service Parameters

  • dDocName: The content item name.

Optional Service Parameters

  • RevisionSelectionMethod: Can be set to Latest to retrieve the most recent version, or LatestReleased to retrieve the most recently released version, or Specific (if set to Specific, a dID must be provided). If set to Specific, dID can be used instead of dDocName to point to a specific revision.

  • Results

  • Result Sets:

    • DOC_INFO (all fields from Revisions and DocMeta for the specified revision)

    • REVISION_HISTORY (dFormat, dInDate, dOutDate, dStatus, dProcessingState, dRevLabel, dID, dDocName, dRevisionID for all non-deleted revisions)

    • If item is in workflow: WF_INFO (all fields from Workflows and WorkflowDocuments for the specified revision)

  • Local Data:

    • Content Server:

    • AuthorAddress

    • dDocFormats

    • dDocTitle

    • dID

    • DocUrl, dStatus

    • dSubscriptionAlias

    • dSubscriptionID

    • dSubscriptionType

    • dUser

    • If item is in workflow:

    • dWfStatus

    • dWfCurrentStepID

    • dWfDocState

    • dWfID

    • dWfName

    • dWfStepDescription

    • dWfStepID

    • dWfStepIsAll

    • dWfStepName

    • dWfStepType

    • dWfStepWeight

    • dWfType

    • IsWorkflow

    • wfStepCheckinType

  • Response Template: DOC_INFO (doc_info.htm)

Used By

  • Resource Includes:

    • email_docinfo_body_by_id

    • email_docinfo_body_by_name

    • setup_workflow_action_popups

    • workflow_action_popup

  • Template: PR_PUBLISHER_MAIL (pr_publisher_mail.htm)

  • Other: SoapCustom:Wsdl:DocInfo:Services

5.3.37 DOC_INFO_LATESTRELEASE

Service that retrieves information only for the latest revision of a released content item. If the content item has no released revision, the service returns a StatusCode of -1, with a corresponding StatusMessage value. It only returns the DOC_INFO result set (no revision, workflow, or subscription information). Because it does not have a template it returns only raw data.

The most likely errors are when the content item no longer exists in the system or when the user does not have the security level to perform this action.

Access Level: Read, Scriptable (33)

Queries Executed: QlatestReleasedIDByName, QdocInfo

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The document name for the content item.

Results

  • Result Sets: DOC_INFO (All fields from Revisions and DocMeta for the latest released revision.)

  • Local Data:

  • AuthorAddress

    • dDocName

    • dID

    • dUser

Example

IdcService=DOC_INFO_LATESTRELEASE
dDocName=PublicDoc1_ia3c488971

5.3.38 DOC_INFO_SIMPLE

Service that returns information about a specific content item without workflow or subscription information. It returns revision information as a simple listing of rows from the Revisions table rather than a specific selection of fields from the Documents and Revisions table. These differences make this service a less expensive operation than the standard DOC_INFO service.

Because it does not have a template it returns only raw data.

Access Level: Read, Scriptable (33)

Queries Executed: QdocInfo, QdocName

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The Content ID for the content item.

Results

  • Result Sets:

  • DOC_INFO (all fields from Revisions and DocMeta for specific revision)

    • DocRevisions (all fields from Revisions for all non-deleted revisions)

  • Local Data:

    • AuthorAddress

    • dID

    • dUser

5.3.39 DOC_INFO_SIMPLE_BYREV

Service that returns information about a content item based on a revision number. This service differs from others by requiring a combination of Content ID (dDocName) and revision number (dRevLabel) as required parameters. All other revision-specific doc_info services require dID.

This service returns the DOC_INFO result set. DOC_INFO_SIMPLE also returns revision information.

Access Level: Read, Scriptable (33)

Queries Executed: QdocRev, QdocInfo

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The document name for the content item.

  • dRevLabel: The revision number for the content item.

Results

  • Result Sets:

  • DOC_INFO (all fields from Revisions and DocMeta for specific revision)

  • Local Data:

    • dUser

    • dRevLabel

    • dID

    • AuthorAddress

    • dDocName

5.3.40 DOC_SUBS_LIST

Service that returns a list of content items in a specific subscription.

For criteria-based subscriptions, this returns items matching the criteria. For basic subscriptions, it returns the item with a name that matches the subscription ID.

Access Level: Read, Global, Scriptable (49)

Queries Executed: QuserSubscription

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dSubscriptionID: The subscription ID. For a Basic subscription, this is the Content ID. For a Criteria subscription, this is a comma-delimited list of the values of the criteria fields.

For example, if the criteria fields are Author and Security Group, the value for a Public content item authored by user1 would be Public,user1.

  • dSubscriptionType: The subscription type, either Basic or a custom name. Must be set to Basic for a basic subscription.

Optional Service Parameters

  • dSubscriptionAlias: Use to pass an alias or user name. If set to alias, a valid alias name must be used. If set to user a valid user name is necessary. If an invalid alias or user name is used, an error occurs. If left blank, the value defaults to user and is set to the current user (dUser).

  • dSubscriptionAliasType: Determines what the service expects as a value for dSubscriptionAlias. Valid values are alias or user.

  • unsubscribeService: For response pages (such as the default template for this service) that provide a link that allows the user to unsubscribe, a value must be passed as a parameter. If omitted an error does not appear but the unsubscribe link on the response page produces an error if clicked (the standard value should be UNSUBSCRIBE).

  • subscribeService: Same as unubscribeService except a link to subscribe is provided if the user is not already subscribed to the subscription (the standard value should be SUBSCRIBE).

  • MaxQueryRow: Truncates the number of rows returned for the DOCUMENT_LIST result set.

Results

  • Result Sets:

    • DOCUMENT_LIST: All fields from Revisions and DocMeta for items matching the subscription criteria. This data is returned regardless of whether the user is subscribed to the specified subscription.

    • USER_SUBSCRIPTION: All fields from Subscriptions for the row that assigns the specified subscription to the user/alias. If the user/alias is not subscribed to the specified subscription, the result set is empty.

  • Local Data:

    • dataSource

    • dSubscriptionAlias

    • dSubscriptionAliasType

    • dSubscriptionID

    • dSubscriptionType

    • dUser

    • MaxQueryRows

    • resultName

    • scpDescription

    • scpEnabled

    • whereClause

  • Response Template: DOC_SUB_LIST (doc_sub_list.htm)

Used By

  • Applets: Repository Manager

  • Resource Includes:

    • criteria_subscription_info_image

    • legacy_criteria_subscriptions_table

    • setup_subscription_action_popups

    • subscription_action_popup

  • Templates:

    • SUBSCRIBE_FORM (subscribe_form.htm)

    • UNSUBSCRIBE_FORM (unsubscribe_form.htm)

Example

IdcService=DOC_SUBS_LIST
dSubscriptionType=my_subscription
dSubscriptionID=ADENG

5.3.41 EDIT_DOC_FORMATS

Service that modifies existing file formats. The service updates content item formats and file extension information. This service is executed in a browser interface by the Inbound Refinery.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dFormat: The formatting process used to create the Web-viewable version of the content. For example, application/hcsf or application/doc.

  • dDescription: The format description.

  • 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 application/FDF, the server sets the conversion to exchange-fdf.

  • extensions: The file extensions such as doc, txt, or pdf.

Example

IdcService=EDIT_DOC_FORMATS
dFormat=application/msword
extensions=doc
dConversion=PASSTHRU
dDescription=adding the description

5.3.42 FORM_PROCESS

Service that processes a PDF form for submission. This service is called by FORM_SUBMIT. It uses the auto-generated ClientId parameter.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Note:

This service cannot be executed by Idc Command.

5.3.43 FORM_SUBMIT

Service that submits a PDF form. This service calls the FORM_PROCESS service to process the PDF form before submission.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Note:

This service cannot be executed by Idc Command.

5.3.44 GET_CACHED_CHECKIN_INFO

Service used to display the cached data for a cache checkin such as CACHE_CHECKIN_NEW. It is available from the checked-out content listing.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

5.3.45 GET_DOC_CONFIG_INFO

Service that returns Content Server configuration information for Content Publisher purposes. Gets a dump of the server environment form external applications.

Returns the properties information, the security group option list, and these ResultSets:

  • DOC_DEFAULT_INFO

  • DocMetaDefinition

  • DocTypes

  • DocFormats

Location: IdcHomeDir/resources/core/templates/std_services.htm

Example

  • IdcCommand command file format:

    # Retrieves content item configuration information
    IdcService=GET_DOC_CONFIG_INFO
    
  • HDA format:

    @Properties LocalData
    IdcService=GET_DOC_CONFIG_INFO
    @end
    

5.3.46 GET_DOC_SUBSCRIBERS

Service that returns a list of subscribers to a specific content item.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

Example

IdcService=GET_DOC_SUBSCRIBERS
dDocName=test_000036

5.3.47 GET_ENVIRONMENT

Service used to retrieve the settings of configuration values for a Content Server environment.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Optional Service Parameters

  • startTime: The time (in milliseconds) that the instance started.

5.3.48 GET_EXPIRED

Service used to retrieve a list of expiring and expired items. The optional isExpiredQuery parameter, when set to true, causes the service to list only items that have already expired.

Without this parameter, the list also contains items that are scheduled to expire within the range of dates specified by endDate and startDate. This may include items that have already expired if the start date is earlier than the current system time.

Access Level: Read, Write, Global (18)

Location: IdcHomeDir/resources/core/templates/std_services.htm

Optional Service Parameters

  • endDate: Items expiring before this date are displayed.

  • isExpiredQuery: Setting this parameter to 1 (true) causes searching for only expired items. If set to true and the end date is unspecified, the current system time is used as a default end date. This lists content that has already expired unless constrained by a specific start date.

  • If set to 0 (false) and the start date is empty, the current system time is used as a default start date. This lists content items that expire in the future, constrained by a specified end date.

In all other situations, empty start or end dates are treated as empty, and no corresponding constraint is imposed upon the query.

  • startDate: Items expiring after this date are displayed.

Results:

  • Results Sets: EXPIRED_LIST (All fields from Revisions and DocMeta for expired or expiring items as defined by the dates and isExpiredQuery parameter.)

  • Local Data:

  • dataSource

    • endDate

    • expiredQuery

    • isExpiredQuery

    • isQueryResult

    • MaxQueryRows

    • orderClause

    • resultName

    • startDate

    • userDefinedEndDate

    • userDefinedStartDate

    • whereClause

  • Response Template: EXPIRED_PAGE (expired_page.htm)

Used By

  • Resource Includes:

  • pne_nav_management_links

    • std_doc_man_pages

  • Templates: EXPIRED_PAGE (expired_page.htm)

  • Standard Navigation: commonNav.js

5.3.49 GET_PACKAGE_ENVIRONMENT_PAGE

Services used to retrieve the page that initiates the packaging of the environment.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.50 GET_UPDATE_FORM

Service used to generate the Info Update Form for an existing content item.

The most likely error is naming a content item that is no longer in the system.

Access Level: Write, Scriptable (34)

Queries Executed: QdocInfo

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Results

  • Result Sets:

    • DOC_INFO (all fields from Revisions and DocMeta for the specified revision)

    • DocFormats (all rows and fields of the DocFormats database table)

    • DocTypes (all rows and fields of the DocTypes database table)

  • Local Data:

    • dDocAccount

    • dDocName

    • dDocType

    • defaultAccount

    • dID

    • dSecurityGroup

    • dUser

  • Response Template: UPDATE_DOC_INFO (update_docinfo.htm)

Example

IdcService=GET_UPDATE_FORM
dID=59

5.3.51 NOTIFY_INDEXER

Service used to notify the indexer that work is to be done. This service is not used because normally a checkin notifies the indexer or because the indexer has its own timer, which checks for 'work to do' every five minutes.

This service should only be used if a NO_NOTIFY checkin has been performed and the client application does not want to wait for the normal indexing cycle.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.52 ODMA_DOC_INFO_SIMPLE

Service used by the ODMA client application to retrieve the content information for the specified content item.

This service is currently not in use.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The unique ID for the item revision.

5.3.53 PACKAGE_ENVIRONMENT

Service that creates a packaged zip file containing Content Server environment files.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.54 REMOVE_METAFILE_SUB

Subservice called to alter document meta information.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.55 REPLACE_METAFILE_SUB

Subservice called to replace document meta information.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.56 RESUBMIT_FOR_CONVERSION

Service that resubmits a content item for conversion when it fails the initial conversion attempt. The most likely errors are when the content item no longer exists in the system or when the user does not have the security level to perform this action.

This service can resubmit successful conversions and failed ones.

Access Level: Write (2)

Queries Executed: QdocInfo, QlatestID, Qdocuments

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Optional Service Parameters

  • RedirectUrl: URL used for the redirected service.

  • AlwaysResubmit: When set to 1 (true), allows the service to be used on items that were successfully converted. Otherwise the service only operates on failed conversions.

Results

  • Local Data:

    • dConversion

    • dCurRevID

    • dDocID

    • dExtension

    • dFileSize

    • dFormat

    • dID

    • dOriginalName

    • dProcessingState

    • dPublishState

    • dRawDocID

    • dReleaseState

    • dRevClassID

    • dStatus

    • dWorkflowState

    • IsNotLatestRev

    • isStatusChanged

    • prevReleaseState

    • RedirectParams

    • VaultfilePath

    • WebfilePath

    • wfAction

  • Response Template:

    • REDIRECT_TEMPLATE (redirect_template.htm)

    • Default redirect service: DOC_INFO

Used By

  • Applets: Repository Manager

  • Resource Includes:

  • classic_info_page_content

    • docinfo_resubmit_option

    • std_docinfo_error_msg

Example

IdcService=RESUBMIT_FOR_CONVERSION
dID=62

5.3.57 REV_HISTORY

Service that returns the revision history for a content item revision.

Access Level: Read, Scriptable (33)

Queries Executed: QdocInfo, QrevHistoryReleased

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Results

  • Result Sets:

    • DOC_INFO (All fields from Revisions and DocMeta for the specified revision)

    • REVISIONS (Rows listing all the item's released revisions containing the fields: dDocAccount, dDocName, dDocType, dFormat, dID, dInDate, dProcessingState, dReleaseState, dRevLabel, dRevisionID, dSecurityGroup, dStatus, dWebExtension)

  • Local Data: dID

  • Response Template: REV_HISTORY (rev_history.htm)

  • Used By

  • Resource Includes:

  • classic_search_result_item_revision

    • searchapi_result_table_content_end

Example

IdcService=REV_HISTORY
dID=62

5.3.58 SELECTDOC

Service that returns content item information and evaluates the user security level when selecting a content item using ODMA.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Example

IdcService=SELECTDOC
dID=62

5.3.59 SUBMIT_HTML_FORM

Service that submits HCSP or HCSF forms for processing. These are Dynamic Server Pages used to process HTML-based business forms. This service calls the GET_FILE subservice, called with Java code from intradoc.server.FormHandler.retrieveHtmlFormState() method.

Usually the Auto Content ID feature is enabled to submit HTML forms. If not, each submitted form must be assigned a unique Content ID.

The most likely error is an HTML form that does not exist.

Access Level: Write (2)

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID. The specified revision must be an HTML form.

Optional Service Parameters

  • RedirectUrl: Used to display another page. If omitted, the user is redirected to the Content Server home page.

  • isFormFinished: Used on HCSP files. If this is set to 1 (true), the HCSP cannot be submitted again.

  • Text fields: You can submit any text field in the form as an optional parameter and pass a value to that field. For example, if the form has a text field called Product, the string value publisher could be assigned to that field (Product=publisher).

Results

  • Result Sets: DocTypes, DocFormats

  • Local Data: dDocTitle, dID

  • Response Template: null, default redirect server (GET_DOC_PAGE: HOME_PAGE)

Used By

  • Resource Includes: std_html_form_submit_start

Example

  • IdcCommand command file format:

  • IdcService=SUBMIT_HTML_FORM

    dID=44
    
  • HDA format with an optional parameter (assigns a value to a text field):

    @Properties LocalData
    IdcService=SUBMIT_HTML_FORM
    dID=44
    Product=publisher
    @end
    

5.3.60 SUBSCRIBE

Service that subscribes a user to a content item or group of items. The most likely errors are when the content item no longer exists in the system or when the user does not have the security level to perform this action.

Access Level: Read (1)

Queries Executed:

  • QdocInfo

  • QuserSubscription

  • Quser

  • UuserEmail

  • Isubscription

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

  • dSubscriptionEmail: The e-mail address for the subscription. The service uses the value to overwrite the user's e-mail value in their user profile. If no value is passed for this parameter, the profile not updated. Essentially, every time this service is executed, the user's e-mail address is updated.

  • dSubscriptionType: The subscription type. You can optionally provide the name of a custom subscription. If this parameter is used, the service subscribes the user to a criteria-based subscription where the specified custom subscription's criteria fields match the value of the corresponding metadata of the item specified through the dID parameter. If dSubscriptionType is left blank, the Basic subscription is used by default.

Optional Service Parameters

  • RedirectUrl: Used to display another page. If omitted, the user is redirected to the Content Server home page.

Results

  • Local Data:

    • dID

    • dName

    • dSubscriptionAlias

    • dSubscriptionAliasType

    • dSubscriptionCreateDate

    • dSubscriptionID

    • dSubscriptionType

    • dUser

  • Response Template:

    • DOC_INFO

    • Default redirect service: DOC_INFO

Used By

  • Resource Includes:

  • docinfo_subscription_form

    • doc_subscription_unsubscription

  • Other: SoapCustom:Wsdl:Subscription:Services

Example

These parameters are passed in the browser environment to execute this command:

<input type=hidden name=IdcService value="SUBSCRIBE">
<input type=hidden name=dID value="63">
<input type=hidden name=dSubscriptionType value=my_subscription>
<input type=hidden name=dSubscriptionEmail value=sysadmin@company.com>

5.3.61 SUBSCRIBE_DOC_USER

Service used in the browser environment when a user subscribes to a content item (builds the subscription page).

This service is executed when a user subscribes to a document (performs a search and clicks Subscribe). If the system has more than one subscription type, the user is redirected to the Subscription page where the user can subscribe to different criteria.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

    Note:

    Additional parameters are passed when the user subscribes to the content item (see the following example).

Example

These parameters are passed in the browser environment to execute this command:

<form name=SubscriptionForm action="/cs/idcplg"method="GET"">
<input type=hidden name=dID value="63">
<input type=hidden name=dDocName value="test_000045">
<input type=hidden name=IdcService value="SUBSCRIBE_DOC_USER">
<input type=hidden name=subscribeService value=SUBSCRIBE>
<input type=hidden name=exitUrl value="/cs/idcplg?IdcService=DOC_INFO&dID=63&dDocName=test_000045">
<input type=hidden name=title value="Subscriptions">
<input type=hidden name=unsubscribeService value=UNSUBSCRIBE>
<input type=submit value="Subscriptions">
</form>

5.3.62 SUBSCRIBE_EX

Service used in Repository Manager to add a user or alias to a subscription. It returns the list of users and aliases subscribed to this type. The most likely error is when the specified subscription alias type or subscription alias does not exist.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dSubscriptionAlias: The alias for the subscription.

  • dSubscriptionAliasType: The type of user. This value must be either user or alias. It refers to the value defined in dSubscriptionAlias.

  • dSubscriptionEmail: The email address for the subscription.

  • dSubscriptionID: The subscription ID.

    • For a Basic subscription, this is the Content ID.

    • For a Criteria subscription, this is a comma-delimited list of the values of the criteria fields.

For example, if the criteria fields are Author and Security Group, the dSubscriptionID for a Public content item authored by user1 would be Public,user1.

  • dSubscriptionType: Name of the subscription type defined in the applet. A subscription type consists of a list of fields. When subscribing to a subscription type, the user must specify the values for each of the fields that make up the subscription type.

Optional Service Parameters

To return information about who is subscribed, this service requires these parameters:

  • dataSource: The data source.

  • resultName: The ResultSet name.

  • whereClause: The programmatic clause.

Example

IdcService=SUBSCRIBE_EX
dSubscriptionID=user20
dSubscriptionAlias=sysadmin
dSubscriptionAliasType=user
dSubscriptionType=test
dSubscriptionEmail=user20@stellent.com
resultName=USER_LIST
dataSource=Subscriptions
whereClause=dSubscriptionType='test'

5.3.63 SUBSCRIBE_FORM

Service that retrieves the subscription form used for content item subscriptions.

This service is identical to the UNSUBSCRIBE_FORM service except the template it returns.

Access Level: Read (1)

Queries Executed: QdocInfo, QSubscribed

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

  • unsubscribeService: For response pages (such as the default template for this service) that provide a link that allows the user to unsubscribe, a value must be passed as a parameter. If omitted an error does not appear but the unsubscribe link on the response page produces an error if clicked (the standard value should be UNSUBSCRIBE).

  • subscribeService: Same as unubscribeService except a link to subscribe is provided if the user is not already subscribed to the subscription (the standard value should be SUBSCRIBE).

Results

  • Result Sets:

    • DOC_INFO (All fields from Revisions and DocMeta for the revision specified by dID)

    • SUBSCRIPTION_LIST (All fields from the Subscription table plus the additional fields scpFields, scpDescription, scpEnabled, and notSubscribed for all defined subscriptions)

  • Local Data:

    • dID

    • dSubscriptionAlias

    • dSubscriptionID

    • dSubscriptionType

    • dUser

  • Response Template: SUBSCRIBE_FORM (subscribe_form.htm)

Used By

  • Resource Includes:

  • docinfo_subscription_form

    • doc_subscription_unsubscription

5.3.64 SUBSCRIPTION_LIST

Service that returns a list of all subscribed content items for a specific user.

No alias-based subscriptions are returned by this service, even if the user belongs to an alias that has subscriptions.

Access Level: Read, Global, Scriptable (49)

Queries Executed: QdocNameSubscription, QnotDocNameSubscriptions

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dUser: The user name of the currently logged-in user.

Results

  • Result Sets: SUBSCRIPTION_LIST (Each row contains all fields from the Subscription table corresponding to each of the current user's subscriptions. Additionally, for BASIC subscriptions, each row contains all fields from the Revisions table (metadata) for the latest revision of the item subscribed to.)

  • Local Data: dUser

  • Response Template: SUBSCRIPTION_LIST (subscription_list.htm)

Used By

  • Resource Includes: pne_nav_userprofile_links

  • Templates:

  • DOC_SUB_LIST (doc_sub_list.htm)

    • USER_INFO (user_info.htm)

  • Standard Navigation: commonNav.js

  • Other:

  • SoapCustom:Wsdl:Subscription:Services

    • SoapCustom:Wsdl:Subscription:Service:SubscriptionList:ResponseParams

    • Redirect service for: UNSUBSCRIBE_FROM_LIST

Example

IdcService=SUBSCRIPTION_LIST
dUser=sysadmin

5.3.65 UNDO_CHECKOUT

Service that reverses a content item checkout from a browser. The service fails if the content item does not exist in the system, if the content item is not checked out, or the user does not have sufficient permission to undo the checkout.

Access Level: Write (2)

  • Queries Executed:

  • QdocID

    • Qrevisions

    • QdocInfo

    • IdocHistory

    • QdocWebFormat

    • Uuncheckout

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

Optional Service Parameters

  • RedirectUrl: Used to display another page. If omitted, the user is redirected to the Content Server home page.

Results

  • Local Data:

    • CurRevCheckoutUser

    • CurRevID

    • CurRevIsCheckedOut

    • dAction

    • dCheckoutUser

    • dClbraName

    • dDocAccount

    • dDocName

    • dID

    • dIsCheckedOut

    • dReleaseState

    • dRevClassID

    • dRevLabel

    • dSecurityGroup

    • dStatus

    • dUser

    • isFinished

    • IsWorkflow

    • latestID

    • noDocLock

    • prevReleaseState

    • wfAction

  • Response Template:

    • REDIRECT_TEMPLATE (redirect_template.htm)

    • Default redirect service: GET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)

Used By

  • Applets:

  • Repository Manager

    • Workflow

  • Resource Includes:

  • checkin_list_action_popup

    • doc_file_checkout

    • docinfo_undo_checkout_form

    • setup_checked_out_content_action_popups

    • setup_workflow_action_popups

    • wf_reviewer_doc_action_links

    • workflow_action_popup

  • Templates: WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

  • Other: SoapCustom:Wsdl:CheckIn:Services

Example

  • IdcCommand command file format:

    IdcService=UNDO_CHECKOUT
    dID=44
    
  • HDA format:

    @Properties LocalData
    IdcService=UNDO_CHECKOUT
    dID=44
    @end
    

5.3.66 UNDO_CHECKOUT_BY_NAME

Service that reverses a content item checkout from an applet or application. The service fails if the content item does not exist in the system, if the content item is not checked out, or the user does not have sufficient permission to undo the checkout.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

Optional Service Parameters

  • dDocTitle: The content item title.

Example

  • IdcCommand command file format:

    IdcService=UNDO_CHECKOUT_BY_NAME
    dDocName=myDocument
    
  • HDA format with optional parameter:

    @Properties LocalData
    IdcService=UNDO_CHECKOUT_BY_NAME
    dDocName=myDocument
    dDocTitle=Just a title
    @end
    

5.3.67 UNSUBSCRIBE

Service that cancels a content item subscription when only the Basic subscription is defined. This service is run by clicking the Unsubscribe button on a Content Information page.

This service is different from the UNSUBSCRIBE_FROM_LIST service primarily in what data it returns. UNSUBSCRIBE redirects to the Content Info page by default, so it loads content info for the item specified by dID. UNSUBSCRIBE_FROM_LIST redirects to the subscription listing page by default, so it loads the data necessary to display the user's subscriptions.

Access Level: Read (1)

Queries Executed: QdocInfo, Dsubscription

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

  • dSubscriptionID: The subscription ID.

    • For a Basic subscription, this is the Content ID.

    • For a Criteria subscription, this is a comma-delimited list of the values of the criteria fields.

For example, if the criteria fields are Author and Security Group, the dSubscriptionID for a Public content item authored by user1 would be Public,user1.

  • dSubscriptionType: The subscription type.

Optional Service Parameters

  • RedirectUrl: Used to display another page. If omitted, the user is redirected to the Content Server home page.

  • dSubscriptionAlias: The user or alias for the criteria subscription (set to a valid user name or alias name, depending upon the value for dSubscriptionAliasType).

  • dSubscriptionAliasType: The alias for the subscription type. Valid values are user or alias.

If the current user has Admin privileges, the dSubscriptionAlias parameter with dSubscriptionAliasType can be used to unsubscribe a different user or alias from a subscription. If these parameters are omitted, the service defaults to a dSubscriptionAliasType of user and uses the current user (dUser) for the value of dSubscriptionAlias. If these parameters are included but the current user doesn't have Admin privileges, they are disregarded.

Results

  • Local Data:

    • dCheckoutUser

    • dDocAccount

    • dDocName

    • dID

    • dRevClassID

    • dSecurityGroup

    • dUser

  • Response Template:

    • DOC_INFO

    • Default redirect service: DOC_INFO

Used By

  • Resource Includes:

  • docinfo_subscription_form

    • doc_subscription_unsubscription

  • Other: SoapCustom:Wsdl:Subscription:Services

Example

IdcService=UNSUBSCRIBE
dID=66
dSubscriptionType=test
dSubscriptionID=test_000048

5.3.68 UNSUBSCRIBE_FORM

Service that retrieves the form used when unsubscribing from a content item.

This service is identical to the SUBSCRIBE_FORM service except the template it returns.

Access Level: Read (1)

Queries Executed: QdocInfo, QisSubscribed

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dID: The generated content item revision ID.

  • subscribeService: For response pages (such as the default template for this service) that provide a link that allows the user to unsubscribe, a value must be passed as a parameter. If omitted an error does not appear but the unsubscribe link on the response page produces an error if clicked (the standard value should be SUBSCRIBE).

Results

  • Result Sets:

    • DOC_INFO (All fields from Revisions and DocMeta for the revision specified by dID)

    • SUBSCRIPTION_LIST (All fields from the Subscription table plus the additional fields scpFields, scpDescription, scpEnabled, and notSubscribed for all defined subscriptions)

  • Local Data:

    • dID

    • dSubscriptionAlias

    • dSubscriptionID

    • dSubscriptionType

    • dUser

  • Response Template: UNSUBSCRIBE_FORM (unsubscribe_form.htm)

Used By

  • Resource Includes:

  • docinfo_subscription_form

    • doc_subscription_unsubscription

5.3.69 UNSUBSCRIBE_FROM_LIST

Service that cancels a content item subscription from a browser when multiple subscriptions are defined.

This service is run from the Subscriptions page, either by clicking the Unsubscribe link, or by clicking the Subscription Info link for that content item and then clicking Unsubscribe on the Subscription Info page.

This service differs from the UNSUBSCRIBE service primarily in what data it returns. UNSUBSCRIBE_FROM_LIST redirects to the subscription listing page by default, so it loads the data necessary to display the user's subscriptions. UNSUBSCRIBE redirects to the Content Info page by default, so it loads content info for the item specified by dID.

Access Level: Read, Global (17)

Queries Executed:

  • Dsubscription

  • QdocNameSubscription

  • QnotDocNameSubscriptions

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dSubscriptionID: The subscription ID. For a Basic subscription, this is the Content ID. For a Criteria subscription, this is a comma-delimited list of the values of the criteria fields.

For example, if the criteria fields are Author and Security Group, the dSubscriptionID for a Public content item authored by user1 would be Public,user1.

  • dSubscriptionType: The subscription type.

  • Optional Service Parameters

  • RedirectUrl: Used to display another page. If omitted, the user is redirected to the Content Server home page.

  • dSubscriptionAlias: The user alias for the criteria subscription, set to a valid user name or alias name, depending on the value for dSubscriptionAliasType.

  • dSubscriptionAliasType: The alias for the subscription type, set to either user or alias.

  • If the current user has Admin privileges, the dSubscriptionAlias parameter with dSubscriptionAliasType can be used to unsubscribe a different user or alias from a subscription. If these parameters are omitted, the service defaults to a dSubscriptionAliasType of user and uses the current user (dUser) for the value of dSubscriptionAlias. If these parameters are included but the current user doesn't have Admin privileges, they are disregarded.

Results

  • Result Sets: SUBSCRIPTION_LIST. Each row contains all fields from the Subscription table corresponding to each of the current user's subscriptions. Additionally, for Basic subscriptions, each row contains all fields from the Revisions table (metadata) for the latest revision of the item subscribed to.

  • Local Data:

    • dID

    • dSubscriptionAlias

    • dSubscriptionAliasType

    • dUser

  • Response Template:

    • SUBSCRIPTION_LIST

    • Default redirect service: SUBSCRIPTION_LIST

Used By

  • Applets: Repository Manager

  • Resource Includes: pne_nav_userprofile_links

  • Templates:

  • DOC_SUB_LIST (doc_sub_list.htm)

    • USER_INFO (user_info.htm)

  • Standard Navigation: commonNav.js

Example

IdcService=UNSUBSCRIBE_FROM_LIST
dSubscriptionType=test
dSubscriptionID=test_000046

5.3.70 UNSUBSCRIBE_FROM_LIST_EX

Service used by the Repository Manager applet to remove a user or alias from the subscription type. See SUBSCRIBE_EX for information about adding a user or alias.

This service is normally run by deleting a user from a subscription in the Repository Manager applet.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dSubscriptionAlias: Name of the subscription type as defined in the applet.

  • dSubscriptionAliasType: The type of user. This value must be either user or alias. It refers to the value defined in dSubscriptionAlias.

  • dSubscriptionID: The subscription ID.

    • For a Basic subscription, this is the Content ID.

    • For a Criteria subscription, this is a comma-delimited list of the values of the criteria fields.

For example, if the criteria fields are Author and Security Group, the dSubscriptionID for a Public content item authored by user1 would be Public,user1.

  • dSubscriptionType: The subscription type.

Optional Service Parameters

To return information about who is subscribed, this service requires these parameters:

  • dataSource: The data source.

  • resultName: The ResultSet name.

  • whereClause: The programmatic clause.

Example

Unsubscribes user20 from any content that is checked in by sysadmin:

IdcService=UNSUBSCRIBE_FROM_LIST_EX
dSubscriptionID=sysadmin
dSubscriptionAlias=user20
dSubscriptionAliasType=user
dSubscriptionType=test
dSubscriptionEmail=sysadmin@stellent.com
resultName=USER_LIST
dataSource=Subscriptions
whereClause=dSubscriptionType='test'

5.3.71 UPDATE_BYREV

Subservice used to check in content items based on specific parameters.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.72 UPDATE_DOCINFO

Service that updates the metadata for a content item from an applet or application. This service is used by the Repository Manager. and executes the UPDATE_DOCINFO_SUB subservice.

This service differs from the UPDATE_DOCINFO_BYFORM service which provides an option to redirect to a display template. UPDATE_DOCINFO provides no display option.

Access Level: Write (2)

Calls Subservice:

  • UPDATE_DOCINFO_SUB. This subservice may also call REMOVE_METAFILE_SUB, REPLACE_METAFILE_SUB, and UPDATE_DOCINFO_STATUS.

Queries Executed (all queries executed within subservices):

  • QdocInfo

  • QlatestID

  • Qdocuments

  • Ddocument

  • Idocument

  • Urevision2

  • Umeta

  • IdocHistory

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

  • 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.

Optional Service Parameters

  • Metadata fields: You can submit any metadata field as an optional parameter and pass a value to that field.

  • Results

  • Local Data:

    • Content Server:

    • dAction

    • dActionDate

    • dClbraName

    • dCreateDate

    • dDocAccount

    • dDocType

    • dDocName

    • dExtension

    • dID

    • dOriginalName

    • dOutDate

    • dpAction

    • dpEvent

    • dPublishState

    • dPublishType

    • dReleaseState

    • dRevClassID

    • dRevLabel

    • dSecurityGroup

    • dStatus

    • dUser

    • isCurRevEmpty

    • isDocProfileUsed

    • isEditMode

    • IsNotLatestRev

    • IsUpdate

    • IsUpdateMetaOnly

    • prevReleaseState

    • updateSideEffectServices

    • Workflow:

    • dCurRevID

    • dWfComputed

    • dWfCurrentStepID

    • dWfDirectory

    • dWfDocState

    • dWfID

    • dWfName

    • dWfStatus

    • dWfStepDescription

    • dWfStepID

    • dWfStepIsAll

    • dWfStepName

    • dWfStepType

    • dWfStepWeight

    • dWfType

    • dWorkflowState

    • IsWorkflow

    • wfAction

    • wfCurrentStepPrefix

    • wfEditFinished

    • wfMessage

    • wfQueueActionState

    • wfStepCheckinType

    • Plus any custom doc meta fields

  • Response Template: null

Used By

  • Applets: Repository Manger

  • Other: SoapCustom:Wsdl:CheckIn:Services

Example

  • IdcCommand command file format:

  • IdcService=UPDATE_DOCINFO

    dID=66
    dDocName=test_000048
    dSecurityGroup=Secure
    dRevLabel=2
    
  • HDA format with additional and optional parameters (assigns a value to a metadata field):

    @Properties LocalData
    IdcService=UPDATE_DOCINFO
    dID=66
    dDocName=test_000048
    dSecurityGroup=Secure
    dRevLabel=2
    dDocAccount=mainaccount
    xComments=Preliminary
    @end
    

5.3.73 UPDATE_DOCINFO_BYFORM

Service that updates content information for a content item from a browser. This service executes the subservice UPDATE_DOCINFO_SUB. This subservice updates content item information.

The difference between this service and UPDATE_DOCINFO is that this service provides an option to redirect to a display template.

Access Level: Write (2)

Calls Subservice:

  • UPDATE_DOCINFO_SUB, which may also call REMOVE_METAFILE_SUB, REPLACE_METAFILE_SUB, and UPDATE_DOCINFO_STATUS

Queries Executed (all queries executed within subservices):

  • QdocInfo

  • QlatestID

  • Qdocuments

  • Ddocument

  • Idocument

  • Urevision2

  • Umeta

  • IdocHistory

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

  • 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.

Optional Service Parameters

  • Metadata fields: You can submit any metadata field as an optional parameter and pass a value to that field. For example, if the system has a metadata field called xComments, the string value Preliminary could be assigned to that field (xComments=Preliminary).

  • RedirectUrl: Used to display another page. If omitted, the user is redirected to the Content Server home page.

Results

  • Local Data:

    • Content Server:

    • dAction

    • dActionDate

    • dClbraName

    • dCreateDate

    • dDocAccount

    • dDocName

    • dDocType

    • dExtension

    • dID

    • dOriginalName

    • dOutDate

    • dpAction

    • dpEvent

    • dPublishState

    • dPublishType

    • dReleaseState

    • dRevClassID

    • dRevLabel

    • dSecurityGroup

    • dStatus

    • dUser

    • isCurRevEmpty

    • isDocProfileUsed

    • isEditMode

    • IsNotLatestRev

    • IsUpdate

    • IsUpdateMetaOnly

    • prevReleaseState

    • updateSideEffectServices

    • Workflow:

    • dCurRevID

    • dWfComputed

    • dWfCurrentStepID

    • dWfDirectory

    • dWfDocState

    • dWfID

    • dWfName

    • dWfStatus

    • dWfStepDescription

    • dWfStepID

    • dWfStepIsAll

    • dWfStepName

    • dWfStepType

    • dWfStepWeight

    • dWfType

    • dWorkflowState

    • IsWorkflow

    • wfAction

    • wfCurrentStepPrefix

    • wfEditFinished

    • wfMessage

    • wfQueueActionState

    • wfStepCheckinType

    • Plus any custom doc meta fields

  • Response Template:

    • REDIRECT_TEMPLATE (redirect_template.htm)

    • Default redirect service: DOC_INFO

Used By

  • Resource Includes: std_doc_page_definitions

Example

  • IdcCommand command file format:

  • IdcService=UPDATE_DOCINFO_BYFORM

    dID=66
    dSecurityGroup=Secure
    dDocName=test_000048
    dRevLabel=2
    
  • HDA format with additional and optional parameters (assigns a value to a metadata field):

    @Properties LocalData
    IdcService=UPDATE_DOCINFO_BYFORM
    dID=66
    dSecurityGroup=Secure
    dDocName=test_000048
    dRevLabel=2
    dDocAccount=mainaccount
    xComments=Preliminary
    @end
    

5.3.74 UPDATE_DOCINFO_BYREV

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.75 UPDATE_DOCINFO_METAFILE_BYREV

Location: IdcHomeDir/resources/core/templates//std_services.htm

5.3.76 UPDATE_DOCINFO_STATUS

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.77 UPDATE_DOCINFO_SUB

Subservice that updates content item information.

LocationIdcHomeDir/resources/core/templates/std_services.htm

5.3.78 UPDATE_SUBSCRIPTION_NOTIFY

Currently unused in the core Content Server.

Service that updates the notification timestamp and redirects the user to the page specified in the RedirectUrl parameter.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.79 UPDATE_SUBSCRIPTION_TYPE

Service that updates a Criteria subscription. The most likely error is when the specified subscription type does not exist.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • scpType: The subscription type.

Optional Service Parameters

  • scpDescription: The subscription description.

  • scpEnabled:

    • 1 (true): Subscription notifications are enabled.

    • 0 (false): Subscription notifications are disabled.

  • scpFields: A comma-delimited list of the metadata fields that define the subscription criteria. For example, dDocAuthor,dDocType.

Example

  • IdcCommand command file format:

    IdcService=UPDATE_SUBSCRIPTION_TYPE
    scpType=my_subscription
    
  • HDA file format (changes the subscription for Author and disables the subscription):

  • @Properties LocalData

    IdcService=UPDATE_SUBSCRIPTION_TYPE
    scpType=my_subscription
    scpFields=dDocAuthor
    scpDescription=updating subscription
    scpEnabled=false
    @end
    

5.3.80 UPDATE_SUBSCRIPTION_USED

Service that updates a user's subscription records when they access a content item from a subscription notification. This service updates the date in the dSubscriptionUsedDate column of the Subscription database table.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dDocName: The Content ID for the content item.

  • dSubscriptionAlias: The user alias for the criteria subscription.

  • dSubscriptionAliasType: The alias subscription type.

  • dSubscriptionID: The subscription ID.

    • For a Basic subscription, this is the Content ID.

    • For a Criteria subscription, this is a comma-delimited list of the values of the criteria fields.

For example, if the criteria fields are Author and Security Group, the dSubscriptionID for a Public content item authored by user1 would be Public,user1.

  • dSubscriptionType: The subscription type.

Example

IdcService=UPDATE_SUBSCRIPTION_USED
dSubscriptionType=test_subscription
dSubscriptionID=sysadmin
dDocName=test_000056
dSubscriptionAlias=global
dSubscriptionAliasType=user

5.3.81 UPDATE_METADATA

Subservice that updates metadata.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.82 VALIDATE_DOCINFO

Service used for metadata-only checkins for a heavy client (InternalUpload = 1).

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.3.83 WORK_IN_PROGRESS

Service that returns a list of all content items in the GENWWW or DONE status. It does not show items currently in a workflow.

Access Level: Write, Global, Scriptable (50)

Location: IdcHomeDir/resources/core/templates/std_services.htm

Optional Service Parameters

  • orderClause: Use to provide a field name on which to sort the list.

  • MaxQueryRows: Use to control the number of items returned in the list.

Results

  • Result Sets: DOC_LIST (All Fields from Revisions and DocMeta)

  • Local Data:

    • copyAborted

    • dataSource

    • MaxQueryRows

  • Response Template: WIPS (wips_list.htm)

Used By

  • Resource Includes:

  • pne_nav_management_links

    • std_doc_man_pages

  • Standard Navigation:

    • commonBundle.js

    • commonNav.js