Configuration End Points

The Fostering Hub has a global configuration end point, plus separate configuration for the CSV exporter.

Global

The configuration end point for the Fostering Hub can be found at config.<environment>.fosteringHub.getConfig

Example

function(params, credentials) {
    return {
        /* 
         * Structure for custodian key value pair is (mhclg code: Name of custodian)
         * E.g. 1160: "Plymouth City Council" 
         */
        custodians: {
            5990: "Westminster City Council",
            5150: "LB Brent",
            5270: "LB Ealing",
            5450: "LB Harrow",
            5510: "LB Hillingdon",
            5600: "Royal Borough of Kensington and Chelsea",
            5390: "LB Hammersmith and Fulham",
            5540: "LB Hounslow"
        },

        /* Map Local Authority names to subtypes
         * E.g. "Plymouth City Council: plymouthcitycouncil"
         */
        subTypeNames: {
            "Westminster City Council": "westminster_city_council",
            "LB Brent": "lb_brent",
            "LB Ealing": "lb_ealing",
            "LB Harrow": "lb_harrow",
            "LB Hillingdon": "lb_hillingdon",
            "Royal Borough of Kensington and Chelsea": "royal_borough_of_kensington_and_chelsea",
            "LB Hammersmith and Fulham": "lb_hammersmith_and_fulham",
            "LB Hounslow": "lb_hounslow"
        },
        
        // Map friendly url text to case subtype
        friendlyUrls: {
            "hillingdon": "LB Hillingdon",
            "brent": "LB Brent",
            "hounslow": "LB Hounslow",
            "ealing": "LB Ealing",
            "harrow": "LB Harrow",
            "sharedservice": "Fostering Shared Service",
        },

        // Number of years address history is needed for
        prevAddressYears: 10,

        // UK area that encapsulates the Local Authorities
        areaName: "West London",

        // Whether to add newsletter field in application form
        newsletter: false,

        // Whether to compress CSV exports
        compress: true
    };
}

Description

CSV Exporter

The SFTP configuration is held at config.<environment>.fosteringHub.sftp.getConfig, the email configuration at config.<environment>.fosteringHub.email.getConfig. The exporter does not allow the user to choose where data is sent, just whether it should be emailed or sent via SFTP (or both).

SFTP

function(params, credentials) {
    return {
        "sftpDetails": {
            "key": "",
            "path": "",
            "password": "",
            "port": 22,
            "host": "",
            "createFolder": "",
            "user": ""
        }
    };
}

Email

function(params, credentials) {
    return {
        "emailConfig": {
            "recipients": [{
                "address": "support@gossinteractive.com",
                "name": "GOSS"
            }],
            "useCommsTemplateManager": false
        }
    };
}