Changing the case package format

The case packaging tool compiles the case information that you select into a PDF file. You can change the headings that are provided by the case packaging tool to customize the PDF output. You can also change the language of the PDF output by providing translated files to the packaging tool.

About this task

At any time during an investigation, you can create a case package that compiles whatever properties and artifacts of a case that you want to include. When you finalize a case, you can also create a complete case package that you can submit to parties outside of the case management solution. The case packaging tool provides organization and heading text according to an established template. If you need different heading text or different style elements in your case package PDF file, you can customize these elements for the tool.

It's a good idea to run the case packaging tool and examine the output first, to determine what parts of the formatting you want to customize.

All of the steps are optional. However, if you modify the configuration.properties file, you must restart the CFCaseMgmtRestEAR application.

Procedure

  1. Edit the text of chapter, section, or table column headings:
    1. Log in to the integrated solutions console of the WebSphere® Application Server instance that is running IBM® Case Manager.
    2. Open the following file for editing: C:\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\Cell01\CFCaseMgmtRestEAR.ear\CFCaseMgmtRest.war\WEB-INF\classes\resources\casepackage.properties
    3. Replace the default strings with your new custom strings. For example, you can update the strings for casepackage.title, casepackage.overviewComments, and so on.
    4. If you want to modify language-specific strings, update the properties file that correspond to that language. For example, for French, update the casepackage_fr.properties file.
    5. In the WebSphere Application Server integrated solutions console, restart the CFCaseMgmtRestEAR application.
  2. Edit the style elements of the case packaging tool:
    1. Log in to the integrated solutions console of the WebSphere Application Server instance that is running IBM Case Manager.
    2. Open the following file for editing: C:\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\Cell01\CFCaseMgmtRestEAR.ear\CFCaseMgmtRest.war\WEB-INF\classes\resources\configuration.properties
    3. Make changes to the following style elements as needed:
      FontName
      By default, the font in the package PDF is Helvetica. You can change to another font by specifying a different value for this property. The font can be one of the following types:
      • iText 2.1.5 built in types
      • a Type1 font that is referred to by an AFM or PFM file
      • a TrueType font, simple or collection
      • a Chinese, Japanese, or Korean font from the Adobe Asian Font Pack
      For example:
      # iText 2.1.5 built in types
      FontName= Courier

      or

      # TrueType font
      FontName=C:/Windows/fonts/arial.ttf
      ChapterInNewPage
      This property controls whether a chapter starts on a new page. The default setting is false. The false setting means that the new chapter is appended after the previous one, instead of adding a new page. You can change the value to true, so the data of each step starts on a new page in the PDF file.
      DateFormat
      This property controls the date format in the PDF. The default value is MM/dd/yyyy HH:mm:ss. For example, you can use the following format to add time zone information:
      DateFormat = MM/dd/yyyy HH:mm:ss z
    4. In the WebSphere Application Server integrated solutions console, restart the CFCaseMgmtRestEAR application.
  3. Configure your packaging tool to make Asian fonts available:
    1. Log in to the integrated solutions console of the WebSphere Application Server instance that is running IBM Case Manager.
    2. Open the following file for editing: C:\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\Cell01\CFCaseMgmtRestEAR.ear\CFCaseMgmtRest.war\WEB-INF\classes\resources\iTextAsian.jar
    3. Configure the fonts that you need by using the settings in the file. See the following example:
      # Simplified Chinese
      FontName= STSong-Light
      FontEncoding= UniGB-UCS2-H
       
      # Traditional Chinese
      FontName= MHei-Medium
      or
      FontName= MSung-Light
      FontEncoding= UniCNS-UCS2-H
       
      # Japanese
      FontName= HeiseiKakuGo-W5
      or
      FontName= HeiseiMin-W3
      FontEncoding= UniJIS-UCS2-H
       
      # Korean
      FontName= HYGoThic-Medium
      or
      FontName= HYSMyeongJo-Medium
      FontEncoding= UniKS-UCS2-H