client is the in-browser engine for management of sampling and transformation in the Transformer page.  is automatically downloaded and updated in each user's web browser when accessing the Transformer page. Within the browser, Photon is used to manage sampling and to process transformations on those samples on the local web client, which limits required interactions with the 

Features:

This section contains the user-facing configuration for the  client. Except as noted below, these configuration changes are applied to the , which then applies the configuration to each instance of the  client and its interactions with the node.

NOTE: Some configuration is shared with the running environment. For more information, see Configure Photon Running Environment.

Known Limitations

Choose Web Client

The  supports the following web clients for interacting with the  client through the Google Chrome browser:

Web ClientDescription
WebAssembly

(default) This web client supersedes the PNaCl web client and is enabled by default.

  • Requires Google Chrome 68+

    NOTE: If users in your environment are using Google Chrome 68+, you should use WebAssembly. No further configuration is required. Please skip to the next section.


  • No additional configuration is required.
PNaCl

This web client was originally deployed for use with the client.

  • Additional configuration is required. See below.
  • End users must enable the PNaCl web client within the browser. Details are provided below.

 

Please complete the following steps to enable the PNaCl web client for use with the  client.

Steps:

  1. To enable Photon, apply the following configuration settings: 

    "photon.enabled": true,
    "photon.mode": "pnacl",


  2. Save your changes and restart the platform.

NOTE: To interact with the client, all desktop instances of Google Chrome must have the PNaCl component enabled and updated to the minimum supported version. See Desktop Requirements.

Recommended Photon Configuration by Core Count

On the , you can make adjustments to the resources claimed by the Photon running environment based on the number of cores on the machine. The following table identifies the recommended settings for a node with 8, 16, or 32 cores. The default settings assume 16 cores.

Parameter8 cores16 cores (default)32 cores
webapp.numProcesses225
vfs-service.numProcesses223
photon.numThreads244
batchserver.workers.photon.max224

The number of simultaneous users is a competing factor.

The following table illustrates some adjustments for a 16-core system:

Parameter16 cores (default)Low number of simultaneous usersHigh number of simultaneous users
webapp.numProcesses214
vfs-service.numProcesses214
photon.numThreads444
batchserver.workers.photon.max222

Modify Limits

NOTE: Increasing these values can have a significant impact on load times and performance. Change these values only if you are experiencing difficulties. Make incremental changes.

Sample Size Limits

Increasing the sample size may degrade the user experience in the Transformer page in the following ways:

When samples are created using the  running environment, their maximum size is determined by the following parameter. Default value is 10 MB.

"webapp.client.loadLimit": 10485760,

Maximum Data in the Client

The following parameter determines the maximum amount of data that is permitted to be passed to the browser from the  client:

"webapp.client.maxResultsBytes": 41943040,

Use Photon Client

The  client is an embedded component of the web client. Access to it is transparent to the user.

Configure VFS Service

Photon interacts with backend datastores through the VFS service.

NOTE: The VFS service is enabled by default and must be enabled when running environment is in use.

For more information, see Configure VFS Service.