| Oracle® Fusion Middleware Services Reference Guide for Oracle Universal Content Management 11g Release 1 (11.1.1) Part Number E11011-01 |
|
|
View PDF |
| Oracle® Fusion Middleware Services Reference Guide for Oracle Universal Content Management 11g Release 1 (11.1.1) Part Number E11011-01 |
|
|
View PDF |
Page Request Services retrieve HTML pages. Page Handler Services manage library Web pages created by the Web Layout Editor. Frequently used services are marked with an asterisk (*) in the following list.
The following services are described in this section:
Service that deletes an existing search results template.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
name: The search results template name.
Example
IdcService=DELETE_RESULT_TEMPLATE name=test_template
Service that returns the Administration page in a browser. It does not load the server's configuration. If the user is not assigned the admin role or sub administrator rights, the service returns an error message.
Access Level: N/A (0)
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
PageName: The name of the page template.
Optional Service Parameters
Action: The action to execute. Usually set to GetTemplatePage.
Results
Local Data:
TemplateType
TemplateClass
TemplateFilePath
Response Template: Returns whatever template was passed as the value of the Page parameter. In standard usage this is ADMIN_LINKS (admin.htm).
Used By
Resource Includes:
pne_nav_admin_links
std_admin_pages
Templates:
ADMIN_LINKS (admin.htm)
IDC_ADMIN_PAGE (idc_admin_page.htm)
std_home_page.htm
Standard Navigation: commonNav.js
Example
To get the standard Administration page:
IdcService=GET_ADMIN_PAGE Page=ADMIN_LINKS Action=GetTemplatePage
Service that executes an HTML page request. This service is usually called from the browser interface. It executes the LOAD_DOC_ENVIRONMENT subservice.
Access Level: Read, Global, Scriptable (49)
Calls Subservice: LOAD_DOC_ENVIRONMENT
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
PageName: The name of the page template.
Optional Service Parameters
Action: The action to execute. Usually set to GetTemplatePage.
Results
Result Sets:
DocFormats (All rows and fields of the DocFormats database table.)
DocTypes (All rows and fields of the DocTypes database table.)
Local Data:
TemplateClass
TemplateFilePath
TemplateType
Response Template: Returns whatever template was passed as the value of the Page parameter.
Used By
Resource Includes:
calculate_doc_profile_urls
determine_wf_review_rendition_url
home_page_static_content
pne_nav_bookmark_links
pne_nav_shared_links
search_template_user_info_settings
std_js_bootstrap_vars
std_main_page_begin
std_query_page_link_args
xui_searchapi_results_action_form
Templates:
PNE_PORTAL_DOC_PROFILES_PAGE (pne_portal_doc_profiles_page.htm)
PNE_PORTAL_PERSONAL_URLS_PAGE (pne_portal_personal_urls_page.htm)
PNE_PORTAL_SAVED_QUERIES_PAGE (pne_portal_saved_queries_page.htm)
PNE_PORTAL_SYSTEM_LINKS_PAGE (pne_portal_system_links_page.htm)
PREVIEW_FRAMES (preview_frames.htm)
USER_INFO (user_info.htm)
Standard Navigation:
commonNav.js
Trays/layout.js
Trays/search_tray_tabs.htm
Other:
Redirect service for: SUBMIT_HTML_FORM, LOGIN, EDIT_USER_PROFILE, CONTINUE_SUBMIT_HTML_FORM, UPLOAD_NEW_COMPONENT, CANCEL_COMPONENT_INSTALL, UPDATE_COMPONENT_CONFIG, UNINSTALL_COMPONENT, SAVE_USER_TOPICS, PUBLISH_SCHEMA, EDIT_SCHEMA_VIEW_VALUES
Example
To get the home page the parameters are:
IdcService=GET_DOC_PAGE Page=HOME_PAGE Action=GetTemplatePage
To get the standard query page the parameters are:
IdcService=GET_DOC_PAGE Page=STANDARD_QUERY_PAGE Action=GetTemplatePage
Service that returns a Library page for dynamic assembly. This service can be used in two ways:
To load a library page for display directly in Content Server.
Used in the background in a hidden frame to dynamically generate or update nodes in the Library tree display.
The default template used by the DIRECTORY_PAGE service (dir_page.htm) is branched based upon the value of lmXML to perform one or the other of the two uses for the service. If lmXML is set to 1 (true), the template generates an XML object instead of an HTML page, then fires the libraryNodeLoadSequence to update the Library navigation tree.
Access Level: Read, Scriptable (33)
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
PageName: The name of the page template.
Results
Result Sets:
PageMap (result set containing local pages contained within this library node; fields: PageName, PageParent)
LinkList (result set containing listing of links contained within this library node; fields: LinkType, LinkData, LinkTitle, LinkDescription)
Local Data:
dSecurityGroup
HeaderText
LinkSelectedIndex
LocationInfo
OutOfDate
PageFunction
PageLastChanged
PageName
PageParent
PageTitle
PageType
PageUrl
restrictByGroup
TemplatePage
Response Template: null (During execution of the service, the TemplatePage value is set to DIRECTORY_PAGE (dir_page.htm) ).
Used By
Applets: Installer
Resource Includes:
calculate_all_doc_profile_urls
home_page_static_content
pne_nav_shared_links
std_main_page_begin
std_page_nav_bar
Standard Navigation: commonNav.js
Example
To get the index page the required parameters are:
IdcService=GET_DYNAMIC_PAGE PageName=index Action=GetTemplatePage
Service that delivers the navigation information for a particular user's page. If a browser optimally caches the JavaScript, this enables the browser to not request the URL on every page load. If the navigation data changes, a numeric ID which is added at the end of the URL is changed and the browser will reload the page.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that displays a Portal Design page. The most likely errors are when there is an error loading configuration information, an error retrieving the options list, or when the referenced HTML page is not found.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
Action: The action to execute. Usually GetTemplatePage.
PageName: The name of the page template. The following standard pages are displayed using this parameter:
Portal Design page: PNE_PORTAL_DESIGN_PAGE
System Links page: PNE_PORTAL_SYSTEM_LINKS_PAGE
Saved Queries page: PNE_PORTAL_SAVED_QUERIES_PAGE
Personal URLs page: PNE_PORTAL_PERSONAL_URLS_PAGE
Example
To get the Portal Design page, the parameters are:
IdcService=GET_PORTAL_PAGE Action=GetTemplatePage Page=PNE_PORTAL_DESIGN_PAGE
To get the Saved Queries page, the parameters are:
IdcService=GET_PORTAL_PAGE Action=GetTemplatePage Page=PNE_PORTAL_SAVED_QUERIES_PAGE
Service that executes a secure HTML page request. This service is usually called from the browser interface and is restricted to users with Write permission to at least one group. The most likely error is when the referenced HTM page is not found.
This service is identical to GET_DOC_PAGE except this service requires Write privileges to at least one security group, whereas GET_DOC_PAGE only requires Read access.
This service executes the LOAD_DOC_ENVIRONMENT subservice.
Access Level: Write, Global, Scriptable (50)
Calls Subservice: LOAD_DOC_ENVIRONMENT
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
Page: The name of the page template.
Optional Service Parameters
Action: The action to execute. Usually GetTemplatePage.
Results
Result Sets:
DocFormats (all rows and fields of the DocFormats database table)
DocTypes (all rows and fields of the DocTypes database table)
Local Data:
TemplateClass
TemplateFilePath
TemplateType
Response Template: Returns whatever template was passed as the value of the Page parameter
Used By
Resource Includes: pne_nav_management_links
Templates: std_home_page.htm
Example
To get the content management page the parameters are:
IdcService=GET_SECURE_PAGE Page=DOC_MANAGEMENT_LINKS Action=GetTemplatePage
Service that returns the portal page content. This service is used during the page assembly process for dynamic pages. Using the Web Layout Editor applet, select Options then Update Portal. The content shown on that screen is the content that is returned from Content Server if you run this service.
Location: IdcHomeDir/resources/core/templates//std_services.htm
Service that rebuilds the static Web layout structure as defined in the Web Layout Editor. Returns the entire page list in HDA format. This service is asynchronous and the action is performed in a background thread. This service can only be executed in the context of the Content Server and only completes successfully if a connection is made to the Content Server.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
IsRebuild: Enables a rebuild.
Must be set to true (1) for the server to rebuild the Web layout pages.
Default is false (0).
PageFunction: Must be set to GetPageList.
Example
IdcCommand command file format (rebuild the Web layout pages):
# Rebuild the entire search index IdcService=PAGE_HANDLER PageFunction=GetPageList IsRebuild=1
HDA format (rebuild the Web layout pages):
@Properties LocalData IdcService=PAGE_HANDLER PageFunction=GetPageList IsRebuild=1 @end
Service that saves a search query in the User Profile for the current user.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
The parameters for this are exhibited in the std_page.htm in the dynamic HTML definition query_save_for_personalization_list_form_common_fields. Parameters include the following:
queryText
queryTitle
sortField
ResultCount
Service that updates the personal URLs in the User Profile for the current user.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
Action: The action to execute. Usually set to GetTemplatePage.
Page: The name of the page template.
titleEd: The link name to be displayed in the portal navigation bar.
websiteEd: The URL to be saved as a link.
Example
IdcService=PNE_UPDATE_PERSONAL_URLS Page=PNE_PORTAL_PERSONAL_URLS_PAGE Action=GetTemplatePage titleEd=Stellent websiteEd=http://www.stellent.com
Service that updates the System Links in the User Profile for the current user.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
Action: The action to execute. Usually set to GetTemplatePage.
PageName: The name of the page template.
Example
IdcService=PNE_UPDATE_PORTAL_INFO Page=PNE_PORTAL_DESIGN_PAGE Action=GetTemplatePage
Service that saves all global includes used during the page assembly process for dynamic pages. This service runs when you update the portal page from the Web Layout Editor.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
IsRebuild: Enables a rebuild of the portal page.
Must be set to 1 (true) for the Content Server to update the portal page.
Default is 0 (false).
PageFunction: Must be set to GetPageList.
Example
IdcService=SAVE_GLOBALINCLUDES PageFunction=GetPageList IsRebuild=1
Service that updates a search results template.
When you launch the Web Layout Editor applet, select Options, select Query Result Page, and click Add, Delete, or Edit, enter template information, and click OK, this service is executed.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Note:
See the following example of the entries required to add a new query result template in HDA format.Example
IdcCommand command file format:
IdcService=UPDATE_RESULT_TEMPLATE
HDA file format (adds a new query result template called my_research_template).
@Properties LocalData
IdcService=UPDATE_RESULT_TEMPLATE @end @ResultSet ResultPageUpdates 6 name formtype filename outfilename flexdata description my_research_template ResultsPage Text2<$dDocAuthor$><$dSecurityGroup$>Text1<$dDocTitle$> testing the update template sevice @end
Important:
Notice that there are two blank lines between the ResultsPage entry and the Text2 entry. This is required because there are no values for filename and outfilename (the blank lines define the empty values).
|
 Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
