Design Studio Preferences¶
The Design Studio has a local configuration page where you can configure several settings like connection settings between this Design Studio and Virtual DataPort, Kerberos authentication, etc.
The preferences of Design Studio affect all the users of this Design Studio, regardless of the Virtual DataPort server the users connect to.
To open the Design Studio preferences go to one of these URLs:
Design Studio of the Solution Manager: https://denodo-solution-manager.acme.com:19443/denodo-design-studio/#/web-local-login
Design Studio of a Denodo Platform installation: https://denodo-server.acme.com:9443/denodo-design-studio/#/web-local-login
If you have not enabled HTTPS yet, the port is 19090 for Solution Manager and 9090 for Denodo Platform.
The preferences page of Design Studio has its own password to log in (default: “admin”), which is separate from any other account. This account does not give actual access to the main functionalities of the Design Studio, only to its configuration.
Click the menu Configuration to open:
Change password: to change the password to log in to this page
In this dialog, you can configure the following parameters of the connection between the Design Studio and Virtual DataPort.
Options related to the execution of queries
Query timeout (milliseconds): maximum time the Design Studio will wait for a query to finish. If zero, it will wait indefinitely until the sentence ends.
Chunk Timeout (milliseconds): maximum time that Virtual DataPort will wait before returning a new block to the Design Studio. When this time is surpassed, the Server sends the current block even if it does not contain the number of results specified in the Chunk Size parameter.
If Chunk size and Chunk timeout are zero, the Server returns all the results in a single block. If both values are different from 0, the Server returns a chunk whenever one of these conditions happen:
The chunk is filled (Chunk size)
Or, after a certain time of not sending any chunk to the client (Chunk timeout).
Chunk size (rows): The results obtained by executing a sentence can be divided into blocks (chunks), so the Virtual DataPort Server does not have to wait until a sentence ends, to send the processed tuples to the Design Studio.
This parameter establishes the maximum number of results that a block can contain.
When the Server obtains enough results to complete a block, it sends this block to the client and continues processing the next results.
Other connection options
Maximum number of active connections: maximum number of active connections opened by the Design Studio, per session.
When a user logs in, Design Studio creates a pool of connections with Virtual DataPort, on behalf of this user. Maximum number of active connections is the maximum number of connections of each one of these pools. When a user does something that requires executing a command in Virtual DataPort (e.g. create view, publish a web service, etc), Design Studio obtains a connection from the pool of this user, executes the command for this action and returns the connection to the pool.
There is one pool per session, not per user. That is, if the same user logs in from two separate browsers, Design Studio will open two pools of connections for this user.
The VQL Shell is not affected by this option because it does not obtain the connection from the pool; each tab of the VQL Shell has its own connection that remains open until the user closes the VQL Shell, the user logs out or the user’s session expires.
Default value: 20. This value is adequate for any scenario.
Maximum waiting time to obtain a connection: maximum time in milliseconds the Design Studio will wait for a connection before showing an error. If you enter “-1”, the Design Studio will wait indefinitely.
Use WAN optimized communications: if selected, the communications with the server will be optimized for high latency networks. May reduce performance if used in LAN environments.
Use only SSL communications: if selected, the communication with the server will be forced to be secured. If SSL is disabled on the Virtual DataPort server, the communication will fail.
Use browser user-agent: if enabled, the Design Studio will transmit the user-agent header of the client’s browser to the Virtual DataPort server. To ensure a consistent value is sent by the Design Studio, uncheck this option and enter a custom value in the input field Custom user agent (false by default).
Custom user agent: personalized user agent the Design Studio sends to the Virtual DataPort server if Use browser user-agent is unchecked (Denodo-Web-Design-Studio by default).
Connect only to allowed Virtual DataPort Server hostnames: If selected, the Design Studio will only allow users to connect to the Virtual DataPort servers list of Allowed Virtual DataPort Server hostnames.
Allowed Virtual DataPort Server hostnames: List of allowed URLs the Design Studio can connect to. Use the button Add to define multiple URLs. The the URLs mut follow the format
hostname[port]. For example:
This section only applies if you connect directly to the Design Studio of the Denodo Platform installation
http://denodo-server.acme.com:9443/denodo-design-studio/) and you want to use Kerberos authentication.
We recommend using the Design Studio of the Solution Manager (
https://solution-manager.acme.com:19443/denodo-design-studio/) because the Solution Manager provides a single point of access to all the Denodo components, not just the Design Studio. In addition, users will be able to use more Single Sign On protocols like OAuth or SAML, not just Kerberos, to log in to Design Studio. In this case and if you enabled Single Sign On (SSO) on the Solution Manager, these steps are unnecessary. The
Solution Manager provides a menu to configure Kerberos for all components included with the Solution Manager
Installation, including the Design Studio. The Kerberos Configuration describes how to
configure the Kerberos authentication using the Solution Manager.
In this wizard you enable Single Sign On (SSO) on the Design Studio using Kerberos authentication when you access the Design Studio of a Denodo Platform installation.
To enable single sign-on (SSO), you have to enable Kerberos in both Design Studio and the Virtual DataPort server. This section describes de configuration options for the Design Studio. To enable Kerberos authentication in the Virtual DataPort server follow the instructions of the section Kerberos Authentication of the Virtual DataPort Administration Guide.
Select Use Kerberos to enable Kerberos.
In the box Server Principal, enter the “Service Principal Name” (SPN) used to create the keytab file. That is, the SPN with the Fully Qualified Domain Name (FQDN) of the server where the Web Administration Tool is running. For example, “HTTP/denodo-prod.subnet1.contoso.com@CONTOSO.COM”.
In the field Keytab file, drag and drop the keytab file over the specified area or click it to open a file explorer to select the file. If a key tab file was previously uploaded, it will be shown and you could use the trash icon to delete it.
Leave the Kerberos configuration file box empty unless the host where this Design Studio runs does not belong to a Kerberos realm (e.g., a Windows Active Directory domain). If this host does not belong to a Kerberos realm, do one of the following:
a. Drag and drop the
krb5.inifile with the Kerberos settings over the specified area or click it to open a file explorer to select the file. If a configuration file was previously uploaded, it will be shown and you could use the trash icon to delete it. b. Or follow the steps described in the appendix Enabling Kerberos Authentication Without Joining a Kerberos Realm.
We recommend selecting the check box Activate Kerberos debug mode the first time you set up Kerberos in case you run into any issues. Once Kerberos is working, disable this.
When this option is enabled, check the appendix How to Debug Kerberos in Web Applications of the Installation Guide to learn how to see the debug information.
After saving the Kerberos configuration, restart the Design Studio to have these changes take effect. The next time
the users access the Design Studio, they will not need to provide their user name and password, because the browser
will send the Kerberos credentials of their system. In order for this to work, they need to access using the full
qualified URL (FQDN) configured in step 2. For example,
The users can provide the URI of the Virtual DataPort server adding the
uri parameter to the URL. If they do it,
the Design Studio will try to authenticate them against that server without showing authentication page. For example:
You can add an informative message that will be displayed to all users when they log in to the Design Studio. The message can be used to display a welcome message, inform users when the service is expected to be down for maintenance, legal disclaimers, etc.
To customize the message you can use the editor with the tools available. If you feel more comfortable working with HTML, click to see and edit the HTML. Click Ok to save the changes.
In this dialog you can configure several settings of Design Studio.
The suggestions could include documentation, expert trails, KB documents, videos, tutorials, test drives, free trials, training courses, certification exams or blog posts.
To be able to show these suggestions, when a user logs in to Design Studio, the browser sends a request to an API of “community.denodo.com” to obtain the names and links to these community resources.
This is enabled by default.
Enable browser storage: Design Studio stores in the users’ browser several settings, for the convenience of the user. Among others:
The content of the VQL Shell, including the Execution logs so users can see their own queries the next time they log in.
The tabs that we opened the last time the user logged in.
VQL panel of elements in Design Studio: store in the users’ browser the options selected by the user the last time the user opened this panel.
Dialogs “Import”, “Export” and “Export Database” of the menu “File”: remember the latest selected options.
This is enabled by default.
This feature uses the local storage of the browser of each user.
Maximum number of rows displayed: Design Studio limits the number of rows that the VQL Shell and the Execution panel display because if it displayed all the results of the queries, the browser of the user could crash. For example, if the user executed a query that returns one million rows, the browser would not be able to display that.
Default value: 1,000 rows.
This setting does not affect Execute and Download, which can obtain all the rows.
Disable “Execute and download” feature: with this feature, the Execute and Download option will be disabled on the VQL Shells and the Execution panel for all users.
The feature “Execute and download” is enabled by default.
Maximum number of rows returned by the “Execute and download” feature: with this feature, you can set a limit on the amount of rows the “Execute and Download” option will retrieve.
Default value: 500,000 rows.
Disable “Copy displayed results to clipboard” feature: with this feature, the Copy displayed results to clipboard option will be disabled on the VQL Shells and the Execution panel for all users.
This is disabled by default.
Disable the Preferences Page of Design Studio¶
The administrator can disable the preferences page of Design Studio. The benefit of disabling this is that only users with access to the computer where Design Studio runs can change the settings. However, it is also more cumbersome because the administrator will have to modify manually the configuration file of Design Studio (i.e.
<DENODO_HOME>/conf/design-studio/DesignStudioBackend.properties) and restart Design Studio when changing any of the properties of this file.
To disable the preferences page of Design Studio, follow these steps:
Open the file
<DENODO_HOME>/conf/design-studio/DesignStudioBackend.propertiesand add this:
Stop Design Studio.
To stop it, you can execute the script
<DENODO_HOME>/bin/designstudio_shutdownor with the Control Center.
Wait a few seconds and try to access Design Studio. You should get the error 404. The page you requested was not found. This is to verify that the service is actually stopped.
Start Design Studio.
To start it, you can execute the script
<DENODO_HOME>/bin/designstudio_startupor with the Control Center.
After this, if users go to the preferences page (“/denodo-design-studio/#/web-local-login”), Design Studio will redirect them to the standard login page.
To restore the access to the preferences page, set the value of
true or remove the property.