ConfigImport()

edit

Imports server configuration defineď based on the CFConfig schema.

This configuration can be provided as a path (String) to a JSON based file or as a Struct.

The values inside the provided configuration can use placeholders, following this pattern ${key:default}.

The function will check for the actual values for this placeholders in 3 places (in this order):

  • Function arguments "params" (if provided)
  • System properties
  • Environment variables

Directory Placeholders will be passed thru and dynamically evaluated when used.

Introduced: 6.0.0.460

ConfigImport( path=any, type=string, password=string, params=struct, flushExistingData=boolean, charset=string );

Returns: Struct

Argument Description Default
path
any, required 		edit

Path to the .CFConfig.json file or the data itself as a Struct.

Alias: path, data
type
string, optional 		edit

Config Context to manipulate, server or web context.

server
password
string, optional 		edit

Password to access the configuration, depending on the value set for the attribute type.

If not set Lucee will check in the following places for the password (replace {type} with the actual type chosen for the attribute type).

Environment variable "LUCEE_{type}_ADMIN_PASSWORD" or system property "lucee.{type}.admin.password".
params
struct, optional 		edit

placeholder parameters to use as actual data for the placeholders inside the configuration, see main description of this function for more details.
flushExistingData
boolean, optional 		edit

if true that existing data get replaced with the given data, if set to false they get updated.
charset
string, optional 		edit

charset to use to read the .CFConfig file, if not defined, Lucee will use the default resource charset.

Examples

edit 
// Import Lucee Server configuration to CFConfig JSON format
data = {
    "extensions": [
        {
            "id": "EFDEB172-F52E-4D84-9CD1-A1F561B3DFC8",
            "name": "Lucene Search",
            "version": "2.4.2.4"
        }
    ]
};
writeDump(ConfigImport(data, "server", "lucee_password"));


// Import Lucee Server configuration from a .CFConfig JSON file
writeDump(ConfigImport("path/to/.CFConfig.json", "server", "lucee_password"));

See also