Appendix A   Workflow Example


This chapter includes a possible workflow at Company XYZ using all five modules. This example details many of the recommended practices for using Business Console.

Company XYZ wants to create an application that can display their products, product documentation, and product experts in each company location. They have a collection of documents to use as the start. Company XYZ has installed Business Console on a single host that business users modify and end users use for search and browse.

Business Console workflows are dependent on your user permissions, so Company XYZ assigns user types to Business Console for administrator, business user, developer, and librarian.

The administrator is responsible for maintaining the resources, including deleting resources, polling collections, and assigning user permissions to the various modules. The administrator for Company XYZ assigns create privileges for each module to an individual user of each type. These users are then responsible for creating resources within the modules. Once resources have been created, the resource owners or the administrators can assign additional roles to the individual taxonomies, promotion groups, and synonym groups. These roles include:

The editor is responsible for the resource structure and the contents. The editor can add documents to categories, move categories within the taxonomy, and update the category as needed.

 

After a resource such as a taxonomy has been created, a reviewer can be assigned. The reviewer reviews the category documents and provides comments to the editor or publisher on that category.

 

After the editor and reviewer have created and approved a category, the publisher can publish that category and its contents out to the public domain.

 

A developer with access to the Application module creates a new application using the Application Wizard. He adds the collection and parametric index contexts, as well as search, results, and other components, edits the JSP file, and publishes the new application.

A librarian with access to the Synonym module applies synonyms to the collection by creating a synonym group that includes a synonym ring. She publishes the synonym set.

Another user with access to the Promotions module creates a keyword-based promotion, and publishes the promotion.

The developer adds the promotion context in the Application module, and republishes the application.

A user with access to the Parametric Index module creates a new parametric index from the collection used for the application. She publishes the parametric index.

The application user adds a parametric context and republishes the application.

The librarian is assigned certain taxonomies to create for use. These taxonomies become the draft taxonomies that the editors, reviewers, and publishers can now add content to.

The publisher (who is usually the primary librarian for a category) creates subcategories within the taxonomy, and assigns the editor and reviewer roles to the categories.

The editor can open a taxonomy, search for documents or create topics in the topic editor, add those documents to the document list and request a review or publication of the category and content. The editor’s daily tasks for a taxonomy might include running the workspace filter, which shows categories that are editable by the editor, are locked, and contains unpublished changes. Additionally, the editor might review inbox documents regularly to determine if any new documents require manual actions.

If a review is requested, a user assigned as a reviewer can access that taxonomy and add review comments to the category. After the category is approved, the editor or reviewer can request that it be published.

The publisher then opens the taxonomy and publishes the category. Each day the publisher can view the draft view to determine if categories have been updated and require republication. The publisher can also use the published request filter to determine if any categories require publication.