ADD_WEB_APP APPEND_FILE_CACHING_INFO GET_DYNAMIC_CONVERSION

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

4.4.11 GET_DOCRULE

Service that returns the rule definition file for the specified rule. The returned data is returned in a data binder and contains all the information used to define the rule. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ dpRuleName: The name of the profile to be used.

4.4.12 GET_DOCRULES

Service that returns the listing file for the content rules. The listing file contains the name and description for each rule in the system. Location: IdcHomeDirresourcescoretemplatesstd_services.htm

4.5 File Services Core Oracle Content Server

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: ■ ADD_WEB_APP ■ APPEND_FILE_CACHING_INFO ■ GET_DYNAMIC_CONVERSION ■ GET_DYNAMIC_CONVERSION_SUB ■ GET_DYNAMIC_URL ■ GET_TEMPLATE_CONVERSIONS ■ GET_WEB_APP_STATUS ■ LOAD_RESOURCE_FILE ■ REMOVE_WEB_APP ■ SAVE_TEMPLATE_CONVERSIONS

4.5.1 ADD_WEB_APP

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: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ pathToWAR: Complete path to the WAR file.

4.5.2 APPEND_FILE_CACHING_INFO

Subservice used by GET_SYSTEM_AUDIT_INFO to return information on the System Audit Info page. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Core Oracle Content Server Services 4-87

4.5.3 GET_DYNAMIC_CONVERSION

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: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ 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 parameter 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. Optional Service Parameters ■ conversionTemplate: The conversion template. This parameter can be passed to the service to override the template conversions criteria page. Note: dDocName should be included in all requests for content items where the requester knows the dDocName. Error messages in the Oracle Content Server system assume that it is present, as do other features such as forms. Important: Either the content item revision ID dID must be specified or a Content ID dDocName with the RevisionSelectionMethod parameter. 4-88 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management ■ 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 Oracle Content Server URL as follows parameter is in bold: http:server namecsidcplg?IdcService= GET_DYNAMIC_ CONVERSIONdDocName=aTestRevisionSelectionMethod= LatestReleaseduseDocInfoCache=false ■ conversionRule: Specifies the conversion rule to be used, rather than allowing the conversion rule to be selected by the conversion rule criteria. Example ■ 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

4.5.4 GET_DYNAMIC_CONVERSION_SUB