Monday, December 17, 2012

WebCenter Content Interface Branding for 11g - Part 1


This component is not much in terms of complexity but it is called for by nearly every client I have ever worked with. The primary objective: Can you change the Oracle logo to our logo?
Long ago it also occurred to me that there is another thing that would be handy as well: tell the user what instance they are logged into. Typically this is not an issues because most users will be in the production instance, and in truth, most of them are not aware of the development and testing instances. But after seeing a team member get confused on the instance and begin to test in production, I decided that the component needed to also state the instance name as well.

Requirements

So the requirements of this component are two:
1.       Change the logo to the customer’s logo
2.       Add the instance name to the heading
Static Home Page


Login Page


Dynamic Pages


Analysis of the requirements

By heading we mean to change this part of the interface that is common to both the top menus and the trays layouts:

The Oracle logo needs to change and the product name (“WebCenter Content”) will be extended to add the value of the environment variable InstanceName to it. The result will be the following heading:

Obviously we need to have the new logo image. But we also need to know where the other parts of the puzzle are.

Pages to change

The logo and heading appear on three pages:

·         The static home page

·         The login page



·         The dynamic page

On the dynamic page the heading is the same for the trays layout and the top menus layout.

Location of the images

By viewing the image information (in FireFox this is a right click – View Image Info) on the three pages we see that the images are as follows:
·         The static home page
o   http://dev:16200/cs/images/stellent/mailheadinglogo.gif
·         The login page
o   http://dev:16200/cs/resources/layouts/Trays/Oracle/oracle_logo.png
o   http://dev:16200/cs/resources/layouts/Top%20Menus/Oracle/oracle_logo.png
·         The dynamic page
o   http://dev:16200/cs/resources/layouts/Trays/Oracle/oracle_logo.png
o   http://dev:16200/cs/resources/layouts/Top%20Menus/Oracle/oracle_logo.png

Instance Description

Lastly, the Instance Description is an environment variable in the config.cfg file for the instance and can be set by manually editing the file or by using the SystemPropertiesapplet for the instance.
o   InstanceDescription=Development instance for CS

System changes needed

In order to accomplish the requirements for this component we will need to research and locate the templates, resources, queries, services and other parts of the system that require change.
My method is to start with what we know and go from there. What we know is the image names. So the first thing is to search the templates and idoc resources for the image file names. In 10g these were in the …/shared/config directory. In 11g, these have moved and are now in the WebCenter Content Home (typically Oracle_ECM1) under the …/ucm/idc/resources/core directory. My development instance in installed in a linux OS, so I can open a terminal to that directory and use grep to locate the files containing these image file names.

stellent/mailheadinglogo.gif

This image is called out in the following templates
·         ./templates/reviewer_mail.htm
·         ./templates/subscription_mail.htm
·         ./templates/contributor_mail.htm
·         ./templates/pr_publisher_mail.htm
·         ./templates/clbra_mail.htm
·         ./templates/query_notification_mail.htm
·         ./templates/reject_mail.htm
·         ./templates/error_page.htm
·         ./templates/pr_contributor_mail.htm
It is also referred to in the home_page_static_content resource in the ./idoc/std_page.idoc file.
This actually presents a small question that I would validate with the client. The requirement is the heading logo in the web pages. There is no mention of the logos in the various mail templates. So if they wish these to change then I would amend the requirement to include them. For this component we will leave these template changes to the reader as an exercise to extend the component. This article will only change the resource in the std_page.idoc file.

oracle_logo.png

This image is referred to in two templates:
·         ./templates/top_menus_layout.js
·         ./templates/trays_layout.js
In these templates, a variable (logoImage) is set to the image name. So we grep for the logoImage variable and find that it is in the std_nav.idoc file in thestd_navigation_header_top_row resource.
I also noticed that this same resource sets up the entire header row, including the description we want to adjust. It is in a variable called headerDescription.  Greping for this locates it in the std_javascript_header_functions resource of the std_page.idoc file.

What about the admin server?

The Oracle logo obviously appears in the admin server pages as well. But I have never had a client that wanted these pages to be changed since only the administrators would ever see them. But for completeness of this analysis we will include this as well. Using the same logic as the main interface analysis, the image used is the casbanner.png. And using grep to locate it, we find it in the admin_page_begin resource of the ./idoc/admin_page.idoc file.
Like the mail templates above, this change will be left to the reader as another exercise to extend the component.

New image considerations

When we replace the logo images we need to consider the shape of the image being replaced. The original images are
Image
width
height
mailheadinglogo.gif
133
19
oracle_logo.png
119
25
casbanner.png
119
25

When we consider replacing these with our new logo, it would be convenient if the new logo matches these dimensions but that is not always the case so we will need to keep that in mind when we make the component so that we maintain the aspect ratio of our new image.
We could also consider a component that would simply overwrite these images with our new image.  That would work as well but it would require that aspect ratios match exactly in order for layouts to be maintained properly.

Our new image, , is 200 x 100 in a file named sena.gif.

Design of the component

The analysis above indicates that our design is relatively simple. There will be three primary parts to the component:
1.       Templates – the top_menus_layout.js and the trays_layout.js templates will be overridden to use the new image.
2.       Resources
a.        the the home_page_static_content resource will be overridden to include the new image and its size as well as the page description
b.      std_navigation_header_top_row will be overridden to adjust the logo image size
c.       std_javascript_header_functions will be overridden to adjust the description
3.       Publish – the new images will be published to the weblayout directory structure to support the templates.
It is possible that during the creation and testing of the component that other templates or resources may be impacted.

Testing Considerations

As with any component, any time an oPatch is applied or the software is upgraded, this component should be tested. For this component it is relatively simple to regression test. Simply pull up the overwritten templates and resources and make sure that they are the same with exception of the change made.
Other than that, the standard testing is sufficient: no errors in the Content Server logs or in the Server Output.

To be Continued in part 2...

31 comments:

  1. Students find Finance Coursework Writing Services as being of great assistance since they are able to complete their finance essay writing services and finance research paper writing services on time.

    ReplyDelete
  2. thanx for sharing this guide this is very helpful for us
    if you need essay rewriter expert then hire experts and get the result you can also hire essay writing help and get result our company also provide many services like assignment help
    and custom writing and many more

    ReplyDelete

  3. Nice post. I used to be checking constantly this blog and I am impressed! Extremely useful info particularly the ultimate section 🙂 I take care of such information a lot. I was seeking this certain information for a long time. Thank you and best of luck.
    time and tide wait for none

    ReplyDelete
  4. Exceptional post however , I was wanting to know if you could write a litte more on this topic? I’d be very thankful if you could elaborate a little bit further. Thanks 사설토토사이트

    ReplyDelete
  5. I just wanted to say that I love every time visiting your wonderful post! Very powerful and have true and fresh information. Thanks for the post and effort! Please keep sharing more such a blog.

    ReplyDelete
  6. Thank u for the great materail which u have provided with the diagram and tables . I appreciate suh kinda work. Ialso like to do online essay revision in the same way

    ReplyDelete
  7. A very awesome blog post. We are really grateful for your blog post. You will find a lot of approaches after visiting your post.
    Hi! We are water treatment company in uae Great points made up above! And
    Ultraviolet water Sterilizer ( 12 GPM-HTM ) thanks…
    I think this is one of the most important information for me. And i am glad reading your article. But should remark on few general things…

    ReplyDelete
  8. Thank you for posting such a great article. Keep it up mate.

    4movierulz App 2021

    ReplyDelete
  9. Cara mengecilkan perut Sometimes we have tried hard to reduce the stomach, such as regularly doing sports, but it's hard. In addition, there are also those who do not have time to exercise. Ngobrol Sehat It is normal that people are looking for various ways to reduce the stomach naturally without exercise. Therefore, you can do these methods at home. Ngobrol Sehat

    ReplyDelete
  10. I really enjoy your web’s topic. Very creative and friendly for users. Definitely bookmark this and follow it everyday.

    온라인카지노

    ReplyDelete
  11. You may want to get fit not mater in which life stage you are, but the problem is we don't find enough time to do effort. I was also the same but then I read the Paul Giamatti Weight Loss and David Goggins Weight Loss.

    ReplyDelete
  12. Books offer us so many things without asking for anything in return. Books leave a deep impact on us and are responsible for uplifting our mood. That's great, you may also like to check these post as well:
    Click Here for Robert Greene book daily laws, Click Here for Novel Jannat Kay Pattay, Click Here for Bahishti Zewa in PDF and Click Here Romantic Novel, Click Here for Hasil Novel in PDF.

    ReplyDelete
  13. What a wonderful blog I found, and you've shared some incredible adventures. I'm a university student who, like you, wants to travel the world but doesn't have the opportunity due to my employment, which interferes with my studies on occasion; nonetheless, academic assistance ensures that I always obtain the best homework, and I appreciate you sharing your experiences with us.

    ReplyDelete
  14. Hi, after reading this remarkable piece of writing i am as well happy to share my experience here with friends. This is a very interesting article. Please, share more like this! Feel free to visit my website;
    야설

    ReplyDelete
  15. Greetings! Very helpful advice within this post! It's the little changes that will make the most important changes. Thanks for sharing! Feel free to visit my website;
    한국야동



    ReplyDelete
  16. I am very happy when these blog posts read because blog post was written in a good manner and write on a good topic. Thanks for sharing valuable information. Feel free to visit my website; 국산야동


    ReplyDelete
  17. Excellent Blog! I would like to thank for the efforts you have made in writing this post. I am hoping the same best work from you in the future as well. Feel free to visit my website; Excellent Blog! I would like to thank for the efforts you have made in writing this post. I am hoping the same best work from you in the future as well. Feel free to visit my website; 일본야동



    ReplyDelete
  18. Hi there to every body, it’s my first go to see of this webpage; this blog carries amazing and genuinely fine data designed for visitors. Feel free to visit my website;
    일본야동

    ReplyDelete
  19. Thank you for sharing this great article. 888b hopes you will have many more articles for everyone to read.

    ReplyDelete
  20. In the event that you are searching for a genuine exposition administration fit for creating a whole extensive paper at an exceptionally fair cost, then you have come to pay for paper the right objective. We comprehend that every client will have their own one of a kind necessities, so we will makes a point to tweak each part of the given prerequisites! We comprehend that it is dangerous to adjust everything in the to-do book.

    ReplyDelete
  21. The vacation trades offered are evaluated a variety of in the chosen and simply good value all around the world. Those hostels are normally based towards households which you’ll find accented via charming shores promoting crystal-clear fishing holes, concurrent of one’s Ocean. Hotels Discounts 메이저사이트

    ReplyDelete
  22. Aside from loosened up muscles, your temper will likewise improve, hence furnishing you with an unwavering discernment. A decent outlook will hoist your temperament, assisting you with managing viably during upsetting circumstances. Visit female to male spa near me

    ReplyDelete
  23. Our centre has all the best equipment and highly trained staff, which makes it a complete solution to your body spa and massage needs. Visit our spa today if you're looking for the best and most ideal spa in Bangalore.Visit massage parlour near me

    ReplyDelete
  24. Myotherapy, also known as massage therapy, is the art of manipulating and kneading a person's soft-tissues or muscles in order to improve their health or well being. Visit body to body spa near me

    ReplyDelete
  25. In our busy lives, it is necessary to relax and unwind from all the daily stress. There are a variety of ways in which we can do this such as going for a holiday or spending time with friends and family. One of the most popular methods of relaxation is Visit massage center near to me

    ReplyDelete
  26. Have you ever seen GREEN FLOWER AGATE? It's seriously so beautiful! We got a bunch in all different sizes! And we also gotflower agate flame, flower agate exhibits special patterns that quite resemble cherry blossom trees.

    ReplyDelete