AlteryxGallery MongoDB Schema
The AlteryxGallery MongoDB is the database for the Server UI part of your Server instance. This article covers the AlteryxGallery MongoDB schema version 61, which corresponds to Server versions 2024.1. Servers using either embedded MongoDB or user-managed MongoDB use this schema.
As a Server admin, you might need to access the MongoDB schema for your Server instance for reporting and analysis. You can access the MongoDB schema using any compatible client. mongo Shell is a good tool for command-line access. MongoDB Compass is good tool for GUI access. If you use MongoDB Atlas you can access the database documents via the Atlas web console.
Warning
We do not support making direct edits to your MongoDB database. Doing so can cause unexpected results.
The AlteryxGallery MongoDB is made up of the below collections. Collections are groupings of MongoDB documents which are made up of a set of field-value pairs. Select a collection to see the definition of the fields, also known as the schema.
Important
This Collection is obsolete as of the 2020.1 version release. The data is preserved if you upgrade from a previous version but is unused.
The activeDirectoryPermissions Collection contains permissions for Active Directory users and groups. This Collection was only present in Servers using Windows Authentication.
[Obsolete] _id: (ObjectId) Document primary key.
[Obsolete] Category: (Int32) Identifies the object as a user or a group. User=0. Group=1.
[Obsolete] Name: (String) User or group name formatted as domain\object
[Obsolete] Sid: (String) Active Directory SID (security identifier).
[Obsolete] DisplayName: (String) User or group display name.
[Obsolete] PermissionType: (String) Role permission granted to the user or group. -1=No Access. 0=Viewer. 2=Artisan. 3=Curator.
The apiNonces Collection contains API key and nonce data for active API sessions.
_id: (ObjectId) Document primary key.
ApiKey: (String) User's API key.
Timestamp: (Int32) Epoch timestamp.
Nonce: (String) Unique nonce value.
CompoundKey: (String) Compound key consisting of the API key, timestamp, and nonce.
CreateDate: (Date) Date-time (UTC) the nonce was created.
The appInfos Collection contains published workflows data.
_id: (ObjectId): Document primary key.
CreatedBy: (String) Original author ID.
IsPublic: (Boolean) Workflow publicly shared flag.
DateMadePublic: (Date) Date-time (UTC) when the workflow was last made public.
IsDeleted: (Boolean) Workflow deleted flag. Note, changing this back to false does not recover the deleted workflow.
TotalRunCount: (Int32) Count of all runs across all workflow versions.
SubscriptionId: (String) Workflow's Subscription (Studio) ID.
SubscriptionName: (String) Subscription display name.
TagIds: (Array) Array of Tag IDs.
ServiceId: (String) ID of the document in AlteryxServiceAS_Applications.
SourceAppId: (String) ID used for workflow migration (promotion) via the API.
Revisions: (Array) Array of info for all workflow revisions.
RevisionId: (String) Revision ID.
ParentId: (String)
RevisionNumber: (Int32)
AuthorId: ID of the author that published the revision.
DateCreated: (Date) Date-time (UTC) when the revision was published.
ExecutionMode: (Int32) Workflow run mode. 0=Safe. 1=Semi-Safe. 2=Unrestricted.
RunDisabled: (Boolean) Flag to disable workflow runs.
IsChunkedPackage: (Boolean) Flag that indicates whether the workflow package was split into chunks when uploaded.
RunCount: (Int32) Count of revision runs.
DownloadCount: (Int32) Count of revision downloads.
PackageType: (Int32) Integer value identifying type of workflow package. 0=app. 1=workflow. 2=macro.
PrimaryApplication: (Object) Workflow metadata.
FileName: (String) Workflow file name.
MetaInfo: (Object) Workflow metadata as provided by Designer. Includes these strings: Name, Description, Author, Copyright, Url, UrlText, OutputMessage, NoOutputFilesMessage.
NextApp: (String) Used for chained apps.
Validation: (Object) Validation info specific to the primary workflow.
IsValid: (Boolean) Flag set if workflow passes validation.
RequiresPrivateData: (Boolean) Flag set if the workflow requires location or business insights data.
Messages: (Array) Validation error messages.
DatasetMessages: (Array) Validation error message if caused by dataset requirement.
ValidationId: (String) Validation Job ID.
RequiresApproval: Workflow violates configured run mode and requires approval by a curator.
Applications: (Array) Workflow metadata. The data structure is the same as Primary Application but also includes information about chained apps.
Validation: (Object) Validation information for the overall package. Validation is performed when the workflow is published. Fields are the same as those in the Primary Application Validation object.
HasPrivateDataExemption: (Boolean) Flag for private data exemption. HasPrivateDataExemption can be null if it has never been set. Defaults to false if no value is present.
UploadDate: (Date) Date-time (UTC) the workflow was uploaded.
WorkflowCredentialType: (Int32) Integer value identifying the workflow credential type.
CredentialId: (String) ID of the workflow credential used.
CredentialUsername: (String) Credential username.
CredentialPasswordId: (String) ID of the stored credential password.
IsE2: (Boolean) Identifies if the specific workflow revision is using the e2 (AMP) engine.
Permissions: (Array) Workflow-specific permissions.
CanDownload: (Boolean) Flag that enables workflow downloads.
AllowVersionHistory: (Boolean) Flag that allows others to view workflow history.
PublishedRevision: (Object) Array defining the current published revision of the workflow. The data structure is the same as Revisions.
IconId: (String) Workflow icon image ID.
Version: (Null)
WorkerTag: (String) Workflow worker tag.
IsReadyForMigration: (Boolean) Workflow migration (promotion) flag.
Comments: (String) Any comment pertaining to a workflow.
RunDisabled: Flag to disable workflow runs.
PackageType: (Null)
The AppInfoSearchData Collection contains AppInfox index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
OwnerId: (String) User ID for the user that created the workflow.
SubscriptionId: (String) Workflow's Subscription (Studio) ID.
IsPublic: (Boolean) Workflow publicly shared flag.
TagNames: (String) Tag names.
Name: (String) The display name of the search object.
Owner: (String) Display name of the user that created the workflow.
FileName: (String) Workflow file name.
ChainedAppNames: (String) Names of the chained apps.
TagIds: (String) Tag IDs.
PackageType: (Int32) Integer value identifying type of workflow package. 0=app. 1=workflow. 2=macro.
DateCreated: (Date) Date-time (UTC) when the revision was published.
DateMadePublic: (Date) Date-time (UTC) when the workflow was last made public.
TotalRunCount: (Int32) Count of all runs across all workflow versions.
IsAmp: (Boolean) Flag for AMP usage.
The appPackages Collection is no longer used.
The auditEvents Collection contains audit log events. Visit the Auditlogs API Endpoint help page.
_id: (ObjectId) Document primary key.
Entity: (String) Type of object created, changed, or removed.
EntityId: (String) Object ID.
UserId: (String) User ID for the user that triggered the action.
Timestamp: (Date) Date-time (UTC) the action occurred.
Event: (String) The action.
OldValues: (String) Original entity values.
NewValues: (String) New entity values.
The authenticationNonces Collection stores nonce values used during authentication.
_id: (ObjectId) Document primary key.
NonceValue: (String) Unique nonce value.
TimeStamp: (Date) Date-time (UTC) the nonce was created.
The bannerImages Collection contains banner images uploaded to Server. See Media.
_id: (ObjectId) Document primary key.
MimeType: (String) Uploaded image mime type.
FileName: (String) Uploaded image file name.
Banner: (String) Base64-encoded binary data for the uploaded file.
Active: (Boolean) Flag for whether the banner is active.
StartDate: (Date) Date-time (UTC) when the banner was set to active.
EndDate: (Date) Date-time (UTC) when the banner was set to inactive.
SortOrder: (Int32) Banner rotation order.
Link: (String) URL banner image links to.
AltText: (String) URL descriptive hover text.
The "collections" Collection contains data about collections.
_id: (ObjectId) Document primary key.
CollectionId: (String) Collection ID. Used in the Server collection URL.
Name: (String) Collection name.
OwnerId: (String) User ID of collection owner.
DateAdded: (Date) Date-time (UTC) collection was created.
Apps: (Array) Array of info on all workflows in the collection.
ApplicationId: (String) Workflow ID.
DateAdded: (Date) Date-time (UTC) workflow was added to the collection.
AddedById: (String) User ID for the user that added the workflow to the collection.
Schedules: (Array) Array of info on all schedules in the collection.
ScheduleId: (String) Schedule ID.
DateAdded: (Datetime) Date-time (UTC) schedule was added to the collection.
AddedById: (String) User ID for the user that added the schedule to the collection.
Insights: (Array) Array of info on all insights in the collection.
InsightId: (String) Insight ID.
DateAdded: (Date) Date-time (UTC) insight was added to the collection.
AddedById: (String) User ID for the user that added the insight to the collection.
Users: (Array) Array of users the collection is shared with.
UserId: (String) User ID.
DateAdded: (Date) Date-time (UTC) user was added.
AddedById: (String) User Id of the user who added the user.
ActiveDirectoryObject: (Array) Active Directory info for Servers using integrated windows authentication.
Category: (Int32) Type of Active Directory object. 0=user. 1=group.
Name: (String) Network name for Active Directory user or group.
Sid: (String) SID for Active Directory user or group.
DisplayName: (String) Active Directory user or group name.
ExpirationDate: (Date) User's expiration date-time (UTC).
Permissions: (Object) User's collection permissions.
Collection: (Object) Collection-level user permissions.
IsAdmin: (Boolean) Flag for collection admin permissions. Users with this permission have all asset and user-management permissions.
Assets: (Object) Asset-level collection permissions.
CanAdd: (Boolean) Permission for adding assets (for example, workflows and insights) to the collection.
CanRemove: (Boolean) Permission for removing assets (for example, workflows and insights) from the collection.
CanUpdate: (Boolean) Permission for updating assets (for example, workflows and insights) in the collection.
Users: (Object) User-management collection permissions.
CanAdd: (Boolean) Permission to add users to the collection.
CanRemove: (Boolean) Permission for removing users from the collection
Subscriptions: (Array) Array containing info on the subscriptions (studios) the collection is shared with. The data structure is the same as Users.
UserGroups: (Array) Array containing info on the user groups the collection is shared with. The data structure is the same as Users.
The CollectionSearchData Collection contains collection index data and fields for Search.
_id (ObjectID): Document primary key.
_t: (String) Type descriminator.
Name (String): Name of the collection.
Owner (String): Name of the collection owner.
OwnerId: (String) User ID of collection owner.
DateCreated (Datetime): Date-time the collection was created.
WorkflowCount (Int32): Number of workflows inside a collection.
ScheduleCount (Int32): Number of schedules inside a collection.
UserCount (Int32): Number of users inside a collection.
UserGroupCount (Int32): Number of user groups inside a collection.
CollectionId (String): ID of the collection that this object represents.
The commandQueueItems Collection contains index search update commands. This collection is typically empty except in the case that the search indexer is currently updating entries or a failure to update search indexes has occurred.
_id: (ObjectId) Document primary key.
Command: (Int32) Type of command.
SearchData: (Object) Metadata specific to the search index. This schema may vary depending on the type of search being created or updated. There are additional fields containing the search data.
_t: (String) Type of search data.
_id: (String) Search data ID.
State: (Object) Update request state and messaging.
The Configurations Collection contains Server configuration information and settings.
_id: (ObjectId) Document primary key.
EffectiveDate: (Date) The installation date-time (UTC) for the environment
SystemMessage: (String) Banner system message displayed to users in Server. Go to Notifications.
[Obsolete] Terms: (Array) Terms of service information (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
[Obsolete]_id: (ObjectId) Document primary key.
[Obsolete] EffectiveDate: (Date) Date terms were agreed to.
[Obsolete] Text: (String) Terms of service agreement text.
Notifications: (Object) Email notification configuration info.
Email: (Array) Array containing data on the email notification configuration.
Name: (String) Email notification name.
Subject: (String) Subject of the email.
Body: (String) Body of the email.
IsBodyHtml: (Boolean) Flag for HTML email notification body.
EmailGroup: (Object) Info on email preference group the email notification is a part of.
Group: (String) Email preference group ID.
Description: (String) Email preference group description.
Active: (Boolean) Flag for whether the group is active.
FriendlyName: (String) Email notification display name.
Description: (String) Description summarizing the notification.
Placeholders: (Array) Array of placeholder strings. Placeholders are used in the email notification templates. Strings include Collection Name, Collection Owner Name, Collection URL, Workflow Name, Workflow URL, and Collection Owner URL.
IsDisableable: (Boolean) Flag to allow notification to be disabled.
Enabled: (Boolean) Flag to enable notification.
NotificationPreferenceGroups: (Array) Email preference groups info.
Group: (String) Email preference group ID.
Description: (String) Email preference group description.
Active: (Boolean) Flag to make group active.
DesignerDownloadURL: (String) Designer download link URL.
DefaultPermission: (String) Default user role. Possible values are No Access, Viewer, Member, Artisan, or Curator.
SignupDisabled: (Boolean) Flag to disable Server account signups. Allows users to sign up for an account via the login screen in Servers using built-in authentication. This flag also allows accounts to be created automatically with SAML after the user successfully authenticates with the IDP.
GalleryName: (String) Custom name for the Server. Defined in theme settings. See Theme.
AnonymousUsage: (Boolean) Flat to enable anonymous (unregistered) users to run workflows.
ApiEnabled: (Boolean) Flag to enable Server API access.
CustomCss: (Object) Custom CSS defined in the Server theme. See Theme.
Sections: (Array) Array containing each theme section.
Name: (String) Section name. Possible values are Header, Side Navigation, Primary button, Secondary button.
Styles: (Array) Style info.
Selector: (String) Comma-separated list of selectors style is applied to.
Properties: (Array) Style properties.
FriendlyName (String) Friendly name of the CSS style property.
Names: (Array) CSS style properties.
Value: (String) Property value.
UserCredentialState: (Int32)
SchedulerEnabled: (Boolean) Server-level flag to enable scheduling.
SchedulerValidationInterval: (String)
KeyPairXmlEncrypted: (String) Encrypted key value.
NumAllowedLoginAttempts: (Int32) Number of login failures allowed before the account is locked.
MigrationEnabled: (Boolean) Flag to allow workflows to be migrated (promoted).
DirectDownloadDisabled: (Boolean) Permission flag that turns off ability of users to directly download a workflow.
AllowUnsharedCredentialAccess: (Boolean) Whether or not a Server data connection needs to be shared with a user in order to run a workflow that contains said data connection.
AllowedHosts: (String) List of newline separated hostnames that the service is allowed to serve data for. Default value is NULL. NULL and empty values allow all hostnames. The hostname 'localhost' and the hostname from the Server base URL are always allowed regardless of the setting.
LastForecastRefresh: (Datetime) the last time the schedule forecast was refreshed.
ForecastInterval: (Int32) Number of minutes between schedule forecast refreshes.
AccountLockTimeout: (Int32) Account lockout period
EnforceLoginAttemptTimeout: (Boolean) Flag to enable account lockout for failed attempts.
LanguageEnabled: (Boolean) Flag to enable language support.
DefaultLanguage: (String) System defined default language/locale.
ScimConfiguration: (Object) An object that contains the following fields:
isEnabled (Boolean) Whether or not SCIM provisioning is enabled.
canonicalURI (String) The canonical URI of the Server basepath for SCIM.
webAPIURI (String) The canonical URI of the webAPI basepath for SCIM.
scimToken (Object) Contains 3 more fields:
JWT (String) The token describing the SCIM connection information.
lifetimeDays (Int32) Number of days the SCIM is valid for.
symmetricKey (String) The encrypted version of the encryption key used to store the JWT.
The credentials Collection contains workflow credentials data. See Credentials.
_id: (ObjectId) Document primary key.
Username: (String) Workflow credential username.
PasswordId: (String) Stored password ID.
Subscriptions: (Array) Array of subscription IDs the workflow credential has been shared with.
Users: (Array) Array of user IDs the workflow credential has been shared with.
UserGroups: (Array) Array containing UserGroup IDs the credential has been shared with.
AppRevisions: (Array) Array of complex objects that contains an AppInfoID and an AppRevision ID.
AppInfoID (String): The appinfo that is using said credential.
AppRevisionID (String): The revision of an appinfo using said credential.
The CredentialSearchData Collection contains credential index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
UserName: (String) Workflow credential username.
The dCMEConnections Collection contains DCM.e connections (linked data source and credential) created on or synced to Server.
_id: (ObjectId) Document primary key.
ConnectionId: (String) Unique GUID of the connection.
CreatedOn: (String) ISO date-time when the connection was created.
LastChangedOn: (String) ISO date-time of the last update.
Name: (String) Display name of the connection.
SchemaName: (String) Credential type.
Version: (Integer) Version number.
AllowInSDKs: (Boolean) Flag to enable the connection to be used by SDK tools.
Parameters: (String) Associated metadata for the parent object.
DataSourceId: (String)
Credentials: (Object)
main (String)
Owner: (String) ID of the user that owns the connection.
CreatedBy: (String) ID of the user that created the connection.
LastChangedBy: (String) ID of the user that recently updated or changed the connection.
Deleted: (Boolean) Flag to indicate if the connection has been deleted.
DeletedBy: (String) ID of the user that deleted the connection.
DeletedOn: (String) Date-time the connection was deleted.
Users: (Array) Array containing user IDs the connection has been shared with. Allows execution of workflows in Server using the connection. Does not allow users to create new content with the connection.
UserGroups: (Array) Array containing user group IDs the connection has been shared with. Allows execution of workflows in Server using the connection. Does not allow users to create new content with the connection.
The dCMECredentials Collection contains DCM.e credentials created on or synced to Server.
_id: (ObjectID) Document primary key.
CredentialId: (String) Unique GUID of the credential.
CreatedOn: (String) ISO date-time when the credential was created.
LastChangedOn: (String) ISO date-time of the last update.
Name: (String) Display name of the credential.
SchemaName: (String) Credential type.
Version: (Integer) Version number.
Parameters (String) Associated metadata for the parent object.
Parameters
UserName: (String) Username associated with the credential.
Secrets (Object)
password (Object)
ExpiresOn
Parameters
Value (String) Encrypted secret.
Owner: (String) MongoID of the user that owns the credential.
CreatedBy: (String) MongoID of the user that created the credential.
LastChangedBy: (String) MongoID of the last user to update the credential.
Deleted: (Boolean) Flag indicating if the credential has been deleted.
DeletedBy: (String) MongoID of the user that deleted the credential.
DeletedOn: (String) ISO date-time the credential was deleted.
The dCMEDataSources Collection contains DCM.e data sources created on or synced to Server.
_id: (ObjectID) Document primary key.
DataSourceId: (String) Unique GUID of the connection.
CreatedOn: (String) ISO date-time when the connection was created.
LastChangedOn: (String) ISO date-time of last update.
Name: (String) Display name of the connection.
SchemaName: (String) Credential type.
Version: (Integer) Version number.
DriverName: (String) Name of the driver driver utilized within the DCME connection.
Host: (String) hostname or FQDN of a server providing the data source.
Parameters: (String) Associated metadata for the parent object.
Parameters
Owner: (String) ID of the user that owns the data source.
CreatedBy: (String) ID of the user that created the data source.
LastChangedBy: (String) D of the user that recently updated or changed the connection.
Deleted: (Boolean) Flag indicating if the data source has been deleted.
DeletedBy: (String) ID of the user that deleted the data source.
DeletedOn: (String) Date-time the data source was deleted.
The dataConnections Collection contains data connections. See Data Connections.
_id: (ObjectId) Document primary key.
ConectionString: (String) Hashed database connection string.
PasswordSecured: (String) Encrypted password for the database connection.
ConnectionName: (String) Data connection display name.
Subscriptions: (Array) Array of subscription IDs the data connection has been shared with.
Users: (Array) Array of user IDs the data connection has been shared with.
UserGroups: (Array) Array of group IDs the data connection has been shared with.
The DataConnectionSearchData Collection contains dataConnection index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
ConnectionName: (String) Data connection display name.
ConnectionString: (String) Data connection string.
ConnectionType: (String) Data connection type.
The districtIcons Collection contains data for icons associated with districts. See Districts.
_id: (ObjectId) Document primary key.
FileName: (String) Icon file name.
MimeType: (String) Icon mime type.
LargeIcon: (String) Base64-encoded binary data for the uploaded file.
UploadDate: (Date) Date-time (UTC) icon was uploaded.
SmallIcon: (String) Base64-encoded binary data for the icon thumbnail.
The districts Collection contains data about districts. See Districts.
_id: (ObjectId) Document primary key.
Title: (String) District display name.
Description: (String) District description.
TagId: (String) Tag ID for the tag associated with the district.
NavTitle: (String) District navigation link text.
IconId: (String) Icon ID.
Active: (Boolean) Flag for whether district is active.
SortOrder: (Int32) District sort order.
Excerpt: (String) District excerpt text.
The DistrictSearchData Collection contains district index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
Name: (String) District display name.
Tag: (String) Tag ID for the tag associated with the district.
Active: (Boolean) Flag for whether district is active.
OwnerId: (String) User ID for the user that owns the district.
DateCreated: (Date) Date-time (UTC) when the district was created.
The GlobalSearchData Collection contains index data and fields for Search globally across various object types.
_id: (ObjectId) Document primary key.
Name: (String) Object display name.
OwnerId: (String) User ID for the user that owns the object.
DateCreated: (Date) Date-time (UTC) object was created.
Type: (String) Object type.
IsViewable: (Boolean) Flag for whether the object is viewable by all users or only users it has been shared with.
Important
This Collection is new as of the 2020.1 version release. The data from the activeDirectoryPermissions was migrated to the WindowsIdentity object in this Collection and the users Collection.
The groupRoles Collection contains data about Active Directory groups. See Manage Groups.
_id: (ObjectId) Document primary key.
WindowsIdentity: (Object) Info on Active Directory group.
Sid: (String) Group SID (security identifier).
DisplayName: (String) Group display name.
Name: (String) Group name in
domain/groupformat.SamAccountName: (String) Sam account name.
Role: (String) Role assigned to the group. Possible values are No Access, Viewer, Member, Artisan, or Curator.
DateAdded: (Date) Date-time (UTC) the group was added to the environment. Note, for existing groups this date is set to the date-time of the upgrade to version 2020.1. If you skipped version 2020.1, the date-time of groups that existed prior to upgrade is set to the date-time of the upgrade to 2020.3.
The insightIcons Collection contains data about insight icons.
_id: (ObjectId) Document primary key.
FileName: (String) Icon file name.
MimeType: (String) Icon mime type.
LargeIcon: (String) Base64-encoded binary data for the uploaded file.
UploadDate: (Date) Date-time (UTC) icon was uploaded.
SmallIcon: (String) Base64-encoded binary data for the icon thumbnail.
The insights Collection contains data about insights.
_id: (ObjectId) Document primary key.
InsightId: (String) Insight ID. Used in the Server insight URL.
Name: (String) Insight display name.
LastUpdated: (Date) Date-time (UTC) insight was last updated.
OwnerId: (String) User ID for the user the owns the insight.
IconId: (String) Insight icon ID.
The InsightSearchData Collection contains insight index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
InsightId: (String) Insight ID. Used in the Server insight URL.
Name: (String) Insight display name.
Owner: (String) Display name of the insight owner.
OwnerId: (String) User ID for the user that owns the insight.
LastPublishedDate: (Date) Date-time (UTC) insight was last published.
DateCreated: (Date) Date-time (UTC) insight was created.
The locks Collection contains search indexing and schema migration locks. Index locks are set when actions are taken within the Server that require an index update for search purposes. Migration locks are set during Server installation or upgrade.
_id: (ObjectId) Document primary key.
Type: (Int32) Type of lock. 0=index. 1=schema migration, 2=schedule forecast.
LastObtained: (Date) Date-time (UTC) the lock was last obtained.
MachineName: (String) Hostname of the Server node holding the lock.
OwnerId: (String) Process ID of the process that last used the lock.
The logoImages Collection contains data about logo images uploaded in the Server theme. See Theme.
_id: (ObjectId) Document primary key.
ImageData: (String) Base64-encoded binary data for the uploaded file.
IsDefault: (Boolean)
MimeType: (String) Logo mime type.
The medias Collection contains data about uploaded media files. See Media.
_id: (ObjectId) Document primary key.
FileName: (String) Icon file name.
Title: (String) Title of the media. This is usually the same as the file name.
Type: (String) The type of media file uploaded.
Data: (String) Base64-encoded binary data for the uploaded file.
Thumbnail: (String) Base64-encoded binary data for the thumbnail.
Extension: (String) File extension.
The MediaSearchData Collection contains media index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
FileName: (String) Icon file name.
Title: (String) Title of the media. This is usually the same as the file name.
Type: (String) The type of media file uploaded.
Extension: (String) File extension.
The navigations Collection contains data about links specified on the Links page. See Links.
_id: (ObjectId) Document primary key.
Header: (Array) Array of header links. Footer links were moved to the header.
_id: (ObjectId) Link ID.
Title: (String) Link text.
URL: (String) Link URL.
Children: (Array)
PageId: (String) ID of the linked page (if the link is to a Server page).
Footer: No longer used.
Main: No longer used.
The pages Collection contains data about pages. See Pages.
_id: (ObjectId) Document primary key.
AuthorUserId: (String) User ID for the user that created the page.
Title: (String) Page title.
Permalink: (String) Page permalink.
Body: (String) Page body content.
Excerpt: (String) Page excerpt.
Categories: (Null)
Status: (Int32) Page status. 0=Draft. 1=Published.
CreatedDate: (Date) Date-time (UTC) page was created.
UpdatedDate: (Date) Date-time (UTC) page was last updated.
The PageSearchData Collection contains page index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
Status: (Int32) Page status. 0=Draft. 1=Published.
Author: (String) Author display name.
Name: (String) Page display name.
OwnerId: (String) User ID for the user that owns the page.
DateCreated: (Date) Date-time (UTC) page was created.
The scheduleForecasts collections contains Schedule Forecaster cache data. See Schedule Forecast.
_id (ObjectId): Document primary key.
ScheduleId (String): Unique ID of the schedule.
AppEstimatedCompletionTime (Int32): The predicted amount of time the schedule will run for.
ScheduleName (String): Name of the schedule.
StartTime (Date): Date-time the schedule should start.
Frequency (String): Frequency at which the schedule will occur.
WorkflowName (String): Name of the workflow associated with the schedule.
OwnerId (String): Unique ID of the user that owns the schedule.
Priority (Int32): Integer value representing the priority of the schedule.
The searchLocks Collection is a helper collection when rebuilding the index collections that end with SearchData.
_id (ObjectID): Document primary key.
Name (String): Name of the lock.
ExpireAt (Datetime): Date-time that the lock will expire.
The secureCommss Collection contains key exchange information for secure communications related to DCMe. This information is session specific and expires with the session.
_id: (ObjectId) Document primary key.
SessionID: (String) Unique session ID.
UserId: (String) Unique user ID.
ServerRSAPublicKey: (String) RSA public key for the user.
ServerRSAPrivateKey: (String) RSA private key for the user.
ServerECDHPublicKey: (String) ECDH public key for the user.
ServerECDHPrivateKey: (String) ECDH private key for the user.
ClientRSAPublicKey: (String) RSA public key for the client.
ClientECDHPublicKey: (String) ECDH public key for the client.
SharedSecret: (String) Key shared with Designer for secure communications.
IsDesignerSyncKeys: (Boolean) Used to determine whether or not the keys are used in Designer.
The sessions Collection contains user session data.
_id: (ObjectId) Document primary key.
SessionId: (String) Session ID.
Active: (Boolean) Flag for whether the session is active.
UserId: (String) User ID.
CreationDate: (Date) Date-time (UTC) session was created.
UpdateDate: (Date) Date-time (UTC) session was last updated.
Anonymous: (Boolean) Flag for whether session is for an anonymous user.
KeepAlive: (Boolean) Flag for whether the session should be kept alive.
The subscriptions Collection contains user subscription/studio information. See Subscriptions.
_id: (ObjectId) Document primary key.
[Obsolete] LicenseKey: (String) Subscription (Studio) key.
Name: (String) Studio display name.
ApiKey: (String) Subscription API key.
ApiSecret: (String) Encrypted/hashed API secret for the subscription/studio.
[Obsolete] PrimaryContactInfo: (Object) Info on the primary contact for the subscription. This entire object is now obsolete.
Active: (Boolean) Flag for whether subscription is active.
[Obsolete] Type: (Int32) Type of subscription. 0=free. 2=paid.
[Obsolete] SeatsPurchased: (Int32) Number of Artisan seats.
[Obsolete] MemberPassesPurchased: (Int32) Number of Member seats.
[Obsolete] MemberPassesUsed: (Int32) Number of Member seats assigned to users.
[Obsolete] PurchaseDate: (Date) Date-time (UTC) subscription was created.
[Obsolete] ExpirationDate: (String) Date-time (UTC) subscription expires.
ExpDate: (Date) Date-time (UTC) subscription expires.
DateUpdated: (Date) Date-time (UTC) subscription was last updated.
[Obsolete] TrialUsed: (Boolean)
ApiEnabled: (Boolean) Flag to enable Server API access for the subscription.
CanShareSchedules: (Boolean) Flag to enable scheduling for the subscription.
CredentialId: (String) Default workflow credential ID for the subscription.
Credentials: (Array) List of workflow credential IDs shared with the subscription.
DataConnections: (Array) List of data connection IDs shared with the subscription.
The SubscriptionSearchData Collection contains subscription index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
Name: (String) Subscription (studio) display name.
The tags Collection contains data about tags. Visit the Create Workflow Tags help page.
_id: (ObjectId) Document primary key.
Name: (String) Tag display name.
Description: (String) Tag description.
AdminOnly: (Boolean) Tag is enabled for Curators only.
The TagSearchData Collection contains tag index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
Name: (String) Tag display name.
AdminOnly: (Boolean) Tag is enabled for Curators only.
The temporaryTokens Collection contains temporary tokens associated with user sessions.
_id: (ObjectId) Document primary key.
Token: (String) Token string.
UserId: (String) User ID.
Expiration: (Date) Date-time (UTC) token expires.
SessionId: (String) Session ID.
The usageReports Collection contains Designer usage data from Designers configured to report usage to this Server.
_id: (ObjectId) Document primary key.
Type: (Int32) Integer value representing the type of usage data captured. Possible values are 10=AppExecution, 11=SignupDisplayed, 12=GlobalSearch, 13=LicenseTransfer, 14=Shepherding, GlobalSettings=15, 400=Profiling, 401=DataProfiling, 1000-1999=Exceptions.
SerialNumber: (String) Serial number (typically an email address) associated with the active license.
DeviceId: (String) ID of device reporting the data. The ID is a combination of the device GUID, machine name, and serial number.
SeatGuid: (String) Seat ID.
FlexnetVendorSnippets: (Object) License data.
ActivationId: (String) Activation ID issued by Flexera when a license is activated.
ProductName: (String) Activated product names.
Snippet: (String) Hashed value.
Guid: (String) Unique Guid.
IpAddress: (String) IP address for machine reporting usage data.
DateTime: (Date) Date-time (UTC) the data was reported by the client.
ServerDateTime: (Date) Date-time (UTC) on the Server when the data was received.
Version: (String) Version of Designer.
Preview: (Boolean) Flag for whether the build is Beta.
Cores: (Int32) Number of cores detected by Designer.
IsTrial: (Boolean) Flag for a trial license.
Data: (String) Usage data in JSON format.
UserId: (String) User ID.
The userGroups collection contains group data for local and custom groups.
_id: (ObjectID): Document primary key.
Name: (String) Name of the group.
Members: (Array) Array of users that are part of the group.
UserId: (String) Unique ID of the user added to the group (NULL if the member is an Active Directory user or Active Directory Group).
DateAdded: (Date) Date-time the user was added.
AddedById: (String) Unique ID of the admin that added the user to the group.
ActiveDirectoryObject: (Object) Object that contains an Array of the groups Active Directory information. If the group is an ActiveDirectory group the Array will provide the groups ActiveDirectory details. If the group is a local/server/custom group this Object will be NULL.
Sid: (String) User's or Group's Active Directory security ID.
Category: (Int32) Identifies if an Active Directory object is a user or a group (0 = User, 1 = Group).
DisplayName: (String) User's Active Directory Display Name in 'firstName lastName' format.
DomainName: (String) User's network name in 'domain\username' format.
SamAccountName: (String) User's Active Directory Sam (username).
Role: (String) String value for the role assigned to the group.
DateAdded: (Date) Date-time the group was created.
Credentials: (Array) Array of workflow credentials assigned to the group.
DataConnections: (Array) Array of data connections shared with the group.
The userIcons Collection contains information about user icons.
_id (ObjectID): Document primary key.
FileName (String): Name of the file.
MimeType (String): Type of file.
LargeIcon (String): Image base64 encoded.
UploadDate (Datetime): Date-time the icon was uploaded.
SmallIcon (String): Image base64 encoded.
UserId (String): User that the icon is for.
The users Collection contains user data.
_id: (ObjectId) Document primary key.
[Obsolete] Curator: (Boolean) Flag to for Curator permission.
[Obsolete] Anonymous: (Boolean) Flag to set user to anonymous.
[Obsolete] LicenseCurator: (Boolean) Flag to allow user to manage licenses (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
[Obsolete] Sponsor: Subscription ID that is granting membership rights.
Role: The user's assigned role.
Email: (String) The user's email address.
FirstName: (String) The user's first name.
LastName: (String) The user's last name.
DateAdded: (Date) Date-time (UTC) the user was created.
DateUpdated: (Date) Date-time (UTC) the user was last updated.
[Obsolete] DateTermsAgreed: (Date) Date-time (UTC) the user agreed to terms of service (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
Validated: (Boolean) The user's email address has been validated.
Pending: (Boolean) The user's email address is pending validation.
Active: (Boolean) The user's email address is active.
ApiEnabled: (Boolean) Enables access to the Server API.
ApiKey: (String) User's API key. Used to access both the admin and user API. Admin access requires the user to be a Curator.
ApiSecret: (String) Encrypted API secret. Used to access both the admin and user API. Admin access requires the user to be a Curator. (Change: Schema and values haven't changed just the usage and description.)
SecurityInfo: (Object) User password info.
Password: (String) Hashed, salted, and encrypted password.
HMACKey: (String) HMAC key for hashing password.
Salt: (String) Salt value used to salt password.
PasswordResetNonce: (String) Nonce value used when password reset is initiated.
NumFailedLogins: (Int32) Count of failed login attempts.
AccountLocked: (Boolean) Flag for locked account.
AccountLockedAt: (Date) Date-time (UTC) account was locked.
UserProfile: (Object) Extended user info.
[Obsolete] Company: (String) User's company.
[Obsolete] Title: (String) User's title.
[Obsolete] Department: (String) User's department.
[Obsolete] JobRole: (String) User's job role.
[Obsolete] ContactPhoneNumber: (String) User's phone number.
[Obsolete] CompanyAddress: (String) User's company addresss.
[Obsolete] Nickname: (String) User's nickname.
Picture: (String) User's profile picture.
[Obsolete] Website: (String) User's website.
[Obsolete] PublicProperties: (Null)
IconId: (String) ID of the user's profile picture.
SubscriptionId: (String) User's subscription ID.
[Obsolete] Referrer: (String) ID of the user that referred the user (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
[Obsolete] Referral: (Object) Referrer info (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
ExpDate: (Date) Date-time (UTC) the user's account expires (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
LastLoginDate: (Date) Date-time (UTC) of the user's last login.
Notifications: (Object) Notifications sent to the user.
Messages: (Object) Info on notifications sent to the user.
_t: (String) Type of notification.
_id: (ObjectId) Notification message ID.
Message: (String) Message content in HTML.
CreatedDate: (Date) Date-time (UTC) the message was sent.
Category: (String) Notification category.
Enabled: (Boolean) Flag for whether notification is enabled.
IsUnread: (Boolean) Tracks if the message has been read by the user or not.
LastPolled: (Date) Date-time (UTC) the notifications were last checked.
LocalizationNotificationSent: (Boolean) Tracks if the user has been presented the localization notice.
NotificationGroupsToFilter: (Array) Array containing info on notifications the user has opted out of via email group selection.
IsPasswordMigrated: (Boolean) To determine whether or not a password is using new encryption.
WindowsIdentity: (Array) The user's Active Directory identity information for use with Integrated Windows Authentication.
Sid: (String) User's Active Directory security ID.
DisplayName: (String) User's Active Directory display name.
Name: (String) User's Active Directory name in
domain\user format.SamAccountName: (String) User's Active Directory Sam (typically their login name).
[Obsolete] SignupLocation: (Int32) Integer value representing where the user signed up (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
[Obsolete] Sid: (String) User's Active Directory Security ID.
DefaultCredential: (Object) User's selected default credential. Value is null if the user hasn't set a default credential.
Username: (String) Username for the user's default credential.
PasswordId: (String) Encrypted password if the user-provided credentials that aren't shared. Value is null if the user selects a shared workflow credential as their default credential.
CredentialId: (String) Id of the workflow credential if the user-selected default is a shared credential.
Credentials: (Array) Workflow credentials shared with the user.
DataConnections: (Array) Data connections shared with the user.
CanSchedule: (Boolean) User permission flag for scheduling workflows.
CanSetPriority: (Boolean) User permission flag for setting workflow priority.
CanSetWorkerTag: (Boolean) User permission flag for setting a worker tag.
Timezone: (String) User's selected time zone.
CanCreateCollections: (Boolean) User permission flag for creating collections.
DefaultWorkerTag: (String) User's default worker tag.
IsDeleted: (Boolean) Flag to indicate if the user record has been deleted.
DeletedById: (String) ID of the user that deleted the user record.
DeletedDateTime (Date) Date-time the user was deleted.
Language (String) User's preferred language/locale.
canCreateAndUpdateDcm (Boolean): Flag to indicate if the user has the permission to create or update DCM assets (data sources, credentials, and external vaults). Without this permission, users cannot create, edit, and synchronize DCM assets from Designer.
canShareForExecutionDcm (Boolean): Flag to indicate if the user has the permission to share DCM connection credentials to run on Server only.
canShareForCollaborationDcm (Boolean): Flag to indicate if the user has the permission to share DCM connection credentials for collaboration.
canManageGenericVaultsDcm (Boolean): Flag to indicate if the user has the permission to manage DCM generic vaults.
The UserSearchData Collection contains user index data and fields for Search.
_id: (ObjectId) Document primary key.
_t: (String) Type descriminator. Used by the Mongo C# driver to assist with deserialization.
Email: (String) The user's email address.
Name: (String) The user's display name.
DateAdded: (Date) Date-time (UTC) the user was created.
Role (String): The user's assigned role.
Active: (Boolean) The user's email address is active.
_id: (ObjectId) Document primary key.
UserId: User ID.
The versions Collection contains MongoDB database schema version data.
_id: (ObjectId) Document primary key.
Number: (Int32) MongoDB database schema version number.
MigrationDate: (Date) Date-time the schema was migrated to this version in UTC. This is typically the date and time of the upgrade to a new Server version.
Important
This Collection is obsolete as of the 2020.1 version release. The data is preserved if you upgrade from a previous version but is unused.
The windowsIdentitys collection contains Active Directory user information for use with Integrated Windows Authentication.
[Obsolete] _id: (ObjectId) Document primary key.
[Obsolete] Name: (String) User's Active Directory name in domain\user format.
[Obsolete] Sid: (String) User's Active Directory security ID.
[Obsolete] GivenName: (String) User's first name in Active Directory.
[Obsolete] SurName: (String) User's last name in Active Directory.
[Obsolete] Email: (String) User's email address in Active Directory.