File services are those which manipulate files, such as dynamic conversion and resource files. Frequently used services are marked with an asterisk (*) in the following list.
The following file services are described in this section:
Used with the internal Tomcat engine.
Service used to add a WAR file to the Tomcat engine and to enable the contained JSP pages.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
pathToWAR: Complete path to the WAR file.
Subservice used by GET_SYSTEM_AUDIT_INFO to return information on the System Audit Info page.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that returns a content item as an HTML or XML file converted by Dynamic Converter. This is available if the Dynamic Converter component is installed and enabled.
Given a dID or a dDocName and a RevisionSelectionMethod parameter, the service determines the filename of a particular rendition of the revision and returns that file to the client. The most likely errors are mismatched parameters or a request for a content item that does not exist.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Note:
dDocName should be included in all requests for content items where the requester knows the dDocName. Error messages in the Content Server assume that it is present, as do other features such as forms.Additional Required Service Parameters
Important:
Either the content item revision ID (dID) must be specified or a Content ID (dDocName) with the RevisionSelectionMethod parameter.dID: The generated content item revision ID.
If dID is not specified, dDocName and RevisionSelectionMethod must specified.
A rendition of the revision of the content item with this ID is returned, if it exists, and the RevisionSelectionMethod parameter does not exist or has the value Specific.
dDocName: The Content ID of the content item.
If dDocName is not present, dID must be present and RevisionSelectionMethod must not be present.
If RevisionSelectionMethod is present, a rendition of a revision of the content item with this name is returned, if it exists. If RevisionSelectionMethod is not present, dDocName is used in error messages.
RevisionSelectionMethod: The revision selection method.
If present, dDocName must be present. The value of this variable is the method used to compute a dID from the specified dDocName. Its value can be Specific, Latest, or LatestReleased.
If the value is Specific, the dDocName is ignored, and dID is required and is used to get a revision. If the value is Latest, the latest revision of the content item is used to compute the dID. If the value is LatestReleased, the latest released revision of the content item is used to compute the dID.
conversionTemplate: The conversion template. This parameter can be passed to the service to override the template conversions criteria page.
DCViewFormat: The file to be converted and displayed, Native, Alternate, or WebViewable.
useDocInfoCache: Disables the caching mechanism while requesting an individual content item. It applies only to the single request. You might use this parameter to test or troubleshoot the optimized query feature. To use this parameter, append it to your Content Server URL as follows (parameter is in bold):
http://<server name>/cs/idcplg?IdcService= GET_DYNAMIC_CONVERSION&dDocName=aTest&RevisionSelectionMethod= LatestReleased&useDocInfoCache=false
conversionRule: Specifies the conversion rule to be used, rather than allowing the conversion rule to be selected by the conversion rule criteria.
IdcCommand command file format:
# Retrieve a web-viewable revision IdcService=GET_DYNAMIC_CONVERSION dDocName=corporatereport RevisionSelectionMethod=LatestReleased DCViewFormat=WebViewable
HDA format:
@Properties LocalData IdcService=GET_DYNAMIC_CONVERSION dID=54321 @end
Subservice used by GET_DYNAMIC_CONVERSION.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that is used internally to extract information from the Web-viewable URL to determine if it maps into the /weblayout directory. If it does not map then it throws an exception.
This service is usually used to retrieve a dynamic page. This service is called from the Web server to deliver dynamic content Web-viewable files. It is called in the core to dynamically change the response page for a service.
Access Level: Read, Scriptable (33)
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
fileUrl: The relative URL for the item. This can be a checked-in item in the Content Service, a Java Script file for Schema or Layout Manager, or an image file from the /images directory.
Result Sets: DocFormats, DocTypes
Local Data:
ref:dDocAccount
ref:dDocName
ref:dDocType
ref:dExtension
ref:dSecurityGroup
ref:hasDocInfo
ref:isLatestRevision
SourceID
HCSP/F metadata (including custom XML data between idcbegindata and idcenddata tags)
Response Template: null (Returns the file requested in the fileUrl parameter.)
Service used to dynamically convert a document residing in an external collection. It is equivalent to GET_DYNAMIC_CONVERSION with the exception that it retrieves the content information for the item from the external Verity search collection. Verity is an add-on product available for purchase for use with Content Server.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
VdkVgwKey: The look-up key into Verity.
sCollectionID: The identifier for the external Verity collection.
Service used by the Dynamic Converter to retrieve the list of templates that are used during conversion.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Used with the internal Tomcat engine.
Service that returns the status of the internal Tomcat engine. For internal use only.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that returns a resource file.
Given a dID or a dDocName and a RevisionSelectionMethod parameter, the service determines the filename of a particular rendition of the revision and returns that file to the client.
The most likely errors are some form of mismatched parameters or a request for a revision or rendition that does not exist.
Note:
It is recommended that dDocName be included in all requests for content items where the requester knows the dDocName. Error messages in the Content Server assume that it is present, as do other features such as forms.Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
Important:
Either the content item revision ID (dID) must be specified or a content item name (dDocName) and a RevisionSelectionMethod parameter must be specified.dID: The generated content item revision ID.
If dID is not specified, dDocName and RevisionSelectionMethod must specified.
A rendition of the revision of the content item with this ID is returned, if it exists, and the RevisionSelectionMethod parameter does not exist or has the value Specific.
dDocName: The Content ID for the content item.
If dDocName is not present, dID must be present and RevisionSelectionMethod must not be present.
If RevisionSelectionMethod is present, a rendition of a revision of the content item with this name is returned, if it exists. If RevisionSelectionMethod is not present, dDocName is used in error messages.
RevisionSelectionMethod: The revision selection method.
If present, dDocName must be present. The value of this variable is the method used to compute a dID from the specified dDocName. Its value can be Specific, Latest, or LatestReleased.
If the value is Specific, the dDocName is ignored, and dID is required and is used to get a rendition. If the value is Latest, the latest revision of the content item is used to compute the dID. If the value is LatestReleased, the latest released revision of the content item is used to compute the dID.
Rendition: The content item rendition. This parameter specifies the rendition of the content item and can be set to Primary, Web, or Alternate. If Rendition is not present, it defaults to Primary.
If the value is Primary, the primary rendition of the selected revision is returned.
If the value is Web, the Web-viewable rendition of the selected revision is returned.
If the value is Alternate, the alternate rendition of the selected revision is returned.
IdcService=LOAD_RESOURCE_FILE dID=456
Used with the internal Tomcat engine.
This service is used to remove a WAR file from use with the internal Tomcat engine. For internal use only.
Location: IdcHomeDir/resources/core/templates/std_services.htm