KB439967: New Feature in MicroStrategy 10.11: Enhanced Proxy support for OAuth data sources

Principal Consultant • MicroStrategy

Starting in MicroStrategy 10.11, MicroStrategy deploys a standalone configuration file named proxy.json that can be used to configure proxy for all the OAuth data sources in a unified manner regardless of the operating system. MicroStrategy 10.11 also support more OAuth data sources than before.

OVERVIEW
Prior to Strategy 10.11, users were able to configure proxy only for some OAuth data sources through the Data Import feature, such as Twitter and Facebook. Furthermore, the configuration steps varied depending on the operating system and using a Proxy Auto-Configuration(PAC) was not supported.
Starting in Strategy 10.11, Strategy deploys a standalone configuration file named proxy.json, which can be used to configure proxy for the OAuth data sources in a unified manner regardless of the operating system. Strategy 10.11 also support more OAuth data sources than before.
The following list provides a summary of enhancements regarding the OAuth data sources, and this article will also describe the detailed steps to configure the proxy in Strategy 10.11 and later.

Data source access through proxy for Data from URL, Twitter, Facebook, Salesforce, Google BigQuery(native api), and BI Tools.
Support for using a standard Proxy Auto-Configuration(PAC) file to configurate the proxy.
Backward compatibility (the behavior remains the same as before if the proxy is disabled)

Steps to configure proxy in Intelligence Server on Windows
1) Locate the standalone configuration file(proxy.json)
After installing or upgrading to Strategy 10.11 or later, the default configuration file named proxy.json will be installed automatically. For the Intelligence Server in a Windows environment, it is located under “C:\Program Files (x86)\Common Files\Strategy”
2) Configure the proxy.json
By default, the proxy.json file will look as follows
{
"ENABLE_FLAG":"FALSE",
"USE_PROXY_PAC":"FALSE",
"PAC_URL":"",
"USE_PROXY_STATIC":"FALSE",
"PROXY_HOST":"",
"PROXY_PORT":"",
"PROXY_AUTHENTICATION":"FALSE",
"USER_NAME":"",
"PASSWORD":""
}
As an example, let’s assume that you like to specify the following proxy server information.

host: 10.0.0.1
port：8080
username: mstr
passwd: 123456

In this case, the proxy.json needs to be configured as follows
{
"ENABLE_FLAG":"TRUE",
"USE_PROXY_PAC":"FALSE",
"PAC_URL":"",
"USE_PROXY_STATIC":"TRUE",
"PROXY_HOST":"10.0.0.1",
"PROXY_PORT":"8080",
"PROXY_AUTHENTICATION":"TRUE",
"USER_NAME":"mstr",
"PASSWORD":"123456"
}
If the proxy server is not authenticated, then the parameter PROXY_AUTHENTICATION must be set to FALSE.
Furthermore, in order to use a Proxy Auto-Configuration(PAC) to configure your proxy, the proxy.json should be configured as shown below, assuming the location of the PAC file is “c:\config\example.pac”
{
"ENABLE_FLAG":"TRUE",
"USE_PROXY_PAC":"TRUE",
"PAC_URL":"c:\config\example.pac",
"USE_PROXY_STATIC":"FALSE",
"PROXY_HOST":"",
"PROXY_PORT":"",
"PROXY_AUTHENTICATION":"",
"USER_NAME":"",
"PASSWORD":""
}
3) Restart the Intelligence Server for the changes to take effect
4) Verify the connectivity though the proxy server. If the proxy server is not configured in the proper format, the proxy will not take effect.
Steps to configure proxy in Workstation for Windows/Mac and Intelligence Server on Linux
The steps for other platforms are the same as above, but the location of the proxy.json is different.

Workstation (Windows): C:\Program Files\MicroStrategy\Workstation
Workstation (Mac): Applications/Strategy Workstation.app/Contents/Frameworks/OneTierDashboardwindow.framework/Resources
Intelligence Server (Linux): $InstallPath/install

Configuration descriptions

;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server
;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server	;;^ ;; Customer 1 2 3 Customer 1 2 3 Customer 1 2 3ItemDescriptionENABLE_FLAGEnable the proxy or not. If this Flag is FALSE, then the proxy will not take effect, regardless of what the values are in the other fields.PAC_URLThe path of a PAC file. Support both local file and online file, such as "Z:/BIN/X64/demo.pac" or "http://test/demo.pac"USER_NAMEUsername for a static proxy serverPASSWORDPassword for a static proxy serverPROXY_AUTHENTICATIONStatic proxy authentication Flag. If this Flag is TRUE, specified USER_NAME and PASSWORD will be used to access the static proxy server. (Note: this is only supported in static mode, and the PAC mode is currently not supported)PROXY_HOSTThe static proxy's host, IP address or hostnamePROXY_PORTThe static proxy's host port, numbers onlyUSE_PROXY_PACPAC Proxy Flag. Either USE_PROXY_PAC or USE_PROXY_STATIC should be set to true to turn on the PAC mode or static modeUSE_PROXY_STATICStatic Proxy Flag. If this Flag is true, then PROXY_HOST and PROXY_PORT will be set to be the static proxy server

*ENABLE_FLAG flag is default to FALSE, meaning no proxy is configured in this file and the system proxy configuration will take effect if it is configured. This flag needs to be set to TRUE if proxy has to be used.
Notes
1) Priority

The application level configuration(proxy.json) takes precedence over the system configuration (an environment variable in Linux/Mac and internet properties in Windows)

2) Limitation

The proxy setting is a global setting, which means the defined proxy will be applied to every Strategy user

KB439967

Comment

0 comments

Details

Knowledge Article

Published:

March 23, 2018

Last Updated:

January 1, 2019