Digging Webcenter Services Part II : Document Services – Part II

By rajesh | January 11, 2014 | 0 Comment

Let’s finish what we have started earlier.

What we did, we tried to explore the Oracle Webcenter Different Document Services.

Let’s go on the same way, we have left with few document services to complete : Following :

1)       Document Navigator

2)       Upload

3)       Rich Text Editor

4)       Document Viewer

5)       Mini Properties

6)       Recent Documents

7)       List Viewer

So, in this post, we need to explore all these above mentioned Document Services.

All these services are self-explanatory.  Anyone can easily predict what would be the expected behavior of all these services.

Ensure that you have followed the earlier post here :

http://smconsultant.com/digging-webcenter-services-part-ii-document-services-part-i

It will lead you to few pre requisites to implement document services and how you would be able to configure and implement these services using jdeveloper 11g.

Just to give you a note, you can implement all these document services using the Content Repository Data Controls. You just need to drag and drop these data controls as any of the above mentioned document services.

Another way, which we will be following, is to Configure these task flow manually in jdeveloper.

Let’s take one by one :

1)       Document Navigator :

Simply create an application, based on the Oracle webcenter framework and create a JSF page on which you will be going to configure your task flow.

 

Go to Resource Palette in jdeveloper and expand the Task Flow folder under Oracle webcenter service catalog.

Scroll down a bit and you will find every available document service.

Our target will be Document Navigator.

 

Drag and drop the document navigator task flow on JSF page and choose it to be a static region.

You will find this screen shot:

Document Navigator Task Flow Properties

 

Now, we will discuss all the parameters one by one :

connectionName : The name of the content repository connection which you have created in jdeveloper. If no value is selected, the default connection specified by the application developer or administrator is used.

 

Default: The connection selected as default in the Create Content Repository Connection dialog box by the application developer, which can be changed by the administrator.

 

startFolderPath : The name of the folder to use as the root folder in the current task flow instance.

 

This is a content-scoping parameter that assists with determining the source and range of content to display in the task flow instance.

There is no need to set this value for task flows that display the content of the current space’s default root folder. But it is useful, for example,

when you want the start folder to be other than a space’s default root folder and when you want to display content from another space.

Example:

■ ${‘/SMConsultantSpaces/monty/Secure’}

■${‘/Contribution Folders/test’}

You can specify an EL expression to set this value.

Default: The root folder of the content repository configured with the specified connection for the current Space.

 

resourceId  The currently focused resource. This value can be a folder ID or a document ID.

 

The resourceId value is checked for coherence with the connectionName and startFolderPath values, and influences their default values when they are not explicitly specified. For example,

if resourceId alone is specified, the connectionName value will be inherited from it and the startFolderPath will be either the resource itself for a folder or the parent folder for a file.

 

readOnly  Specifies whether to disable and hide all content management operations:

 

■ ${true}: Disable content management.

■ ${false} (default): Expose content management to users.

 

showDocuments Specifies whether the navigation tree shows documents and folders, or folders only:

 

■ ${true} (default): Show documents and folders.

■ ${false}: Show folders and hide documents.

 

featuresOff  A list of disabled features for the task flow. Use commas or spaces to separate items.

 

Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd,

editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search,

advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${‘search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout,

editoffice, edithtml, delete, sidebars, history’}

 

pageSize  The maximum number of rows to show in the task flow. If the listing of folders and files in the task flow is larger than the specified number of rows, the task flow displays a scroll bar. Default: 27

 

Typical scenarios where you may wish to alter this value are:

■ The majority of end users have bigger screens, allowing for the display of more rows.

■ You want to fit this task flow into a smaller area of a page.

Note: If you set pageSize to a value that is too big for the size of the screen, the end user will experience difficulty coordinating the task flow scroll bar with the application scroll bar.

 

Now Say okay, and you will be able to see the region in the design section of your JSF page.

 

What we have left with one last thing, Run the page to see the content on the page. Like this :

Now play with this navigator to explore your repository on front end only.

Output Of Document Navigator

2)       Document Upload :

Just like earlier, for your ease of use, I am going to use panel tabbed component and will put every service in separate tabs.

 

The Document Upload task flow displays the Upload dialog to allow users to upload new documents to the page.

Again go to resource palette, drag and drop Document upload as a static region on JSF page.

You will see this below mentioned screen shot :

Document Upload Task Flow Properties

 

Let’s discuss all the available parameters one by one :

destinationID The currently focused resource. This value specifies a folder ID to upload a document into that folder.

 

destinationSelectionEnabled Specifies whether or not the destination folder can be changed:

 

■ ${true}: Display destination folder as an input text box along with a Browse button.

■ ${false} (default): Display destination folder as read only text.

 

Refer featuresOff from the earlier document services, we have just discussed.

Say ok and run the page to see the outcome of this document upload service.

Output Of Document Upload Service

 

You can utilize this service to upload your documents to repository from your front end only.

At max, you will be able to upload 10 files at one time.

Use it, play with it.

 

Another one says :

 

3)       Document Rich Text Editor :

Same old steps to follow but a different service to implement.

The Rich Text Editor task flow displays an HTML or wiki document in the Rich Text Editor.

Go to your resource palette, drag and drop Rich Text editor service as a static region.

Follow this screen shot :

Rich Text Editor Task Flow Properties

Now, let’s discuss the unique parameters to this service here one by one :

destinationID The currently focused resource. This value can be a folder ID to create a new document in that folder, or a document ID (as shown in the properties pane of the Document Viewer task flow) to edit an existing document.

Refer FeaturesOff from the earlier services.

initialSidebar Specifies a pane to display in the sidebar of the Document Viewer.

Valid values are:

■ ${‘comments’} (default). Displays a Comments pane.

■ ${‘history’}. Displays a History pane.

■ ${‘tags’}. Displays a Tags pane.

■ ${‘links’}. Displays a Links pane.

■ ${‘recommendations’}. Displays a Recommendations pane.

■ ${‘relatedItems’}. Displays a Related Items pane.

■ ${‘docInfo’}. Displays a Properties pane.

Choose your option based on your business requirement and say ok to run the page and to see the outcome like this :

Output Of Rich Text Editor Service

Even you will be able to create a Wiki link for any document which you can edit parallel.

Explore it at your best and utilize.

4)       Document Viewer :

The Document Viewer task flow displays the contents of a folder or a preview of an individual file in the default template for its file type.

Oh, Same old step to see the below screen shot for the parameters :

Document Viewer Task Flow Properties

Nothing new but just to highlight that you can’t expose any folder like document viewer.

So, last option, you only left with the documents.

Follow the same format like in above screen shot.

Run the page and see this screen shot :

Output Of Document Viewer Service

You see, it is quite a descriptive service.

Your document will get render in the ADF component. Also you will be able to see the basic and advance properties for this selected document on the page itself.

Leverage it as per your business requirement and move on to next service.

5)       Mini Properties :

The Document Mini Properties task flow displays the basic properties of a selected file in a read-only view. This task flow is available for all file types.

Make yourself comfortable now to reach to the parameter screen for any of the service now.

See this screen shot:

Mini Properties Task Flow Properties

 

Just one parameter and that too very easy to understand and to configure as well off course.

So, see the outcome as well :

Output Of Mini Properties Service

 

6)       Document List Viewer :

The Document List Viewer task flow displays folders and files in a single pane as a flat listing. In this task flow, users can navigate a folder hierarchy, and customize search queries. While this task flow may be useful for a specific need, its search functionality

is replicated and enhanced by the Content Presenter task flow.

Go till the parameter box for the service by drag and dropping this service from resource palette to JSF page.

See this : Now this is something which we need to take care. See all these parameters one by one :

Document List Viewer Task Flow Properties - I

 

taskFlowInstId The unique identifier for this task flow instance, used internally to maintain the association of the task flow instance with its customization and personalization settings and to manage saved queries. The value is generated automatically when you add individual files or the content of folders to your page from the Application Resources Panel, displaying the content in a Document List Viewer task flow. The value is blank when you add a Document List Viewer task flow onto your page from the Resource Palette.

Enter or edit this value to set the unique identifier for the task flow.

showFolders

connectionName.

startFolderPath : Refer all these three parameters from the above discussed services.

creator A filtering value to limit the display of task flow content to folders and files created by a particular user. Enter the user name as specified by the user login credentials. Only one user name may be entered. If no value is entered, then content created by any user is shown.

Example: ${weblogic}

Document Viewer Task Flow Properties - II

 

Scroll down this dialog box and see the other parameters  and discuss these one by one :

lastModifiedAfter A filtering value to limit the display of task flow content to folders and files last modified after a specified date and time. If no value is entered, then content modified in the last three months is shown.

The value uses the ISO 8601 format: ${‘yyyy-mm-ddThh:mm:ss.sssTZD’}1

Example: ${‘2011-03-17T18:24:36.000+01.00’}

lastModifiedBefore A filtering value to limit the display of task flow content to folders and files modified before a specified date and time. If no value is entered, then the last modification date is applied.

The value uses the ISO 8601 format: ${‘yyyy-mm-ddThh:mm:ss.sssTZD’}1

Example: ${‘2011-03-17T18:24:36.000+01:00’}

lastModifier A filtering value to limit the display of task flow content to folders and files last modified by a particular user. Enter the user name as specified by the user login credentials. Only one user name may be entered. If no value is entered, then all modified documents are shown.

createdAfter A filtering value to limit the display of task flow content to folders and files created after a specified date and time.

The value uses the ISO 8601 format: ${‘yyyy-mm-ddThh:mm:ss.sssTZ’}1

Example: ${‘2011-03-17T18:24:36.000+01:00’}

createdBefore A filtering value to limit the display of task flow content to folders and files created before a specified date and time.

 

Set these all parameters as per your business requirements. And click on the ok to see the region.

Run this page to see the outcome of the service :

Output Of Document Viewer Service

 

I have expand the menu option as well on the page and took the screen shot.

 

So, That’s all for now. Use this sample application to explore all these service.

DocumentNavigator-RemainingDocumentServices

0 Comments

Leave a Reply

Your email address will not be published. Required fields are marked *