Correspondence Management Configuration Properties
Last update: May 2, 2024
- Topics:
- Correspondence Management
CREATED FOR:
- Admin
- User
- Developer
To configure these properties, open the following URL in a browser: https://<server>:<port>/<contextPath>/system/console/configMgr and select Correspondence Management Configurations.
Correspondence Management has the following configuration properties:
| Property | Description | Default | Acceptable values |
|---|---|---|---|
| Indentation | Indentation on modules | 12.7mm | Any number |
| Number Minimum Width | Minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers | 8.0mm | Any number |
| Roman Numbers Minimum Width | Minimum width to be applied on the bullet/number field, when using Roman numbers | 12.7mm | Any number |
| Rendition Type | The type of rendition the Create Correspondence application uses to render the letter preview. | HTML Rendition | HTML Rendition / PDF Rendition |
| Enable CCR PDF highlight | Enables highlighting on PDF in Create Correspondence application | true | true / false |
| Target Highlight Type | Target Highlight Type in the Create Correspondence application | border | border / fill / none |
| Target Highlight Color | Target Highlight Color in the Create Correspondence application | 90;155;245 | Any RGB color in format R;G;B |
| Content Highlight Type | Content Highlight Type in the Create Correspondence application | Fill | border / fill / none |
| Content Highlight Color | Content Highlight Color in the Create Correspondence application | 210;225;245 | Any RGB color in format R;G;B |
| Field Highlight Type | Field Highlight Type in the Create Correspondence application | fill | border / fill / none |
| Field Highlight Color | Field Highlight Color in the Create Correspondence application | 210;225;245 | Any RGB color in format R;G;B |
| Application Time Out | Application Time Out in seconds | 1200 | Any number |
| PDF document parameter name | Parameter name for PDF document in post process | inPDFDoc | Any string variable name |
| XML data parameter name | Parameter name for XML document (data) in post process | inXMLDoc | Any string variable name |
| XDP document parameter name | Parameter name for XDP document sent to the post process | inXDPDoc | Any string variable name |
| Redirect URL parameter name | Parameter name for the redirect URL sent from the post process This value can be any string variable name | redirectURL | Any string variable name |
| PDF Submit Type | PDF Submit Type (type of PDF generated on submitting from the Create Correspondence application) | nonInteractive | interactive / non-interactive |
| Optimize Data Dictionary Instance | Enables optimized transfer of Data Dictionary Instance b/w server and client | true | true / false |
| Auto Correct Inconsistencies | When enabled, it automatically handles the possible inconsistencies in Letter Assignments | true | true / false |
| Use Configured Data Formats | Controls whether to Use Configured Data Edit Formats and Data Display Format | true | true / false |
| Data Display Formats | Specifies locale specific display format for data | locale=en_US; dateFormat=dd-MM-yyyy; numberDecimalSeparator=.; numberGroupSeparator=,; numberUseGroupSeparator=truelocale=de_DE; dateFormat=dd-MM-yyyy; numberDecimalSeparator=,; numberGroupSeparator=.; numberUseGroupSeparator=truelocale=fr_FR; dateFormat=dd-MM-yyyy; numberDecimalSeparator=,; numberGroupSeparator= ; numberUseGroupSeparator=truelocale=ja_JP; dateFormat=dd-MM-yyyy; numberDecimalSeparator=.; numberGroupSeparator=,; numberUseGroupSeparator=true | -- |
| Data Edit Format | Edit format for data. This is used when writing data as String or parsing data from String | locale=en_US; dateFormat=dd-MM-yyyy; numberDecimalSeparator=.; numberGroupSeparator=,; numberUseGroupSeparator=true | -- |
| Manage Letter Instances on Publish | Enable/Disable the Manage Letter functionality (applicable only for Publish Server) | false | true / false |
| Enable Audit | Enable/Disable audit functionality. When false, audit logs for all actions will be disabled | false | true / false |
| Enable Read Audit | Enable/Disable audit functionality for asset reads | false | true / false |
| Enable Create Audit | Enable/Disable audit functionality for asset create | false | true / false |
| Enable Update Audit | Enable/Disable audit functionality for asset update | false | true / false |
| Enable Revert Audit | Enable/Disable audit functionality for asset revert | false | true / false |
| Enable Publish Audit | Enable/Disable audit functionality for asset publish | false | true / false |
| Enable SaveAsDraft Audit | Enable/Disable audit functionality for saving letter drafts | false | true / false |
| Enable Submit Audit | Enable/Disable audit functionality for letter submit | false | true / false |
| Enable Email Audit | Enable/Disable audit functionality for emailing letters | false | true / false |
| Enable Print Audit | Enable/Disable audit functionality for printing letters | false | true / false |
| Enable Custom Delivery Audit | Enable/Disable audit functionality for custom delivery of letters | false | true / false |
| Attachment documents parameter name | Parameter name for Attachment documents sent to the post process | inAttachmentDocs | Any string variable name |
| CM User Root | URL of the folder containing all Correspondence Management user assets | -- | Valid folder location |
| Letter Cache Size |
Specify the Maximum number of letters to be kept in cache. Changing this value will result in clean-up of | 100 | Any numeric value |
| Enable Letter Cache |
Enable/Disable the letter cache. Changing this value will result in clean-up of | true | true / false |
| Data Elements Ordering | Keeps data elements ordering in create correspondence interface as per their sequence in Letter | true | true / false |
| Support Reload |
Enable/Disable reload support in letters rendered on server-side. Disabling this will improve letter render performance. | false | true / false |
| Temp Folder | Location of the temp folder. | acm.tpmFolder | |
| Remote Save | Saves the Letter Instances on the specified processing author. | ||
| Compatibility Options | Compatibility options of the format configname:configvalue separated by comma. | acm.compatibilityOptions | |
| Debug Directory | File system folder location for debugging. If the directory does not exists, no debug dumps will be generated. | acm.debugDirectory |
Experience Manager
