Académique Documents
Professionnel Documents
Culture Documents
Best Practices
Content Server Administration: Healthy
Habits and Best Practices
Contents
Introduction .................................................................................................................4
The Top 10 Habits ....................................................................................................... 5
1. Maintain a test lab that faithfully reflects your production
environment. ......................................................................................................... 5
2. Know your opentext.ini. Love your opentext.ini. .............................................. 6
3. Familiarize yourself with the Content Server Release Notes........................... 7
4. Familiarize yourself with the Content Server Schema
documentation. ..................................................................................................... 8
5. Attend Content Server Administrator training. ................................................. 8
6. Keep a backup of all your changes. Document everything. ............................ 8
7. Run regular reports and diagnostics. ................................................................ 8
8. Stay Fresh. ............................................................................................................ 9
9. Plan. Test. Implement. Repeat. ............................................................................ 9
10. Discover and explore the OpenText Knowledge Center................................. 10
Interaction with OpenText Customer Support ....................................................... 11
11. Tell us where it hurts. ......................................................................................... 11
12. Help us find you.................................................................................................. 11
13. Give us the big picture. ...................................................................................... 11
14. Set the appropriate priority for new calls. ....................................................... 12
15. Call us before it hurts......................................................................................... 12
16. Prepare logs if appropriate. ............................................................................... 12
17. Paint us a picture................................................................................................ 13
18. Familiarize yourself with the Software Maintenance Handbook. .................. 13
19. Have others “been there, done that”?.............................................................. 14
20. Call us. Email us. Tell us how we’re doing. ..................................................... 14
General Content Server Administration ................................................................. 15
21. Learn how to play well with others. .................................................................. 15
22. Carefully consider your file store options in your production
system. ................................................................................................................ 15
23. Search and index somewhere else!.................................................................. 15
24. Use the Content Server Servlet instead of llisapi.dll or cs.exe. .......... 16
25. Install upgrades one at a time with logs enabled............................................ 16
26. Perform administrative tasks as the Admin user. ........................................... 17
27. Schedule and announce maintenance windows............................................. 17
28. Know when it’s time to upgrade. ...................................................................... 17
29. Apply Content Server Updates.......................................................................... 17
30. Confirm that patches are loading correctly. .................................................... 18
Folders, Privileges, and Permissions ..................................................................... 20
31. Folders versus Projects ..................................................................................... 20
32. Item Creation Privileges – Be ruthless!............................................................ 20
33. Item Creation Privileges – Be helpful! .............................................................. 21
2
34. Keep the Access Control Lists as short as possible. ..................................... 21
35. Include Groups in the ACL rather than Users. ................................................ 22
36. Avoid nested Groups in the ACL where possible. .......................................... 22
For Microsoft SQL Server: ............................................................................. 23
For Oracle: ..................................................................................................... 24
Patches, Service Packs, and Upgrades .................................................................. 25
37. Read the Release Notes for quarterly Updates. .............................................. 25
38. Subscribe to Technical and Security Alerts..................................................... 26
39. Really know when it’s time to upgrade. ........................................................... 26
40. Ask for help with your upgrade. ....................................................................... 26
Summary .................................................................................................................... 28
About OpenText ........................................................................................................ 29
3
Introduction
This document details a series of best practices in use by OpenText™ Content
Server administrators around the world. These items are intended for administrators
who are new to Content Server or who feel as though they are struggling with their
implementation.
The best practices described in this booklet are covered in the following chapters:
• The Top 10 Habits
• Interaction with OpenText Customer Support
• General Content Server Administration
• Folders, Privileges, and Permissions
• Patches, Service Packs, Updates, and Upgrades
4
The Top 10 Habits
5
• The test or development environment should use a copy of the production data,
as some tests may require a similar data set to the production environment.
• The same modifications and customizations made to key configuration files
(opentext.ini, mime.types, and so on) or changes that may have been
made to core or optional module WebLingo and html files. Modifications or
changes to any of these files can significantly alter the behavior of Content
Server.
• The same language packs. The metadata language configuration should also be
identical.
• The same browser client software and version. In addition, you should ensure
that the same browser settings are enabled. A list of supported web browsers is
available in the Release Notes for all versions of Content Server.
The key advantage of maintaining a test environment that faithfully reflects your
production environment is that you will enjoy a setting in which you can safely, but
meaningfully, test upgrades, patches, Updates, modules, customizations,
permissions changes, content additions, and other modifications that you may need
to make to your Content Server system from time to time, without disrupting or
endangering your production environment. Many organizations maintain two or three
test environments for precisely this reason.
6
3. Familiarize yourself with the Content Server Release Notes.
Many successful Content Server administrators download and keep a hard copy of
the Content Server Release Notes for the version they have installed. The Release
Notes offer a detailed guide to the version of the software you have installed and can
help you diagnose and troubleshoot problems.
Release Notes are updated with each Update release of Content Server. Many
Content Server administrators set notification on Release Notes so they are notified
when new versions become available.
Release Notes offer specific information about the released product including:
• Supported server operating systems
• Supported browsers
• Supported databases
• Supported web servers
• Supported search filter formats
• Installation and upgrade notes
• Updates and service packs
• Critical and deprecated patches
• Dependencies
• Changed and deprecated features
• Security and notable fixes
• Configuration file changes
• New features
• Known issues
For your users, the Security Fixes and Notable Fixes sections may be the most
meaningful as they describe defects in the product that have been discovered and
subsequently fixed in the released version.
For a Content Server Administrator, the Known Issues section may be the most
meaningful as it describes areas of the product which can be problematic in certain
scenarios.
The Release Notes for Content Server are published with every version of the
product, including Service Packs and Updates. Release Notes are also published for
every optional module available for Content Server. To access the most recent
version of any of these Release Notes, please visit:
https://knowledge.opentext.com/knowledge/cs.dll/open/docs
Updates and corrections to the Release Notes may be made periodically online.
Always check the Knowledge Center's documentation area for the most recent copy
of the Release Notes for your version of Content Server.
7
4. Familiarize yourself with the Content Server Schema
documentation.
If you are proficient in the use of SQL database querying languages, it may be useful
for you to familiarize yourself with the Content Server Schema Documentation. The
“schema docs”, as they are often called, offer a detailed view into the tables and
columns that make up the Content Server database schema. An intimate knowledge
of these tables can help you immensely when it comes time to diagnose problems.
Moreover, knowing how the Content Server database schema is arranged will make
the task of writing reports, such as LiveReports or WebReports, much easier.
The Content Server Schema documentation is not available online. It must be
acquired by contacting OpenText Customer Support directly. Please note that you will
be asked to provide a signed copy of a non-disclosure agreement (NDA) with
OpenText in order to obtain a copy.
8
Server administration page provides default reports for some of the most common
usage statistics and can easily be extended with custom LiveReports that suit your
own system. Effective Content Server administrators often develop a series of
custom LiveReports to return results describing patterns of use for their system, and
run those reports routinely in order to track change over time. Don't let problems
sneak up on you! Keep tabs on the health of your Content Server system with regular
reporting.
Many of the default LiveReports specify their reporting period. For example, some
reports show activity from the previous day. Other reports show activity from the past
month. Depending on the nature and usage of your implementation, it may be
necessary or desirable to run these reports on a daily, weekly, or monthly basis. For
the most part, effective administrators run regular reports and diagnostics every
month or, at the very least, every quarter.
Reporting can help the administrator anticipate issues before they arise, particularly
with regard to the potential growth of the database size and, by extension, the overall
index size. The default reports in the LiveReports volume offer basic metrics for the
most general uses of the system, but effective administrators often develop their own
custom LiveReports to report on the most popular object types in their system, and
for time frames which help chart the growth and overall usage of the system. For
example, if your environment makes heavy use of Content Server Projects, running a
weekly report on the growth (in data size) or growth (in number) of Content Server
Projects could make sense.
As an added bonus, the practice of running regular reports can help administrators
document the overall adoption of the solution. For example, if you run a monthly
LiveReport that lists the number of new documents in the system, you can show how
the system has grown over time, where the greatest growth has occurred, whether
there are busy times of the year, and so on. All of these metrics can help the
administrator to better monitor their environment, anticipate growth, and document
actual system usage.
8. Stay Fresh.
Simply put, keep on top of Content Server Service Packs, Updates and module-
specific patches. This does not mean that you need to get patched up the day that a
new Service Pack, Update, or patch is released, but effective Content Server
Administrators do take the time to download and read the documentation and release
notes for new versions, service packs, Updates and patches of Content Server. By
doing so, you can weigh the improvements and enhancements software updates
bring against your own needs, and use that information to make the right decisions
for your users.
9
you have a project involving Content Server, plan it. Once you're satisfied that the
best planning possible has been made, test those plans in a development
environment. Then test it again! As tedious as it may sound, every single test you
perform in a development environment will improve your experience when it comes
time to implement your production solution.
10
Interaction with OpenText Customer Support
11
14. Set the appropriate priority for new calls.
Our Customer Service Representatives are trained to listen for key terms and
expressions that signal high-priority issues for Customer Support. But if your new call
is of great importance to you, please let us know by setting the appropriate priority for
the call when you first speak with the Customer Support Representative. Escalate or
emphasize an issue by informing your Product Specialist or by notifying your regional
Customer Support office directly.
Similarly, if an issue is of less importance, particularly next to other issues you may
have logged, this is also good information for us to have. If you have logged multiple
tickets, it is often helpful for us to have a prioritized listing from you so that we can
ensure that we address the most urgent issues first. You can also utilize the
Escalate to Management button within the My Support portal. Log onto My
Support, access your ticket, and click Escalate to Management at the top of the
page. A notification will be sent to Support Managers and someone will reach out to
you about your concern shortly.
12
Debug=2
[Options]
wantLogs=TRUE
wantTimings=TRUE
wantVerbose=TRUE
5. Start the Content Server server services.
This will create thread.out and connect.log files in your
<Install_Path>\logs\ folder. Depending on the kind of problem you are
encountering, it may also create trace.out logs. All of the new logs are important
for the diagnosis of your problem. Remember that the log folder that you use can be
set by the logpath variable in the opentext.ini file, if you would rather not send the
logs to your [InstallPath]\logs folder.
Once you have enabled these logs in the opentext.ini file, follow the necessary
steps to reproduce your error message or problem in Content Server. Once the
problem has been reproduced, reverse the steps above by stopping your services,
changing the TRUE settings back to FALSE and returning Debug to 0 in the
opentext.ini file. Leaving the logs enabled will take up disk space rapidly. The
problem you have encountered should be captured in the logs that you have just
created. Zip them up in an archive file, and send them to OpenText Customer
Support along with your ticket description.
Please note that Content Server offers many different types of logging. The steps
above describe the most commonly requested type of logs. Your Product Specialist
may ask for a more specialized form of logging to diagnose problems you have
encountered.
13
19. Have others “been there, done that”?
Check to see if others have “been there, done that”. Have a look through any of
OpenText's online resources to see if similar issues have been addressed in
documentation, discussion threads, or elsewhere. Customer Support Online at
http://support.opentext.com/ is a terrific place to start!
14
General Content Server Administration
15
front-end Content Server computing resources significantly. This allows the front-end
Content Server process to concentrate solely on handling client requests, such as
browsing, downloading, and uploading. Consult the Content Server Installation and
Administration Guide or contact OpenText Customer Support for more information.
16
26. Perform administrative tasks as the Admin user.
Content Server allows you to assign administrative rights to users other than the
Content Server user named Admin. This can be a handy way to perform certain
administrative duties, such as user and group creation. But it is important to note that,
because some modules require the use of the Admin account, there are times when it
is better to perform an action as the Admin user. As a rule of thumb, effective Content
Server Administrators ensure that they are always logged in as Admin when
performing tasks associated with the Content Server Administration pages, such as
the installation, removal, or upgrade of optional modules.
17
corrected by a more recent module version. Accordingly, to take advantage of some
fixes, it may be necessary to upgrade to the most current version of a module.
After downloading the appropriate Content Server Update for your operating system
from the OpenText Knowledge Center, expand the archive file to a location on your
local Content Server server. The archive should expand into a series of subfolders.
Each subfolder corresponds to a folder within the Content Server install path. For
example, your expanded patch archive may contain a bin folder. Files that are
located in this folder in the archive will eventually need to be copied to the bin folder
in your Content Server install folder. As another example, your expanded patch
archive may contain a reference to a more specific location, such as
module\discussion_3_0_0\html\. Files that are located in this folder of the
expanded archive will ultimately need to be copied to the matching folder in your
Content Server install directory.
Effective Content Server administrators know that the Updates are a terrific way to
stay on top of the latest and greatest bug fixes to the core Content Server product. To
find out whether a specific Update is for you, simply open the Update’s Release
Notes to determine whether your organization will benefit from its application to your
system.
For an in-depth look at applying Update Patches to Content Server, please review
the case study here:
https://knowledge.opentext.com/knowledge/cs.dll/Open/47555322
In addition there is also the Content Server Upgrade Guide found at:
https://knowledge.opentext.com/knowledge/piroot/llescor/v100007/llescor-
iup/en/html/_manual.htm
[options]
wantLogs=TRUE
wantTimings=TRUE
wantVerbose=TRUE
Start the Content Server services. In your <Content_Server_home>/logs folder,
there should be a file called thread(#).out (where # is an integer). Open the first
thread file in a text editor. Search for a patch name in the thread file. If your patch
was successfully loaded, the text should read: Patch File Application
Starting ...Patch Completed without problems.
18
After you confirm that the patch has loaded correctly, stop your Content Server
services and change the lines in the opentext.ini back to the way they were, or
just set wantLogs=FALSE and Debug=0.
19
Folders, Privileges, and Permissions
20
If you follow this general advice, your Content Server containers will retain an
organized and sensible logic for years to come and they will be free from the kind of
clutter that results when anyone is able to add any type of object to any container.
21
needs to perform on each object in a container, the more your system performance
will suffer. While it will be different for every organization and folder taxonomy,
endeavor to keep the list of users and groups as short as you possibly can.
22
For Microsoft SQL Server:
Inputs:
Type: String
Prompt: User Login
SQL:
with KUAFChildrenCTE(ID, ChildID) as
(
select ID, ChildID
from KUAFChildren
where ChildID in (select id from kuaf where lower(name) = lower(%1))
union all
Param %1:
User Input 1
Report Format:
Auto LiveReport
23
For Oracle:
Inputs:
Type: String
Prompt: User Login
SQL:
select name
from kuaf
where id in (select id from kuafchildren start with childid
in (select id from kuaf where lower(name) = lower(%1))
connect by prior id=childid)
and type=1
and name not in ('Members','Guests','Coordinators')
order by name
Param %1:
User Input 1
Report Format:
Auto LiveReport
24
Patches, Service Packs, and Upgrades
1
For Content Server 10.5, there are no separate Updates and Release Notes for the Search Engine
Updates.
25
the patch repository for each module. Effective administrators set up their
notifications to monitor the patch download folder. Whenever a new patch is added to
the KC, they are notified by email that the folder has been updated.
26
technical assistance during your upgrade through either on-call or on-site technical
support.
Customer Support also offers fee-based enhanced support programs that allow
organizations to extend their support coverage through expert resources and
services, depending on your business needs. You can refer to
www.opentext.com/welcome to find more information, or contact
supportprograms@opentext.com for documentation on these additional programs
and services.
27
Summary
This article has attempted to cover a wide range of best practices for Content Server
administration. While OpenText cannot guarantee that following these steps will help
you avoid any and all problems with your Content Server implementation, following
these steps can significantly mitigate the kinds of problems you will encounter and
equip you with a strong toolkit of best practices for dealing with issues as they arise.
Moreover, special attention has been given to ensure that the best practices and
healthy habits described in this document are just that – good habits to follow. The
suggestions made in this article are quite simple to learn and implement, they involve
no customizations to Content Server, and incur no significant additional costs for your
deployment.
Please feel free to send updates, suggestions or comments on this document for
consideration in future iterations of this document.
28
About OpenText
OpenText is the world’s largest independent provider of Enterprise Content
Management (ECM) software. The Company's solutions manage information for all
types of business, compliance and industry requirements in the world's largest
companies, government agencies and professional service firms. OpenText supports
approximately 46,000 customers and millions of users in 114 countries and 12
languages. For more information about OpenText, visit www.opentext.com.
29
www.opentext.com
NORTH AMERICA +800 499 6544 • UNITED STATES +1 847 267 9330 • GERMANY +49 89 4629 0
UNITED KINGDOM +44 118 984 8000 • AUSTRALIA +61 2 9026 3400
Copyright © 2014 OpenText SA and/or OpenText ULC. All Rights Reserved. OpenText is a trademark or registered trademark of OpenText SA and/or OpenText ULC. The list of trademarks
is not exhaustive of other trademarks, registered trademarks, product names, company names, brands and service names mentioned herein are property of OpenText SA or other respective
owners.