XQuery admin:appserver-set-output-sgml-character-entities

MarkLogic 10 Product Documentation
admin.appserverSetOutputSgmlCharacterEntities

admin.appserverSetOutputSgmlCharacterEntities(
   config as element(configuration),
   appserver-id as (Number|String),
   value as String
) as element(configuration)

Summary

This function sets the SGML character entity output setting in the configuration for the specified App Server. The SGML setting determines how characters that can be represented as SGML entities are serialized upon output by default in a query against the specified App Server.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
appserver-id	The ID of the App Server. Typically, this is the result of an `admin.appserverGetId` call.
value	The default value for outputting SGML entities, one of `none`, `default`, `math`, or `pub`.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server

http://marklogic.com/xdmp/privileges/admin/app-server/{id}

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

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.appserverSetOutputSgmlCharacterEntities(config,
         admin.appserverGetId(config, groupid, "myAppServer"),
         "default")

   //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.

MarkLogic 10 Product Documentationadmin.appserverSetOutputSgmlCharacterEntities

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin.appserverSetOutputSgmlCharacterEntities