Knowledge MGMT
Knowledge MGMT
04
Administration Guide
January 2011
www.bmc.com
Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information
about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada
Address BMC SOFTWARE INC Telephone 713 918 8800 or Fax 713 918 8000
2101 CITYWEST BLVD 800 841 2031
HOUSTON TX 77042-2827
USA
Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000
If you have comments or suggestions about this documentation, contact Information Design and Development by email at
doc_feedback@bmc.com.
Support website
You can obtain technical support from BMC Software 24 hours a day, 7 days a week at
http://www.bmc.com/support. From this website, you can:
■ Read overviews about support services and programs that BMC Software offers.
■ Find the most current information about BMC Software products.
■ Search a database for problems similar to yours and possible solutions.
■ Order or download product documentation.
■ Report a problem or ask a question.
■ Subscribe to receive email notices when new product versions are released.
■ Find worldwide BMC Software support center locations and contact information, including email addresses, fax
numbers, and telephone numbers.
Preface 9
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Best practices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Contents 5
Configuring visibility groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Managing standard configuration data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6 Administration Guide
Configuring feedback strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Configuring system settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Configuring Plugin Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Configuring indexing intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Index 103
Contents 7
8 Administration Guide
Preface
This guide describes how to administer and configure BMC Remedy Knowledge
Management. The application runs on the BMC Remedy Action Request System
(BMC Remedy AR System) and consumes data from the BMC Atrium
Configuration Management Database (CMDB) application.
Audience
This guide is intended for the following administrators:
Application administrators who define standard system configuration
information such as users, migrate data from previous installations, manage
knowledge sources, and run and view reports. This user has the Knowledge
Admin role.
NOTE
Knowledge Admin users are advanced users who set owner and review date for
articles. For information on working with articles, see the BMC Remedy Knowledge
Management User Guide.
NOTE
For more information on user roles, see “Roles and privileges” on page 22.
Preface 9
BMC Remedy Knowledge Management 7.6.04.
Best practices
Documentation for BMC Remedy Knowledge Management contains the following
icon:
Icon Description
The Best Practice icon highlights processes or
approaches that BMC has identified as the most
effective way to leverage certain features.
Related documentation
The following table lists the documentation available for the application.
Unless otherwise noted, online documentation in Adobe Acrobat (PDF) format is
available on product installation DVDs and the Customer Support website
(http://www.bmc.com/support). You can order printed documentation from the
Customer Support website. Post-release documentation, such as white papers, are
also accessible on this website as it becomes available.
NOTE
To access the support website, you need a support contract.
You can access application help by clicking Help links in the application.
Title Document provides Audience
BMC Remedy Knowledge Management Information about new features and known Everyone
Release Notes with Known Issues issues.
BMC Remedy Knowledge Management Information about new features. Everyone
Release Notes
BMC Remedy Knowledge Management Procedures for installing the application. Administrators
Installation Guide
BMC Remedy Knowledge Management Procedures for administrating and configuring the Administrators
Administration Guide application.
BMC Remedy Knowledge Management Procedures for using the application. Everyone
User Guide
10 Administration Guide
Chapter
12 Administration Guide
Architecture
Integrations
The BMC Remedy AR System integrations allow BMC Remedy Knowledge
Management to communicate and share data with the following applications:
BMC Remedy Incident Management
BMC Remedy Problem Management
BMC Service Request Management
NOTE
For more information on working with the application, see the BMC Remedy
Knowledge User Guide.
Architecture
This section describes the BMC Remedy Knowledge Management architecture,
including its relationship to the BMC Remedy AR System server.
A database forms the underlying element of the BMC Remedy Knowledge
Management architecture. The BMC Remedy AR System server is on top of the
database and processes all data entered by BMC Remedy Knowledge Management
applications.
In addition, the BMC Remedy AR System server is the workflow engine between
the BMC Remedy Knowledge Management applications and the database. It also
verifies that a user has permission to perform each action, thereby enforcing any
access control defined in the applications.
The BMC AR System server also manages BMC Remedy Approval Server, the
Assignment Engine, and BMC Remedy FTS, as follows:
BMC Remedy Approval Server—Self-contained, shared module that enables
you to automate any approval or signature process. For more information, see
the BMC Remedy Approval Server Guide.
14 Administration Guide
Architecture
Application components
BMC Remedy Knowledge Management consists of the following components:
Knowledge articles
Knowledge life cycle management
Knowledge search
BMC Remedy Knowledge Management has two types of knowledge articles:
AR form-based—BMC Remedy Knowledge Management can integrate with
any AR form and turn it into knowledge article. BMC Remedy Knowledge
Management includes a registration tool that enable customers to define which
forms and which fields on this form they would like to integrate to the
knowledgebase. Using the AR form rich text fields, AR form based knowledge
articles can include rich text formatting and can embed objects including images
and hyperlinks.
16 Administration Guide
Architecture
Knowledge search
BMC Remedy Knowledge Management’s search module uses the BMC Remedy
Full Text Search module to search on different knowledge sources using natural
language, and to present a consolidated search result list.
The knowledge search module provides a search mechanism that is typically much
faster than the native database searching functionality for searching in long text
fields. It also lets you search on AR System form attachments.
Any AR form can be registered to BMC Remedy Knowledge Management as a
searchable item. BMC Remedy Knowledge Management will go over the records
in these forms, index them, and thus enable the application to search on these
records.
The BMC Remedy Knowledge Management has the ability to filter the search
results based on characteristics such as:
Company
Product and Operational Categories
Environment
Languages
Overview of tasks
This section provides an overview of what is involved in setting up the BMC
Remedy Knowledge Management system. You are essentially setting up the
framework that enables users to work with knowledge.
NOTE
If you are integrating with other applications, some of the services might already
be configured.
18 Administration Guide
Quick start process overview
After the set-up is finished, the application administer can perform the following
tasks:
Convert articles from previous version—For more information, see “Article
Conversion Tool” on page 49.
Manage knowledge sources—For more information, see “About managing
knowledge sources” on page 62.
Work with reports—For more information, see “Working with reports” on
page 59.
Work with the application—For more information, see the BMC Remedy
Knowledge Management User Guide.
After the application administrator defines the configuration administrator, the
following configuration tasks can be preformed by the configuration
administrator:
Convert approvals—For more information, see “Approval process overview”
on page 80.
Convert general application settings—For more information, see “Configuring
application settings” on page 86.
Convert status transitions—For more information, see “About status
transitions” on page 92.
20 Administration Guide
Article life cycle
Users can track changes made to articles even when they are not involved in the
workflow, by selecting specific articles or by defining rules (watch list). When
these articles are changed, a notification is sent.
Articles are registered and indexed to enable searching. All users can perform a
search and view results from within BMC Remedy AR System, in accordance with
their permissions.
Users that have one of the Knowledge User roles can also perform a search from
within BMC Remedy Knowledge Management. When an appropriate article is not
found in the knowledge base, users with the appropriate permissions can create an
article as required.
Articles can be related to one another when their content is related. Thus it is
possible, for example, to add a link from an article that contains information about
resolving an issue to another article that contains referential information.
Step 1 The author identifies the need for new knowledge and creates an article.
Step 2 When the author is finished, the article is promoted into the workflow. At this
stage, the article’s content might be visible to some users with Knowledge user
roles. However, the content has not been reviewed and approved for use. This
content might change, or the entire article might be deleted
Step 3 A Subject Matter Expert (SME) reviews the article for content but cannot approve
it, so the article is re-assigned to the author for additional work.
Step 4 The author completes the required editing and resends the article to be reviewed
again by an SME who is a member of the same support group as the SME who
originally reviewed the content.
Step 5 The article passes the review this time and is assigned to another reviewer who
performs a review for technical accuracy. For example, if the article contains
procedural steps, this reviewer verifies that no steps are missing.
Step 6 After the content and accuracy have been reviewed, verified, and approved, the
article is proofread.
Step 7 The article has passed all the reviews and is ready to be published, but must first
be approved for publishing.
Step 8 When approved, the article is published and becomes available to all users, even
those without Knowledge user roles (Self Help users). In some cases, the content
might be confidential so the article might be marked as not available to Self-Help
users.
Step 9 A future (typically after a year) review date to ensure that the article content is still
correct is set for the article. When the review date arrives, notification is sent as a
reminder.
Step 10 Users search for and open the article, indicating whether the content has been
useful. Sometimes they send feedback or a request to update the content.
Step 11 A Knowledge User reviews the article and needs to update some of the content. A
duplicate copy of the article is created. After the changes are made, the new version
replaces the older article.
Step 12 At some point, the article becomes obsolete and a Knowledge User retires it,
rendering it not searchable and inaccessible to users.
NOTE
Managing and tracking the life cycle through its different statuses depends on the
valid status transitions that have been configured by Knowledge Config user. The
list of available statuses for selection is sensitive to the environment (for example,
user role, current status, and company permissions). See “About status
transitions” on page 92 for more information.
22 Administration Guide
Roles and privileges
NOTE
When no Knowledge Management role is assigned, Self-Service permissions
enable end users to search and view published knowledge articles that are flagged
for external use.
Table 1-2: BMC Remedy Knowledge Management roles with their privileges (Sheet 1 of 5)
Privileges Self Knowledge Knowledge Knowledge Knowledge Knowledge Comments
Service Viewer Submitter User Admin Config
Viewing
View articles in + + + + + +
simple view
View articles in + + + +
advanced view
View in-progress + + + +
articles
View draft articles + + + +
View in-review + + + +
articles
View published + + + + + +
external articles
View published + + + + Internal articles
internal articles are approved
but not
exposed to end
users.
Table 1-2: BMC Remedy Knowledge Management roles with their privileges (Sheet 2 of 5)
Privileges Self Knowledge Knowledge Knowledge Knowledge Knowledge Comments
Service Viewer Submitter User Admin Config
View closed + + + + Closed articles
version are not
returned after a
search, but can
be viewed in
the revisions
tab of the
advanced
view.
View retired + + + +
articles
View cancelled + Cancelled
articles articles can be
viewed from
the console.
View articles + + + + Articles
waiting for waiting for
approval approval (both
publish and
retire) can be
searched and
viewed.
View update + + + +
requests
View relationships + + + + + +
View Categories + + + + + +
View Revisions + + + +
View History + + + +
View Usage + + + +
Editing
Create a new article + + + After an article
has been
updated to In
Progress, it can
be assigned to
a Knowledge
User or Admin.
Edit In Progress + + + Knowledge
Submitters can
edit only their
own articles.
Edit draft + +
24 Administration Guide
Roles and privileges
Table 1-2: BMC Remedy Knowledge Management roles with their privileges (Sheet 3 of 5)
Privileges Self Knowledge Knowledge Knowledge Knowledge Knowledge Comments
Service Viewer Submitter User Admin Config
Edit in-review + + The editor
must be part of
the relevant
reviewer’s
support group.
Edit published + + This action
creates a new
version in
draft.
Edit closed version + + This action
creates a new
version in
draft.
Edit retired + +
Edit cancelled
Edit waiting-for- + + This action
approval stops the
approval
process and
reverts the
article to the
previous
status.
Workflow
Change status to + + + The status is
draft changed to
Draft from In
Progress.
Change status to + +
review
Change status to + + Draft articles
publish/retire can also be
approval changed to
retired-
approval.
Change status to + Only users
cancel with the
Knowledge
Admin role can
cancel any
article from all
statuses.
Knowledge
users can
request to
cancel articles.
Table 1-2: BMC Remedy Knowledge Management roles with their privileges (Sheet 4 of 5)
Privileges Self Knowledge Knowledge Knowledge Knowledge Knowledge Comments
Service Viewer Submitter User Admin Config
Take ownership + + User must be
part of the
relevant
reviewers
support group
if the article is
in review. In
other statuses
the group is not
relevant.
Assign ownership + + User must be
part of the
relevant
reviewers
support group
if the article is
in review. In
other statuses
the group is not
relevant.
Approve publish Configured in
the BMC
Remedy
Knowledge
Management
configuration.
Requires
support group
membership
and approval
role.
Approve retire Configured in
the BMC
Remedy
Knowledge
Management
configuration.
Requires
support group
membership
and approval
role.
Set owner/owner- +
group
Knowledge Management Console
26 Administration Guide
Roles and privileges
Table 1-2: BMC Remedy Knowledge Management roles with their privileges (Sheet 5 of 5)
Privileges Self Knowledge Knowledge Knowledge Knowledge Knowledge Comments
Service Viewer Submitter User Admin Config
Open knowledge +
source
management
under Functions
Quick Actions + +
View articles not + A user with the
assigned to me/All Knowledge
Admin role can
view articles
not assign to
that user when
filtering 'my
groups'.
Remedy Home Page
Open RKM console + + + +
Open +
configuration for
RKM
Open search dialog + + + + + +
Other
Submit update + + + +
requests
Submit feedback + + + + + +
Create reports +
Remedy fixed + + +
(write) license
Part of support + + + + +
staff
Create + + + Submitters can
relationships create
relationships
only for in-
progress
articles.
28 Administration Guide
Chapter
2 Getting started
NOTE
If a BMC Remedy IT Service Management Suite application was installed and
configured before installing BMC Remedy Knowledge Management, the standard
configuration steps might have already been done.
NOTE
BMC Remedy Knowledge Management is not supported in BMC Remedy User.
30 Administration Guide
Configuration prerequisites
ARServer is the name of the BMC Remedy AR System server that contains the
application.
NOTE
If the mid tier and the application are on the same system, BMC Remedy
AR System server name can be omitted.
2 In the User Name and Password fields of the Welcome page, enter your user name
and password.
3 Click Login to open the IT Home Page opens in your browser.
For a list of supported browsers, see the compatibility matrix at:
http://www.bmc.com/support.
4 From the Quick Links section on the left navigation bar, click Application
Administration Console.
5 Select the appropriate task to open the form for the selected task.
Configuration prerequisites
You can set up the application to contain entries about the various people, groups,
skills, responsibilities, and geographic locations associated with your
organization.
Before you begin configuring the application, verify that the following
configuration prerequisites are met:
You must have an BMC Remedy AR System write license (either fixed or
floating).
You must have a basic knowledge of BMC Remedy AR System administration
tasks.
For information about setting the BMC Remedy AR System options, see the BMC
Remedy Action Request System Configuration Guide.
NOTE
Always configure people by opening the People form from the Application
Administration Console. Information that you add or modify on the People form
is automatically updated to the BMC Remedy AR System User form, but
information updated on the User form is not updated to the People form.
32 Administration Guide
Defining the application administrator
9 Follow these steps to relate the person to at least one support group:
a Click the Support Groups tab.
b Click Update Support Groups and Roles.
c In the Add Support Group Relationship area of the Update Support Group
Memberships and Roles form, select the Company, Support Organization,
Support Group, and Relationship Role.
NOTE
The relationship roles are Member and Associate Member. These values are
informational only. Member means that the person belongs to the support group.
Associate Member means that the person has access to modify requests assigned to
that support group.
d Click Add.
A support person can belong to more than one support group. To select the
primary support group, select the support group, and click Set to Default.
To change the relationship role, click Make Associate Member or Make
Member.
10 Click the Functional Role Update tab.
You can use this tab to assign functional roles to people in support groups.
Functional roles extend access granted by permissions groups, but only for specific
support groups that are used in the application. For example, someone might be a
member of two support groups, but is a Knowledge Management Approver for
only one.
11 To add a functional role, complete the following steps:
a Select the Company, Support Organization, and Support Group Name.
Selections in lists for the Company, Support Organization, and Support Group
Name fields on this tab appear only if support groups have been related to the
person on the Support Group Update tab.
b Select a functional role (Knowledge Management > Knowledge Management
Approver) and click Add.
12 Click Close, and click Add in the People form.
13 Confirm the password.
TIP
If you create a company, but do not complete standard configuration, you can
return to this procedure. Select the company you are configuring, and continue.
NOTE
Complete steps in sequence. If you skip a step, you might not be able to complete
a subsequent step. For example, you cannot create a people record for support staff
unless a support group has been created.
4 To create additional configuration records for a step, click the appropriate Create
link.
For example, to create additional departments for the company, click the Create
link next to Organization.
5 To modify or further customize a configuration record, click the appropriate View
link.
34 Administration Guide
Performing a standard configuration
Creating a company
The first step in standard configuration is to configure a company. Everything else
that you configure belongs to this company. You can configure multiple
companies if your company is made up of smaller companies that are separate
entities.
To create a company
1 On the Standard tab of the Application Administration Console, click Click here
to create and configure a new company.
2 From the Company dialog box, enter the company name.
3 Select or enter a Company Type:
Customer—This company is an external company for which you provide
services.
Operating Company—This company is an internal company or business unit
for which you provide services.
Additional standard company types (Generic Contact, Manufacturer, Supplier,
and Vendor) are available for custom configuration using the Company form.
4 Click Add.
Creating organizations
Organization structure is defined as Company > Organization > Department,
which represents how a company is represented from a business perspective.
Creating locations
The Location structure is defined as Company > Region > Site Group and Site,
which represents locations of sites. The location structure can be used in group
assignment and other mapping functions, such as approvals. Sites represent a
physical location (such as a building) for a company.
To create locations
1 On the Standard Configuration tab of the Application Administration Console,
select the company for which to create a location.
2 Click the Create link next to Location.
3 (optional) Enter or select information in the Region and Site Group fields of the
Location form.
You can use the Region and Site Group fields to create a location structure with
two or three levels.
Region—Geographic areas can be divided into regions. A company can have
several regions, depending on how many sites it has and where the sites are
located. Examples of company regions are Northwest, Atlantic, and Pacific.
Creating regions under a company is done only for reporting.
Enter the name of a region to create it. After you add the first site group or site
to the region, you can select the region when you add another site or site group.
Site Group—Geographic areas can be subdivided into site groups, which are
collections of individual locations. A company can have any number of site
groups, depending on how many locations it has and where the locations are.
An example of a company site group is ABC Europe Group.
Enter the name of the site group to create it. After you add the first site to the site
group, you can select the site group when you add another site.
4 Enter the site designation in the Site field.
5 Enter or select the site address information.
6 Click Add.
NOTE
Support groups are used in configuring business hours and holidays, which are
used in calculating the expected completion date of requests and in the Work
Order application.
36 Administration Guide
Performing a standard configuration
Enter the name of the support organization to create it. After you add the first
support group to the organization, you can select the organization when you add
another support group.
4 Select the support group role.
The Support Group Role field describes the role that the support group has in the
organization. For example, the support group named Internal Support might
provide the Help Desk function, while another support group provides Tier 2
support.
5 Click Add.
NOTE
Guest users can search global company information only.
After adding users, log into the application with the new users to make sure they
can access the IT Home Page. Then verify that the users can view the correct
application consoles. For example, a user with Request Catalog Manager
permissions should be able to see only the Request Entry console and the Service
Request Coordinator Console.
b From the People form, search for a user to add as a member of the support staff
(for example, the user who you want to be a fulfillment provider).
c Select the person to define as a member of the support staff.
Information for the selected user appears in the People form.
3 If this person has not yet been added as a user, Click the Create link next to People.
4 From the People form, enter the person’s first name and last name.
5 Select the client type.
6 (optional) Select a contact type, such as Hotline or Tech Support.
7 Set Support Staff to Yes.
8 To enter the phone number, click in the Phone Number field and press ENTER.
Select a Country Code for a phone number from the list or enter one manually.
If you omit the phone number, it is set as unknown.
9 (optional) Enter the email address. An email address is required to receive email
notifications.
10 (optional) If this person is a home-based employee, click Edit Home Address to
enter the home address and click the icon to the right of the Edit Home Address
field to enter the phone number.
11 In the Organization Information area, select the company and, optionally, select
the organization and department.
12 In the Location Information area, select the site.
13 To enable this person to log into the system, perform the following steps on the
Login/Access Details tab:
a Enter a login ID and password.
People who have access to the People form can change their password.
b Under License Type, select Fixed or Floating in the License Type field.
c If you have the BMC Remedy AR System full text search option, select the
appropriate Full Text License Type.
d In the Application Permissions area, click Update Permission Groups.
The Permission Group dialog box appears.
e In the Permission Group field, select each appropriate permission group to add,
such as Business manager, Service Request User, or Work Order Master.
f Click Add/Modify for each permission group.
14 If you use the Company field to restrict access to specific companies, click Update
Access Restrictions to give the support staff member access to data of the selected
companies. Otherwise, select Yes in the Unrestricted Access field on the Login/
Access Details tab.
15 From the Support Groups tab, click Update Support Groups and Roles and add
the support staff member to one or more support groups.
38 Administration Guide
Performing a standard configuration
16 Add any remaining information needed to create the support person, and click
Save.
17 Confirm the password.
The person’s information is stored in the BMC Remedy AR System User form and
in the People form.
10 In the Organization Information area, select the company and, optionally, select
the organization and department.
11 In the Location Information area, select the site.
You must select a site for employees, but it is optional for customers and vendors.
12 To enable this person to log into the system, perform the following steps on the
Login/Access Details tab:
a Enter a login ID and password.
People who have access to the People form can change their password.
b Under License Type, select Fixed, Floating, or Read in the License Type field.
NOTE
If you select a Read license for any user, you must set the Submitter Mode option
to Locked in the Licenses tab of the AR System Administration: Server Information
form. See the BMC Remedy Action Request System Configuration Guide.
c If you have the BMC Remedy AR System full text search option, select the
appropriate Full Text License Type.
13 Click Add.
40 Administration Guide
Performing a standard configuration
TIP
If you are creating a product that requires only one tier, enter None for the other
two tiers.
After you create a product category with a particular tier 1 and tier 2, you can select
those tiers when creating additional product categories. For example, if you create
a product category for Hardware > Server > Linux®, you might first enter all three
categories, but when you create a product category for Hardware > Server >
Windows, you can select both Hardware and Server.
6 (optional) Enter or select a product name.
If you specify a product name, you must specify a manufacturer. Select a
manufacturer, or click New to add a new manufacturer.
7 If you specify a product name, you must specify a manufacturer. Select a
manufacturer, or click New to add a manufacturer.
If you click New, the New Manufacturer dialog box appears. Enter a company,
select Enabled for the status, and click Save.
8 In the Product Category dialog box, select Enabled for the status.
NOTE
To temporarily prevent the category from being selected from the application, set
the status to Proposed.
NOTE
You can set the status to Proposed to temporarily prevent the category from being
selected from an application.
5 Select whether the category is available for the company that you are configuring,
or whether it is available for all companies.
6 Click Add.
When you save the operational category, it is automatically related to the Global
company. This makes the operational category available on other forms, for all
operating and customer companies.
42 Administration Guide
Performing a standard configuration
4 In the Event field, select the type of assignment entry (for example, Knowledge
SME Review).
For more information, see “Automatic assignment to individuals” on page 44.
5 In the Assignment area, select the support company, support organization, and
assigned group to use for assignment.
6 In the Available Systems area, select Knowledge Management.
You can select different support groups for assignment, even if the mapping
selections are the same.
7 In the Routing Order area, further specify when this assignment entry should be
used for the automated assignment. (This is an advanced feature.)
NOTE
The Contact Company and Company fields are required.
The Assignment entry can be mapped using the following data structures:
Organization
Location
Operational Categorization
Product Categorization
When BMC Remedy Knowledge Management uses the routing order, which is a
feature of many of the main ticketing forms, it uses information from the form that
it is on to find an assignment entry, and in turn, the support group for assignment.
8 Click Save.
9 Create the group assignment for Knowledge SME Review.
10 Create the group assignments for your company.
By default, assignment configuration records were installed out-of-the-box for
your use as templates. You can copy these records for your own company.
44 Administration Guide
Performing a standard configuration
NOTE
BMC Remedy Knowledge Management supports visibility groups that were
created in BMC Remedy Knowledge Management 7.5. When you import 7.5
knowledge articles, assigned visibility groups are imported as well to the new
release.
NOTE
When you display a group in Search mode, you can modify only the AR group
field.
3 To create a new group, click New Request and enter values for the following
fields:
Company—Select the company to which the visibility group applies.
Group Name—Enter a name for the visibility group.
AR Group Name—Select the AR group that you want to associate with the
visibility group.
AR Group ID and Long Group Name are read-only fields that display the ID
and the full name of the selected AR group.
Status—Select Active to enable the group.
4 Click Save.
46 Administration Guide
Managing standard configuration data
48 Administration Guide
Chapter
NOTE
The Article Conversion Tool does not migrate article relevancy. Relevancy
information is reset for all articles after running the conversion.
NOTE
The conversion is not supported for a combination where the conversion tool
resides on a UNIX system and the articles to convert reside on a Windows system.
BMC recommends that you copy the articles folders to any UNIX machine in the
same network.
Make sure that the AR server has been started with a special domain user, to
enable access to the files. This user must have read permissions for the file
system folder that contains the knowledge articles.
50 Administration Guide
Managing conversions
Managing conversions
The Article Conversions window lets you run new conversions and view
conversions and events information of previous conversions.
52 Administration Guide
Converting articles for new templates
c Select a modified field from the XML Field list and review the matching AR field
in the AR Field list.
d If required, change the mapping for the modified XML field and click Add
Field.
e After you complete mapping all the modified fields, click Save.
5 Click the Run tab and select one or more XML templates for conversion.
6 Click Run to start the conversion.
The conversion may take a while, depending on the number of articles that exist in
the folder you specified.
The tool does not provide progress indication of the conversion. You can retrieve
progress information from the arjavaplugin.log file (C:\Program Files\BMC
Software\ARSystem\Arserver\Db folder). The following text indicates that the
conversion has completed.
*******************************************
*** Knowledge Article Conversion REPORT ***
*******************************************
There are types of Articles that were
selected to transfer:
There were 50 found for Migration
Migrated successfully: 50
Failed: 0
###############END REPORT##################
NOTE
Conversion of new templates is supported only if the XML schema of the new
template is identical to the XML schema of the 7.2 or 7.5 release.
Troubleshooting
The conversion process does not stop until all the articles are converted, even if
errors or failures occurred. BMC recommends that you review the generated log
file arjavaplugin.log located in the C:\Program Files\BMC
Software\ARSystem\Arserver\Db folder for information about the conversion
results after the conversion has completed.
Make sure that you have permissions to access and view this folder.
Possible reasons for failure are typically network problems, incorrect file names,
invalid XML schema, and an XML schema that is different from the XML schema
for 7.2 or 7.5 releases.
The log file contains the following information:
Number of successfully converted articles
Number of failed conversions with a short description of the reason
Names of articles that failed to convert and their types
If the log file indicates that several files failed to convert, you can run the
conversion tool again without re-mapping the fields by clicking the Run tab and
selecting the XML template for conversion.
54 Administration Guide
Chapter
The Reporting Console provides a list of reports for generation to view various
activities in the application.
The following topics are provided:
About reports (page 56)
Generating predefined reports (page 56)
Working with reports (page 59)
About reports
BMC Remedy Knowledge Management enables Knowledge Admins to generate
predefined reports in the Reporting Console. You can manage the report scope, but
these reports are designed to be used without modification.
The Reporting Console enables you to create ad hoc reports that are based on
qualifications that you define, and advanced and saved qualifications. For more
information about creating custom reports, see the BMC Remedy Action Request
System Mid Tier Guide.
If you have other BMC Remedy applications installed, or have created custom
reports, additional reports and report types are listed in the Reporting Console. For
information about working with reports provided with other applications, see the
appropriate application guide.
56 Administration Guide
Generating predefined reports
Use the following procedure to generate a report for BMC Remedy Knowledge
Management in the Reporting Console.
NOTE
If you have formatting problems in viewing reports from a browser, verify that
report configuration settings are defined in the AR System User Preference form,
as described in the BMC Remedy Action Request System Configuration Guide.
To generate a report
1 Open BMC Remedy Knowledge Management and access the Reporting Console
using one of the following options:
In the Knowledge Management Console, click Functions > Reports.
Open an article and click Consoles > Reports.
2 Verify that the All Reports parameter is selected in the Show field.
3 Select a report for generation using one of the following option:
In the Category field, choose, Knowledge Management, one of the following
options, and the name of the report:
All Knowledge—Article History, Articles Assignments, Articles with Update
Requests, or No Search Results
Open Knowledge—Article Usage, Articles up for Review, or Feedback
From the Reporting Console, select a report name whose form name begins with
the RKM: prefix.
4 (optional) By default when you run a report, a built-in query is used to select the
records included in the report. To change the report results, follow these steps:
a To override the built-in query to widen or change the report results, select
Override.
b To add a qualification that narrows the report results, click Show Additional
Filter.
For more information, see the BMC Remedy Action Request System BMC Remedy
Mid Tier Guide.
5 Click Run.
6 Enter any requested parameters, and click OK.
NOTE
BMC Remedy Knowledge Management reports are the only reports that filter
results using the Company parameter. However, this parameter is not displayed
in the generated report.
58 Administration Guide
Working with reports
60 Administration Guide
Chapter
This section describes how to add, modify, and perform ad hoc re-indexing of
knowledge sources. These tasks are performed by the application administrator
(Knowledge Admin role).
The following topics are provided:
About managing knowledge sources (page 62)
Accessing knowledge source management (page 62)
About the Registration Wizard (page 62)
Registering searchable items (page 63)
Registering knowledge base items (page 64)
Running the Registration Wizard (page 68)
Using Registration Wizard parameters (page 69)
Registering new knowledge sources (page 74)
Modifying knowledge sources (page 74)
Viewing registration and indexing statuses (page 75)
Indexing on demand (page 76)
Viewing the log file (page 76)
Managing knowledge article templates (page 77)
62 Administration Guide
Registering searchable items
NOTE
Visibility groups are not supported for searchable items registration.
NOTE
When you register a searchable item as a source, existing Multi Form Search (MFS)
and FTS values are cleared. To keep existing MFS values, you must re-enter them
in BMC Remedy Development Studio. To keep existing FTS values, either enter the
values in Registration Wizard content fields, or re-enter in BMC Remedy
Development Studio.
64 Administration Guide
Registering knowledge base items
The visibility group is assigned to all the articles from that source.
You can add more than one visibility group for each source.
12 In the Accessibility panel, selects the Companies to which this source belongs.
13 Click Finish in the Completion panel.
14 (optional) Follow the registration status in the Status column of the Manage
Knowledge Sources page.
Registering AR forms
Register AR forms as sources that are retrieved from an existing AR form that you
define. BMC Remedy Knowledge Management stores and manages the metadata,
and optionally the life cycle, of this source. When you register a new knowledge
source in the Registration Wizard, you have the option to define whether a life
cycle is managed for the source. For more information, see “Source panel” on
page 69.
NOTE
Registering new knowledge sources of type AR form can put heavy load on the
server.
When registering Knowledge Base Items of type AR Form, a display only character
field z1D_RKM_Char01 (ID 302298901) is added to the source form. This field does
not belong to any view.
66 Administration Guide
Registering knowledge base items
NOTE
The Question field is indexed automatically because it was mapped to Title.
Verify that the default value property is defined for required fields in the source
form.
Verify that the forms you are registering are Regular, Join, or Vendor forms.
(Audit, Display-Only, and View forms cannot be registered.)
Remove the web toolbar from the default view, so it does not appear in the
article's content area.
To remove the web toolbar from the default view:
1 Open the form in Developer Studio.
2 Click anywhere in the form area to open the View property.
3 Under Appearances, select the Web Toolbar property and verify that the
value is set to Hidden.
NOTE
Tasks cannot be simultaneously performed by multiple users on the same source.
You can follow the progress of the registration process in the Status column of the
Manage Knowledge Sources page. For more information, see “Viewing
registration and indexing statuses” on page 75. When the status of the registration
process is Ready, you can use the knowledge source.
NOTE
After you add or modify a source, you do not have to wait until the indexing or
registration process is complete before you re-run the Registration Wizard.
68 Administration Guide
Using Registration Wizard parameters
70 Administration Guide
Using Registration Wizard parameters
72 Administration Guide
Using Registration Wizard parameters
NOTE
The source type that you select during registration cannot be modified.
NOTE
Knowledge sources cannot be simultaneously updated by different users.
74 Administration Guide
Viewing registration and indexing statuses
NOTE
Not all fields are available for modification.
Indexing on demand
You can override defined indexing intervals by performing ad hoc indexing of a
knowledge source and rebuilding the index for the source, as required. For more
information, see “Indexing interval parameters” on page 89
After the indexing is successfully completed, the source becomes immediately
available for searching.
To perform ad hoc indexing, click Rebuild Index.
The Status column displays the following status sequence: In Progress > Indexing
or Failed > Ready.
76 Administration Guide
Managing knowledge article templates
TIP
You can quickly create a new form by opening the regular form of one of the
templates provided out of the box and saving it under a new name. For example,
open the RKM:HowToTemplate to create a new how to form.
TIP
To avoid unnecessary scroll bars, copy the form’s measurements from one of the
templates provided out of the box.
78 Administration Guide
Chapter
6 Configuring approvals
NOTE
You must have Knowledge Config permissions to configure approvals in BMC
Remedy Knowledge Management.
Approval workflow
At the beginning of an article life cycle, the article enters the pre-publish review
process. The following workflow describes the Published approval workflow and
applies to Retired and Cancelled statuses.
Step 1 The designated approvers can view pending requests and approve or reject them
in Approval Central that is available from IT Home > Quick Links or from
Knowledge Management Console > Consoles > Approval Console.
For more information on Approval Central, see the BMC Remedy Approval Server
Guide.
During the approval process and before the article is set to Published, Knowledge
users can withdraw articles from the approval workflow by opening the article
and modifying it.
80 Administration Guide
Configuring approval chains for Global company
Step 3 The article status changes to Published, Retired, or Cancel depending on the
request that initiated the approval process.
TIP
You can copy the selection criteria string from the predefined processes configured
for the Global company.
82 Administration Guide
Configuring approval mappings
Field Action
Approval For Select the type of approver.
Individual—If you select this option, enter the individual’s last
name and press ENTER. The Approver ID (or login name) is
automatically filled.
Group—If you select this option, the First Name, Last Name, and
Approver ID fields are replaced by Support Company, Support
Organization, and Support Group Name.
Select values for each field. The items that appear in the Support
Organization list depend on the option you select for Support
Company. The items that appear in the Support Group list
depend on the option you select for Support Organization.
Note: If you select the Group option, all people who belong to the
support group and have the Knowledge Management Approver
functional role are set up as approvers. By default, only one
approver in the group must sign off on the approval before it can
move to the next level.
First Name (Approval For Individual) If you select Approval For Individual,
this field appears.
Note: As you begin typing the first name of the approver, the field
automatically fills in with possible selections. Press ENTER
when you are able to identify the required person.
Last Name (Approval For Individual) Use auto-fill to enter the approver’s last
name.
Approver ID (Approval For Individual) The Login ID of the approver. this field
is automatically filled when you select the approver by first or last
name.
Assignment Select Yes or No to indicate if the individual or group is available
Availability for the assignment.
Status For the approver mapping to be available, select a status of
Enabled.
Approval Indicator Select Knowledge Management.
When you select this option, the RKM Criteria section appear
under Additional Mappings. This enables you to map specific
approvers to specific articles based on operational categorization
and product categorization filters.
Phase Company Phase company for this approver mapping.
Automatically filled when you select a Phase Name.
Phase Name Select RKM Approval.
Level Specify the level of approval for the individual or group.
Field Action
Description (optional) Enter a description for this approver mapping.
Additional (optional) Enter additional mappings that are based on product and
Mappings operational categorization. Product and operational categorization
are used to categorize different products or configuration items
and operations. Available values depend on the company and the
value selected for the previous tier.
3 Click Save.
84 Administration Guide
Chapter
This section describes how to configure general application, system, and feedback
string settings. Configuration tasks are performed by configuration administrators
from the Custom Configuration tab of the Application Administration Console.
NOTE
You must have the Knowledge Config user role to configure application settings
for BMC Remedy Knowledge Management.
86 Administration Guide
Configuring feedback strings
88 Administration Guide
Configuring system settings
NOTE
You can also click Select All to select all the workflows, or Deselect All to clear all
selections.
90 Administration Guide
Chapter
This section provides an overview of status groups, types, workflows, and user
permissions, and describes how to localize status strings and configure status
transitions. Configuration tasks are performed by configuration administrators
from the Custom Configuration tab of the Application Administration Console.
NOTE
You must have the Knowledge Config user role to configure status configuration
settings for BMC Remedy Knowledge Management.
Status groups
Table 8-1 presents a description of the status types and divides them into the
following groups:
Article status group—Group containing either Published or Not Published
articles. For more information, see “Roles and privileges” on page 22.
Status bar group—Group of similar statuses that is displayed on the status bar.
Table 8-1: Status groups and types
Article status group Status bar group Status type
None In Progress In Progress
Not Published Draft Draft
In Review SME Review
Optional Review 1
Optional Review 2
Publish Approval
Published Published Published
Retire Approval
None Closed Closed Version
Retired
Cancelled
92 Administration Guide
Status groups and types
Status types
Table 8-2 provides a description of article status types.
Only the assigned reviewer and Knowledge Admin can update the article.
Members from the reviewer's support group can assign the article to themselves.
Reviewers can add an update request and edit the article.
Publish Approval Mandatory status before being Published. The article is sent for
approval pending publication.
Note: BMC recommends that you change the initial settings of
automatic approvals to manual approvals and set up approvers
for the approval process. Not changing the initial settings will
result in continued automatic approvals. Changing the settings
and not setting up approvers will result in the failure of the level
approval processes. For more details on configuring approval
processes and approvers, see the Approval section of the BMC
Remedy Knowledge Management Administration Guide.
94 Administration Guide
Status transition workflows
NOTE
When an article is in one of the approval statuses (Publish Approval or Retire
Approval), it is possible to request a cancellation of the Publish Approval or Retire
Approval process. This reverts the article status back to Draft or Published.
If a draft has a previously published version, only the draft version is retired. If the
published version is requested for Retire Approval, the draft must first be deleted.
NOTE
See “Roles and privileges” on page 22 for more information.
Knowledge Admin—Can access and update all articles, view articles that are
assigned to others, change Assignee, change article status, and publish and
cancel articles.
Knowledge User—Can perform the following tasks:
Create and update articles.
Update all Draft articles.
Move articles to one of the review statuses. In this case, the Support Group
value changes to the group to which the new assignee belongs.
Knowledge Users cannot change article status to Published or Retired, and
must submit the article for Publish Approval or Retire Approval, as
appropriate.
Knowledge Submitter—Can create articles and update them while they are in
the In Progress status.
Knowledge Viewer—Can view articles of the companies to which the
Knowledge Viewer has access, including articles with Draft or one of the review
statuses.
Users belong to one of the following categories:
Current assignee—Responsible to handle the current article.
Author—Internal or external author of the article.
Owner—Responsible for managing the article.
96 Administration Guide
Configuring status transitions
4 Enter the article status for localization in the Article Status field.
5 Enter the language in the Language field.
6 Enter the localized string in the Article Status String field, and click Save.
NOTE
This option enables you to differentiate between the default statuses and new ones
you have created.
98 Administration Guide
Chapter
9 Enabling notifications
This section describes how to enable and disable notifications. This tasks is
performed by configuration administrators from the Custom Configuration tab of
the Application Administration Console.
NOTE
You must have system System Administrator permissions to modify notification
settings.
About notifications
BMC Remedy Knowledge Management uses the BMC Remedy Email Engine to
send notifications to specified users based on specific events that occurred during
the life cycle of articles. You can configure the notification engine to select the
notification type (email, alert, or pager) for each event, notification language, and
other notification engine configuration options. Please refer to the BMC Remedy
Notification Engine Guide for details.
NOTE
You should be familiar with the notification engine configuration to ensure that
notifications used by BMC Remedy Knowledge Management work properly.
The notification engine has several configuration levels. System administrators can
set defaults for the message texts and the notification types in the locations listed
in Table 9-1:
Users can configure the notification language that is sent and received by them, the
notification type, and disable notification for certain events in the Notifications tab
of the People form.
Event types
Users receive notifications depending on the event type according to the
information contained in Table 9-2:
Disabling notifications
Perform the following process to disable the notification functionality for all
articles and all users:
To disable notifications
1 From the Application Administration Console, click the Custom Configuration
tab.
2 From the Application Settings list, choose Knowledge Management > Knowledge
Management Configuration > Application Configuration, and click Open.
3 Enter the Company you are configuring in the Company field, and click Search.
4 In Knowledge Article > Notifications select Disable.
5 Click Save.
Index
A about 12
application components 15
Access Restrictions dialog box 32 components 13
accessing the Application Administration configuration prerequisites 31
Console 30 reports 55
administrators, defining application 31 BMC Software, contacting 2
application administrators, defining 31 browser compatibility matrix 31
application documentation 10
approval chains
configuring for a specific company 81 C
configuring for Global company 81 categories
approval mappings operational, creating 42
configuring 82 product, creating 40
approval process overview 80 companies
approval workflow 80 creating 35
architecture 13 locations, creating 35
Article Conversion Tool organizations, creating 35
converting for default or modified templates 52 regions, about 36
converting new templates 53 site groups, about 36
managing conversions 51 structure 35
overview 49 Company dialog box 35
remote access 50 compatibility matrix, browser 31
troubleshooting 54 components, BMC Remedy Knowledge
viewing conversion details 51 Management 13
article status group 92 configuration
Assignment form 43 application settings 86
assignments defining application administrators 31
auto-assignments, individual 44 disabling notifications 102
group 43 feedback strings 87
individual 44 history recording 87
routing 42 indexing intervals 89
audience 9 knowledge assignment method 87
modifying standard 46
B notifications 87
plugin log levels 88
best practices for creating knowledge article related article display 86
templates 77 search relevancy 86
best practices for knowledge management 10 search result parameters 86
BMC Remedy AR System licenses 31 support staff, defining 37
BMC Remedy AR System, integrations 13 system settings 88
BMC Remedy Knowledge Management viewing standard 46
Index 103
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
G
groups
N
assignment to 43 non-support staff
site 36 defined 37
notifications
about 100
I event types 100
integration with BMC Remedy ITSM applications 13 Watch Lists 101
IXGEN_DONT_EDIT_THIS! 87
O
Operational Catalog form 42
Index 105
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
support groups
creating 36
role description 37
structure 36
support, customer 3
T
technical support 3
transition workflows 95
troubleshooting Article Conversion Tool 54
U
Update Support Group Memberships and Roles
form 33
URLs
compatibility matrix 31
user privileges, table 23
V
viewing
standard configuration data 46
viewing conversion details 51
visibility groups, configuring 45
W
website compatibility matrix 31