Creating a solution description document

You can generate a solution description document by running the Solution Document Generator from a command line. The solution description document includes a list of the assets that are defined in Case Builder.

About this task

A solution consists of a set of cases and supporting information, including a definition file that describes the overall structure and contents of the solution, a set of XPDL files describing workflows that are associated with the cases in the solution, and a Content Platform Engine configuration file that contains the Content Platform Engine configuration details, such as queue, role, in-basket, roster, event log, application space, and step processor definitions for the solution.

The Solution Documentation Generator creates a solution description document that provides a summary of the contents of the solution definition file (SDF), XPDL files, and the Content Platform Engine configuration file. The solution description document does not list rules, views, and pages.

When you design solutions, you can use the solution description document to view the organization of the solution and its contents in an easy-to-read format that can be shared with case workers and customers.

You can create a solution description document for only one solution at a time. You can choose from one of the following types of output: PDF or XHTML.

Procedure

To generate a solution description document:

  1. Navigate to the Solution Documentation Generator location:
    Operating system Location
    AIX® /opt/IBM/CaseManagement/docGenerator
    Linux® /opt/IBM/CaseManagement/docGenerator
    Linux for System z /opt/IBM/CaseManagement/docGenerator
    Windows C:/Program Files/IBM/CaseManagement/docGenerator/
    Restriction: For the Solution Documentation Generator to successfully create solution description documents, the IBM® Business Automation Workflow installation path cannot contain special non-English characters or symbols.
  2. Open the docGenerator.properties file in a text editor and define your IBM Business Automation Workflow environment.
    1. For the ceURI property, enter the full URI of the Content Platform Engine server.
      For example, http://localhost:9080/wsi/FNCEWS40TOM.
    2. For the objectStoreName property, enter the name of the design object store that contains the solution that you want to generate a solution description document for.
    3. For the solutionName property, enter the name of the solution that you want to generate a description document for.
    4. For the outputFormat property, enter the output format for the solution description document.
      PDF
      To get an Adobe Acrobat PDF file.
      HTML
      To get an XHTML file.
    5. For the outputLocation property, enter the directory location where you want the solution description document to be created.
    6. Optional: For the antOpts property, enter the maximum memory to be allocated to the JVM for a large solution.
    The following example shows an example of a docGenerator.properties file: 
    ceURI = http://myServer:9080/wsi/FNCEWS40MTOM
objectStoreName = CMDOS
solutionName = MySolution
outputFormat = PDF
outputLocation = C:/IBM/CaseManagement/docGenerator/output
antOpts = -Xmx2000m -Dmax JavaMemory=2000m
    Tip: For the outputLocation, you must use a forward slash (/) to separate folder names in the properties file regardless of your operating system type.
  3. Open a command prompt and run the Solution Document Generator.
    You can append a parameter to the command to check in the generated document into the FileNet® repository: checkin.

    The checkin parameter checks in the solution description document into the same object store in the solution folder. By checking in the solution description document into the same folder as the solution, you can iteratively monitor how the solution design changes.

    Operating system Command
    AIX docgen.sh
    Linux docgen.sh
    Linux for System z docgen.sh
    Windows docgen.bat
    For example, enter docgen.bat -checkin
  4. At the prompt, enter a user name and password that can retrieve and add content to Content Platform Engine.

Results

The Solution Document Generator produces a document with the name of the solution and an extension that is appropriate for the output format. The document is added to the location that is specified in the properties file, for example: C:/IBM/CaseManagement/docGenerator/Output/MySolution.pdf. The document is also checked into the design object store in the solution folder if you provide a checkin parameter.