Calling Services Using Persistent URLs

Using Services 2-5 ■ Component Object Model COM integration using the ActiveX utility or the IntradocClient OCX component

2.1.5 Calling Services Using Persistent URLs

In this integration method, all of the necessary information for the service call is sent to the Oracle Content Server system through the URL. The following is a typical URL; in this case, it is the URL for the Home page: http:cs.example.comcsidcplg? IdcService=GET_DOC_PAGEAction=GetTemplatePagePage=HOME_PAGE ■ http:cs.example.com is the web address of the Oracle Content Server instance. ■ csidcplg is the path to the Web server filter. ■ IdcService=GET_DOC_PAGE tells the Oracle Content Server system to execute the GET_DOC_PAGE service. ■ Action=GetTemplatePage tells the Oracle Content Server system to return the results using a specified template page. This parameter is specific to the GET_ DOC_PAGE service example. ■ Page=HOME_PAGE tells the Oracle Content Server system which template page to use. This parameter is specific to the GET_DOC_PAGE service example. ■ The question mark ? indicates the end of the Web server path and the beginning of Oracle Content Server parameters. ■ Ampersands are used as separators between Oracle Content Server parameters. ■ You can include certain Idoc Script variables in a URL to affect page display at the time of the page request. This is useful for troubleshooting or for customizing your Oracle Content Server pages. Troubleshooting Examples ■ IsJava=1 ■ IsPageDebug=1 Customization Examples ■ StdPageWidth=1000 ■ dDocType=HRForm Example The following example describes the steps that occur when a persistent URL is used to request a dynamic page from the Oracle Content Server system.

1. When a user clicks the Administration link in the navigation area, a request for the

GET_ADMIN_PAGE service is sent to the Web server. The URL of the Administration link contains the following commands: IdcService=GET_ADMIN_PAGEAction=GetTemplatePagePage=ADMIN_LINKS Note: For more detailed information on available integration methods, see the Oracle Fusion Middleware Developers Guide for Oracle Universal Content Management. 2-6 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management 2. The Web server recognizes this request as an Oracle Content Server function and sends the specific request to the Oracle Content Server system. 3. When the Oracle Content Server system has processed the request, it passes the result back to the Web server. In the case of the Administration link, the GET_ ADMIN_PAGE service: ■ Provides a login prompt if the user is not currently logged in. ■ Verifies that the user has admin permission. ■ Assembles the Administration page using the ADMIN_LINKS template. ■ Returns the assembled web page to the Web server. 4. The Web server delivers the results of the Oracle Content Server service to the originating Web browser client. Example The following example describes the steps that occur when a persistent URL is used to perform a search request. 1. When a user clicks the Search button on the standard Search page, a request for the GET_SEARCH_RESULTS service is sent to the Web server. The URL for the search request specifies the service to execute, the search criteria, and the result parameters: IdcService=GET_SEARCH_RESULTSQueryText=oracleftx=1 AdvSearch=TrueResultCount=25SortField=dInDateSortOrder=Desc 2. The Web server recognizes the request as a Oracle Content Server function, and sends the specific request to the Oracle Content Server system. 3. The Oracle Content Server system passes the request to the search engine. 4. The search engine returns the search results to the Oracle Content Server system. 5. Based on the user login and security permissions, the Oracle Content Server system assembles the search results page and returns it to the Web server. 6. The Web server delivers the results to the originating Web browser client.

2.1.6 Customizing Locale Parameters