Issue

Error occurs when you generate and attach Microsoft Word documents using the pzGenerateDocument function rule.

Symptoms and Impact

The following error occurs when you generate a Microsoft Word document using the pzGenerateDocument function rule: 

“Illegal characters detected in the path “<file path in StaticContent directory>”

Additionally, you will observe the following symptoms:

1. The generated word document is not attached to a case.
2. The case is paused.

Steps to reproduce

1. Create a case type.
2. Create a flow rule which includes a utility shape.
3. Create an activity to use in this utility shape which performs the following actions:
   • Calls the pzGenerateDocument Rule-Utility-Function to create a Word document.
   • Attaches the generated document to the case using the AttachFile (or similar) activity.
4. Add a flow rule to the case type.
5. Create a case for the case type and process it until the step to generate and attach a Microsoft Word document. 

Root Cause

Pega has deprecated the pzGenerateDocument rule function.

Solution

Perform the following actions to remediate the error:

1. Create a case type.
2. Add an automation step to Generate Document.
3. Create a case for this case type and process it until the Generate Document step.

OR

1. Create a case type.
2. Create a flow rule which includes a utility shape.
3. Create an activity to use in this utility shape which performs the following actions:
   • Calls the pxGenerateAndAttachDocument activity to create a Word document.
   • Attaches the generated document to the case using the AttachFile (or similar) activity.
4. Add the flow rule to the case type.
5. Create a case for the case type and process it until the step to generate and attach a Microsoft Word document.

Environment

Version found in

The problem occurs in the following Pega Platform versions:

• Pega 8.8.2
• Pega 23.1.0
• Pega 23.1.1
• Pega 23.1.2

References

Generating case documents

Word templates