Skip to main content

Admin Settings Page

Admin users of the Designer Cloud Powered by Trifacta platform can change settings through the Trifacta Application. Login as an admin user. Select User menu > Admin Console > Admin Settings.

Note

You must be an administrator to access this feature.

Platform Settings

Warning

Do not modify settings through the Admin Settings page and through trifacta-conf.json at the same time. Saving changes in one interface wipes out any unsaved changes in the other interface. Each requires a platform restart to apply the changes.

Platform administrators can change any parameter value that is available through the web application. Enter some or all of parameter name into the search box to see a set of possible matches.

Warning

Do not modify parameters with which you are unfamiliar or have not been instructed to change. Some changes can be harmful to the system. In particular, changing the database connection parameters can break access to the application and the Admin Settings page.

Search:

Tip

You can copy setting names from the documentation to search the available set. Search retrieves matches from the setting name and the help text for the parameter. Do not paste in double quotes from documentation samples.

If your search for a parameter comes up empty and you know that the parameter exists, you must make changes on the Trifacta node in trifacta-conf.json. See Required Platform Configuration.

Search groupings:

If you search for the following strings, which may appear in property descriptions, you can review groups of settings pertaining to the configuration areas listed below.

Note

Do not perform configuration of these areas by simply reviewing and modifying the settings in these parameter groups. Additional configuration may be required. Some required settings may not be grouped, and some of these settings may not be documented. Please review the related documentation sections.

Search string

Setting group

[CORE]

Core platform settings.

[DISTRO]

Settings pertaining to specific distributions. See Configure for Cloudera.

[CLUSTER]

Settings that affect how the platform interacts with the integrated backend cluster. See Prepare Hadoop for Integration with the Platform.

[HIVE]

Settings pertaining to integration with the connected instance of Hive. See Configure for Hive.

[HA]

Settings pertaining to integration with cluster high availability for the Designer Cloud Powered by Trifacta platform. See Enable Integration with Cluster High Availability.

[SECURITY]

General settings pertaining to security. See Configure Security.

[SSL]

Settings pertaining to SSL access to the platform. See the SSL section in Configure Security.

[ADVANCED]

Advanced settings.

When you modify a setting, your change is validated against the data type or set of accepted values. String-based entries cannot be validated.

Notes:

  • Sensitive information is obfuscated in the display values in the Admin Settings page.

  • To save changes, click Save.

    Note

    Saving changes forces an automatic type validation of the configuration and a restart of the platform, which terminates any active user sessions.

    Note

    Environmental validation is not performed as part of changes in this user interface. For example, you can change the port number for the Trifacta Application to an invalid value and save the configuration change. However, when the platform is restarted, the application fails to start, and you cannot continue. In this case, you must fix the problem in trifacta-conf.json.

External Service Settings

AWS EMR Cluster ID

If you have deployed your instance of the Designer Cloud Powered by Trifacta platform on to Amazon Web Services (AWS) and are connected to an Elastic Map Reduce (EMR) cluster, you can review or modify the cluster identifier in this location. For example, in the event of prolonged outage or failure of the original cluster, you can insert the cluster ID of a secondary cluster to effectively failover to the new cluster.

Note

When you first install and integrate with an EMR cluster, this identifier is stored in the Alteryx database for you. It should be modified only if you need to switch to a different EMR cluster. Only one EMR cluster can be active at any time.

Note

If this cluster ID is modified, you must modify any other EMR-related settings to match the corresponding values for the new cluster. Please search for emr among the admin settings.

When you have entered a new cluster ID, click Save.

Note

For this setting, you do not have to click the Save button at the bottom of the screen, which restarts the Designer Cloud Powered by Trifacta platform.

AWS Region

Enter the AWS region code where the EMR cluster is hosted. For example:

us-east-1

For a list of available regions, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions.

Resource Bucket

The name of the default S3 bucket where platform resources are stored

Resource Path

The path in the default S3 bucket to where resources are stored

After you have made any changes to the AWS properties, click Save.

Services

You can review overall status of the Designer Cloud Powered by Trifacta platform.

View Logs

Click the View Logs link to review and download the logs maintained on the Trifacta node.

For more information on these logs, see System Services and Logs.

For more information, see Configure Logging for Services.

Tricheck

Tricheck performs a variety of tests of your environment to determine its suitability for use with the Designer Cloud Powered by Trifacta platform.

Tip

Tricheck should be run immediately after the Alteryx software has been installed or upgraded or whenever there are significant changes to the node or its connected cluster.

Checks include but are not limited to:

  • Sufficient hardware resources on the Trifacta node

  • Supported versions of software installed on the Trifacta node

  • Access to required ports and all nodes of the cluster

  • Trifacta node system profiling

Note

Tricheck performs no data-dependent checking. It cannot assess suitability of the environment for specific data volumes, connections, or data types.

Click Run Tricheck to run checks and download the output log.

SMTP settings

Use this option to send a test email to the specified address through the STMP email server that has been configured for the Trifacta Application to use.

Note

The SMTP email server to use must be configured. For more information, see Enable SMTP Email Server Integration.

Steps:

  1. To test the configured settings, click Check email (SMTP) settings.

  2. Enter a valid email address. Then, click Check settings.

  3. If the SMTP server is configured properly, a test email is sent to the specified email address.

Upload License

Note

For more information on acquiring an updated license file, please contact Alteryx Support.

You can update the license file stored on the Trifacta node. Click Upload License to browse for and select the license file.

Note

By default, the platform checks for a valid license once per hour. To apply your uploaded license immediately, please restart the platform.

For more information on your license, see License Key.

Restart

Click Restart Trifacta to immediately restart the platform.

Tip

The Restart Trifacta button is the preferred method for restarting the platform. A restart is automatically executed when you save changes to the platform settings.

Note

This button may not be available in high availability environments. In those deployments, please restart individual services or use the command line command. For more information, see Start and Stop the Platform.