Skip to content

Systems Setting Console

Default system components displayed, green means enabled
Environment: select the components of the server architecture to enable on the machine
Setup type: designer only, designer and scheduler only, complete alteryx server (includes gallery)
Workspace: root directory for temporary files, log files, database files
Controller: lists controller token used for the components to talk to each other, has the filepaths for workspace and logging
Persistence: database type (sqlite or mongodb); persistence of queue, results, completed schedules, and uploaded files
Mapping: enable map tile controller, memory cache, disk cache, reference layer lifespan
Worker: workspace configuration for temp files (cleared upon completion of workflow), allow machine to run scheduled Alteryx workflows, how many can be run simultaneously (ideally 1/2 of the physical cores), cancel scheduled jobs longer than X (ideally 1.5X the time of longest scheduled workflow), quality of service=0, run unassigned jobs
Run as: windows authentication for reading/writing files
Mapping: map rendering
Insights: if worker can enable Insights
Gallery: workspace configuration for temp files, logging directory pathway, base address URL to access gallery, enable SSL, default run mode (default unrestricted)
Authentication: built-in, integrated windows, SAML redirection
SMTP: controls email notifications being sent to users
Persistence: inherited by controller
Engine: temporary directory for writing temp files, logging directory, staging directory, browse everywhere settings, engine, sort/join memory, default thread count, engine priority, user/system alias

Server Administration

backups of mongoDB are best practice so in the event of failure, server upgrade, or maintenance protocol it can be restored if needed
command prompt entry, run as admin
change location to bin folder in alteryx install location
alteryx service executable functions → stop service, run mongoDB backup command in empty folder, make another empty folder for the restoration, run restoration prompt, open alteryx systems settings and go to controller > persistence, update data folder
common command lines
image.png

Data at Rest & In Transit

data at rest is stored in mongoDB and on the server
temp files (.yxdb) are deleted as soon as they are no longer needed — location for storage set in system settings > engine setting > temporary directory
data files packaged with workflows will be embedded in mongoDB
workflows/apps that allow users to upload files will persist in mongoDB
do not use upload file options like file browse tools for sensitive data
reference files by UNC path rather than embedding in packaged workflow
update settings for persistence to delete uploaded files after X days
log files do not contain actual data or the output from Alteryx

Want to print your doc?
This is not the way.
Try clicking the ··· in the right corner or using a keyboard shortcut (
CtrlP
) instead.