Appendix F. Scripting Reference

You define scripts using script objects, which can either include the code directly in the configuration, or call an external file that contains the script.

Custom scripts should be placed in the script/ folder for your project, for example path/to/openidm/script/. Do not modify or remove the script files located in path/to/openidm/bin/defaults/script/. This folder contains the default scripts that are required to run specific services. Scripts in this folder are not guaranteed to remain constant between product releases.

{
  "type" : "text/javascript",
  "source": string
}
        

or

{
  "type" : "text/javascript",
  "file" : file location
}
        

The following example (included in the sync.json file) returns true if the employeeType is equal to external, otherwise returns false. This script can be useful during reconciliation to establish whether the source object should be a part of the reconciliation, or ignored.

"validTarget": {
   "type" : "text/javascript",
   "source": "target.employeeType == 'external'"
}
        

The following example (included in the sync.json file) sets the __PASSWORD__ attribute to defaultpwd when OpenIDM creates a target object.

"onCreate" : {
  "type" : "text/javascript",
  "source": "target.__PASSWORD__ = 'defaultpwd'"
}
        

The following example (included in the router.json file) shows a trigger to create Solaris home directories using a script. The script is located in a file, /path/to/openidm/script/createUnixHomeDir.js.

{
  "filters" : [ {
    "pattern" : "^system/solaris/account$",
    "methods" : [ "create" ],
    "onResponse" : {
      "type" : "text/javascript",
      "file" : "script/createUnixHomeDir.js"
    }
  } ]
}
        

Functions (access to managed objects, system objects, and configuration objects) within OpenIDM are accessible to scripts via the openidm object, which is included in the top-level scope provided to each script.

OpenIDM also provides a logger object to access SLF4J facilities. The following code shows an example:

logger.info("Parameters passed in: {} {} {}", param1, param2, param3);
        

To set the log level, use org.forgerock.openidm.script.javascript.JavaScript.level in openidm/conf/logging.properties.

openidm['delete']('managed/user/'+ user._id, user._rev)
            

                org.forgerock.openidm.script.ScriptException: missing name after . operator
            

Scripts can be triggered at different places, by different events.

The variables that are available to scripts depend on the triggers that launch the script. The following section outlines the available variables, per trigger.

OpenIDM includes Eclipse JSDT libraries so you can use Eclipse to debug your OpenIDM scripts during development.