Environment Configuration

Case Management has a single configuration end point (per environment) for system-wide settings. There may be further configuration end points for some case types, although this functionality has been deprecated - most case configuration is handled via your website using the Configuration Manager.

CaseManagement.getConfig

Case Management uses our standard end point configuration structure to hold solution-wide settings.

End points called CaseManagement.getConfig should exist for each of your environments, for example in your development environment, the configuration can be found at config.dev.CaseManagement.getConfig. They hold the following settings.

{
    "linkConf": {
        "rootCitizen": "http://mysite.com",
        "pathCitizen": "/myaccount",
        "rootAnon": "http://mysite.com",
        "pathAnon": "/1234",
        "rootStaff": "http://mysite.com",
        "pathStaff": "/service",
        "rootEnquiry": "http://mysite.com",
        "pathEnquiry": "/5678"
    },
    "customLinkConf": {
        "citizen": [{
            "id": "1111",
            "displayName": "Test1 subsite",
            "root": "https://test1.gossinteractive.com",
            "pathAnon": "/9876",
            "pathCitizen": "/5432"
        }, {
            "id": "2222",
            "displayName": "Test2 subsite",
            "root": "https://test2.gossinteractive.com",
            "pathAnon": "/1234",
            "pathCitizen": "/4321"
        }],
        "staff": [{
            "id": "2345",
            "displayName": "Staff intranet DotNet",
            "root": "https://staff1.gossinteractive.com",
            "pathStaff": "/5555",
            "pathEnquiry": "/6666"
        }, {
            "id": "2344",
            "displayName": "Staff intranet Java",
            "root": "https://staf2.gossinteractive.com",
            "pathStaff": "/7777",
            "pathEnquiry": "/8888"
        }]
    },
    "emailConf": {
        "sendFrom": "CaseManagement@DoNotReply.com",
        "templates": "Generic Case",
        "monitorTo": "",
        "additionalAllowedElements": [],
        "additionalAllowedAttributes": []
    },
    "formConf": {
        "maxFileCountCitizen": 3,
        "maxFileCountStaff": 20,
        "maxFileSizeCitizen": 3000000,
        "maxFileSizeStaff": 5000000,
        "maxFileTextCitizen": "3MB",
        "maxFileTextStaff": "5MB",
        "relatedCaseLinks": ["Related", "Parent Of/Child Of", "Blocks/Is Blocked By"],
        "showContactCitizen": true
    },
   "taskConf": {
        "availableTasks": [
            "collectinfo",
            "investigate",
            "feedback"
        ]
    }
}
let actions = {
    "caseCreate": {
        "note": {
            "displayText": "Test note for caseCreate",
            "systemText": "Test note for caseCreate",
            "privateNote": false
        },
    },
    "caseOpened": {
        "note": {
            "displayText": "Test note for caseOpened",
            "systemText": "Test note for caseOpened",
            "privateNote": true
        }
    }
};

System Action Notes

The optional actions object lets you override the default notes added to case history when certain actions are carried out. Any properties you don't supply will use the defaults held in goss.CaseManagement.v1.system.getSystemConfig - these should not be edited.

To override a default, add a new object inside the actions object, with the format:

"actionName": {
    "note": {
        "displayText": "New note",
        "systemText": "New note",
        "privateNote": false
    },
}

Where:

• actionName - the name of the action to override (see below)
• displayText - the text that will appear in the notes and can contain internationalisation tokens
• systemText - the text that is always recorded in history and should not include internationalisation tokens
• privateNote - either true or false for whether or not the note should be private (appears in the Case Management interface only) or public (appears in the case history visible to the person who raised the case)

The actions that set system notes, and that can be overridden are: