Loading TOC...

admin.groupAddModuleLocation

admin.groupAddModuleLocation(
   $config as element(configuration),
   $group-id as (Number|String),
   $module-locations as element(gr.moduleLocation)[]
) as element(configuration)

Summary

Add one or more module namespace to location mappings to a Group configuration. The mappings are used to look up a location for an XQuery library module for any request on any App Server in that group when the library module is requested using only the module namespace URI.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$group-id The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$module-locations A sequence of module location mapping element. Typically these are the result of calls to admin:group-module-location.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Example

const admin = require('/MarkLogic/admin.xqy');
var config = admin.getConfiguration()
var groupId = admin.groupGetId(config, "myGroup")
admin.groupAddModuleLocation(config, groupId,
     admin.groupModuleLocation("myNamespace", "/my/location/module.xqy"))

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.  
    

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.