createCasePackage operation

Edit online

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15

Creates a package that contains the case artifacts that are specified by the parameters for this operation and stores the package in the case folder.

Parameter	Type	Description
caseId	String	The identifier of the case. You must set the expression for the caseID parameter to the F_CaseFolder business object field in the Expression Builder window.
casePackageName	String	The name of the case package.
locale	String	The two-letter language code. The createCasePackage operation also supports the following four-letter language codes: en_US English (United States) nb_NO Norwegian (Bokmål) pt_BR Portuguese (Brazilian) zh_CN Chinese (Simplified) zh_TW Chinese (Traditional)
packagingOptionNames	String[]	The list of artifacts that are to be included in the case package. The list can include the following values: includeAllCaseProperties Set to True to include all case properties in the package. includeAllSystemProperties Set to True to include all system properties in the package. includeAllCaseDocuments Set to True to include all case documents in the package. includeAllCaseRelationships Set to True to include all case relationships in the package. includeAllComments Set to True to include all case, document, work item, and task comments in the package. includeCaseComments Set to True to include all case comments in the package. includeDocumentComments Set to True to include all document comments in the package. includeWorkItemComments Set to True to include all work item comments in the package. includeTaskComments Set to True to include all task comments in the package. includeCaseHistory Set to True to include the case history in the package. includeCaseEvents Set to True to include the case events in the package. Author A string that specifies the name of the case package author. Title A string that specifies a title for the case package. Keywords A set of keywords for the case package. Use commas to separate the keywords. Subject A string that specifies the subject for the case package. Enclose the option names in quotation marks and separate the names with commas.
packagingOptionValues	String[]	The list of values corresponding to the options that are specified for the packagingOptionNames parameter.

Adding support for non-English output

If the client locale is set to non-English, the package that is created can contain numerous "#" symbols, representing characters not supported by the current locale configuration on the operating system. To map the supported fonts correctly in the system locale and eliminate these symbols from the output, do the following steps.

Install the appropriate language pack or fonts necessary to support the particular locale.
Update the casepackage_font.properties file to include the locale information:
1. Take a backup of the casepackage_font.properties file.
2. Add a new line to the file to specify the locale and the font for that language. For example, to have a Czech locale use the DejaVu Sans font, you would use
```
cs=DejaVu Sans
```
  There are 2 locations where this file resides and must be updated:
  - Installation location. \CaseManagement\configure\AddOns\casePackage
  - Network shared directory location. The location varies depending on what is defined for the network shared directory. The default is \CaseManagement\configure\properties\AddOns\casePackage.
For Linux® only: Update the userConfig.xml file.
1. Take a backup of the userConfig.xml file. By default, this file is in the network shared directory location, which by default is \CaseManagement\configure\properties\AddOns\casePackage.
2. Update the <directory> parameter line in the userConfig.xml file. Ensure the specified font directory is correct for your server. Remove font references to C:\Windows\Fonts from the file. For example,
```
<fonts>
           <directory>/usr/share/fonts</directory>        
           <directory>C:\Windows\Fonts</directory>                
           <auto-detect/>
</fonts>
```