Properties available to configure the BusinessWorks and BusinessWorks Container Edition REST JSON palette
This article is meant to list the properties available to configure the BusinessWorks and BusinessWorks Container Edition REST JSON palette to handle specific scenarios. Please keep in mind that use of those properties is not common.
# Property com.tibco.plugin.restjson.json2xml.specialIgnored
By default special characters in the input string are ignored, if you want to convert special characters to ASCII code, you can use the com.tibco.plugin.restjson.json2xml.specialIgnored property and set it to false. For example:
com.tibco.plugin.restjson.json2xml.specialIgnored=false
This property is applicable for the Generic and the XSD schema types.
This property is also available for the BusinessWorks 5.X REST/JSON Plugin.
# Property com.tibco.plugin.restjson.json2xml.enforceJsonRoot
To add the <JSON> root element for the Generic schema type in the Parse JSON activity, add the com.tibco.plugin.restjson.json2xml.enforceJsonRoot property in the AppSpace config.ini file and set it to true.
Details from BusinessWorks 6.7 release notes:
This property is also available for the BusinessWorks 5.X REST/JSON Plugin.
# Property com.tibco.plugin.restjson.xml2json.emptytonull
This property when set to true converts the “” (refers to empty string) and “{}” (refers to empty element or object) to the “null” value in the output generated by the Render JSON activity.
# Property com.tibco.bw.rest.renderjson.generic.parseDataTypes
This property applies to the Render JSON activity when configured with generic schema option. On setting this property to true, numeric values are rendered without quotes else the default behavior of enclosing all values within quotes is followed.
# Property com.tibco.plugin.restjson.json.setCacheSize
This property got introduced in BusinessWorks 6.9.
It is useful when using the Parse JSON activity in Generic mode and having to parse a JSON string larger than 1024 characters.
More details from BusinessWorks 6.9 release notes:
# Property com.tibco.bw.restjson.array.null
This property got introduced in BusinessWorks 6.11.
It is useful to manage specific scenarios involving array of strings and using the ‘Use Empty Values for null option’.
More details from BusinessWorks 6.11 release notes:
# Property com.tibco.bw.http.hideServerVersion
This property allows to hide Jetty server details in responses to HTTP requests, for example:
com.tibco.bw.http.hideServerVersion=true
This applies to all services using an HTTP transport (REST binding, SOAP binding and HTTP server).
# Property BW_DISABLE_SWAGGER_UI
This property allows to disable the Swagger UI available by default on the port defined by the bw.rest.docApi.port appnode property, for example:
BW_DISABLE_SWAGGER_UI=true
# Properties bw.rest.disable.cors.headers
and
bw.access.control.allow.origin.cors.header.url
By default when calling a REST API exposed by BusinessWorks, CORS headers are present in responses, this can be changed by setting the bw.rest.disable.cors.headers to true, for example:
bw.rest.disable.cors.headers=true
When bw.rest.disable.cors.headers is set to true it remain possible to allow requests using CORS headers from a specific origin (such as the SwaggerUI) by using the property bw.access.control.allow.origin.cors.header.url , for example:
bw.access.control.allow.origin.cors.header.url=http://esbserver1:7777
# Properties com.tibco.plugin.restjson.xml2json.namespaceIgnored
and
com.tibco.plugin.restjson.xml2json.prefixIgnored
Those properties are only applicable for the Render JSON activity when configured with the Badgerfish check box selected.
To remove the XML namespaces and prefixes present in the Badgerfish JSON message generated from the Render JSON activity you can add the following properties in the target appnode config.ini file:
. com.tibco.plugin.restjson.xml2json.namespaceIgnored=true
. com.tibco.plugin.restjson.xml2json.prefixIgnored=true
# Property bw.xml.jsonrest.multiple-ns.removensprefix
This property got introduced in BusinessWorks 6.8.0.
More details from BusinessWorks 6.8.0 release notes:
Additional elements
The mentioned properties can be set using one of the approaches described in this article:
