Skip to main content

AlteryxService MongoDB Schema

The AlteryxService MongoDB is the service-layer database for your Server instance. This article covers the AlteryxService MongoDB schema version 46, which corresponds to Server versions 2023.2. 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 a 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 AlteryxService MongoDB is made up of the below collections. Collections are a 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.

The [Collection].Files Collections are used if the document exceeds MongoDB's max document size of 16MB. See MongoDB Document Limitations.

The AS_App_Chunks Collection contains workflow package chunks. The corresponding AS_App_Chunks.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • Checksum: (String) The SHA256 checksum of the chunk contents.

  • Chunk: (Binary) The chunk contents.

  • RequestID: (String) The front-end RequestID that uploaded this app chunk.

The AS_ApplicationVersions Collection contains workflow version history. The corresponding AS_ApplicationVersions.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • ApplicationId: (String) Workflow ID (as found in the AS_Applications table).

  • VersionHistory: (String) Pipe separated list of versions.

The AS_Applications Collection contains data on workflows stored in the service database. The corresponding AS_Applications.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the schedule.

  • CPUName: (String) Hostname or IP address of the workstation or Server node that created the schedule.

  • CreationDateTime: (DateTime) Date-time (local server time) the record was created.

  • ModuleName: (String) Workflow file name.

  • InternalFileName: (String) File name.

  • PackageDefinition: (String) The ID of the package definition associated.

  • Module: (Binary) The workflow if stored in its entirety.

  • RequestID: (String) The front-end RequestID that uploaded this application.

The AS_Galleries Collection contains Service layer information regarding Server UI registrations (for the potential future use). The corresponding AS_Galleries.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • HostName: (String) URI of a Server UI node.

  • GalleryId: (String) Unique ID of a Server UI node for a particular life cycle of ServerHost.

  • LastUpdateDateTime: (DateTime) Date-time the Server UI registration was last updated.

The AS_Insights Collection contains data on workflows stored in the service database. The corresponding AS_Insights.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the insight.

  • CreationDateTime: (DateTime) Date-time (local server time) the record was created.

  • InsightId: (String) The effective primary key for this insight.

  • Insight: (Binary) Insight file.

The AS_PackageDefinitions Collection contains package definition data. The corresponding AS_PackageDefinitions.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the schedule.

  • CPUName: (String) Hostname or IP address of the workstation or Server node that created the schedule.

  • CreationDateTime: (DateTime) Date-time (local server time) the record was created.

  • PackageDefinition: (String) Package Definition XML.

The AS_Queue Collection contains queued jobs. Both currently waiting and completed jobs are present in the queue. The corresponding AS_Queue.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • __Priority: (Int64) Long Int32 used to sort the queue.

  • AS_Application_ID: (String) Workflow ID from AS_Applications.

  • Type: (String) Type of job.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the job.

  • SubscriptionId: (String): Subscription ID.

  • CreationDateTime: (DateTime) Date-time (local server time) job was created.

  • Status: (String) Job status.

  • Owner: (String) Hostname and worker ID of the worker that picked up the job from the queue.

  • CompletionDateTime: (DateTime) Date-time (local server time) job was completed.

  • QOS_Priority: (Int64) Job priority.

  • IsAnonymous: (Boolean) Flag for job queued by anonymous user.

  • IsHidden: (Boolean) True if the app is not the last app in a series of chained apps.

  • RestrictOutput: (Boolean). Deprecated. Leftover from Public Gallery.

  • AppName: (String) Workflow name.

  • ClientType: (String) Client type that created the job.

  • AS_Schedules_ID: (String) ID of the schedule associated with the queue record.

  • AlteryxResultCode: (Int32) Result code from the Engine for the workflow.

  • DefaultModule: (String) The name of the workflow to be executed. Specifically, the name of the workflow that is executed by default in a package that contains multiple workflow files.

  • Error: (String) Error message for a job that failed to run.

  • ExecutionTime: (Double) The runtime of the job.

  • JobName: (String) For a scheduled job, the name of the schedule. Otherwise, the name given to the job by the user, if any.

  • ModuleName: (String) The name of the workflow to be executed. Might be different from DefaultModule.

  • Parameters: (String) Parameters to pass to the Engine.

  • QueueInputIDs: (String) A pipe-separated collection of queue input IDs (found in the AS_QueueInputs table) that will be used by the job.

  • RequestID: (String) The front-end RequestID that triggered the job run.

  • ResultIDs: (String) A pipe-separated collection of result IDs (found in the AS_ResultsFiles table) generated by a previous job that will be used by this job.

  • RunAsPasswordId: (String) The ID of the RunAs password (found in the AS_RunAsCredentials table) that will be used by this job.

  • RunAsUser: (String) The username of the RunAs account that will be used by this job.

  • RunWithE2: (Boolean) Whether to explicitly run this job with E2.

  • Version: (String) The version of the app package to use when the app has more than one version.

  • WizardValues: (String) Answers to Analytic App Questions.

  • WorkerTag: (String) The worker tag for this job.

The AS_QueueInputs contains temporary input files to be used when running apps. For example, the inputs selected in the File Browse tool.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the schedule.

  • CreationDateTime: (DateTime) Date-time the user uploaded the file.

  • FileName: (String) File name.

  • InternalFileName: (String) File name.

  • File: (Binary) Files binary.

  • RequestID: (String) The front-end RequestID that uploaded this queue input file.

The AS_ResourcePermissions Collection contains data on permission context for data connections. The corresponding AS_ResourcePermissions.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • ResourceId: (String) Resource ID.

  • ContextId: (String) Permission context ID.

The AS_Resources Collection contains info on data connections. The corresponding AS_Resources.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • ResourceId: (String) Resource ID.

  • ResourceValue: (String) Resource value.

The AS_Results Collection contains workflow results data. The corresponding AS_Results.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • AS_Queue_ID: (String) The ID of the job that generated this result.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the schedule.

  • OutputLog: (Binary) Messages the Engine wrote while writing the workflow. Stored in binary format.

  • TotalFileSize: (Int64) The accumulated size of all files in AS_ResultsFiles for this job result, in bytes.

  • ExecutionStartTime: (DateTime) Date-time the workflow started running.

  • ExecutionTime: (Double) How long the workflow took to run.

The AS_ResultsFiles Collection contains workflow results data. The corresponding AS_ResultsFiles.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • AS_Queue_ID: (String) The ID of the job that generated this result file.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the schedule.

  • FileName: (String) File name.

  • File: (Binary) File contents.

The AS_RunAsCredentials contains Run As credentials. The corresponding AS_RunAsCredentials.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • EncData: (String) Encrypted RunAs password.

The AS_Schedules contains service-layer information regarding schedules. The corresponding AS_Schedules.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • AS_Application__ID: (String) Workflow ID from AS_Applications.

  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the schedule.

  • CPUName: (String) Hostname or IP address of the workstation or Server node that created the schedule.

  • CreationDateTime: (DateTime) Date-time (local server time) the schedule was created.

  • NextRunDateTime: (DateTime) Date-time (local server time) the schedule is next scheduled to run.

  • UntilDateTime: (DateTime) Schedule end date-time (local server time).

  • LastRunDateTime: (DateTime) Date-time (local server time) the schedule last ran.

  • Status: (String) Schedule status.

  • LC_ScheduleName: (String) Name of the schedule in lower-case.

  • LC_Owner: (String) Schedule owner in lower-case.

  • ClientType: (String) Type of schedule created.

  • AS_PackageDefinition__ID: (String) Package definition ID.

  • ApplicationName: (String) The name of the workflow that was scheduled.

  • AS_Queue_ID: (String) The ID of the most recent job run for the schedule.

  • Comment: (String) Schedule comment.

  • CredentialId: (String) The credential associated with the schedule.

  • CredentialSource: (String) Where the schedules credential came from.

  • Enabled: (Boolean) Whether the schedule is enabled to run.

  • Frequency: (String) How often the schedule runs in readable format.

  • Iteration: (String) The serialized iteration for the schedule.

  • IterationFormula: (String) The serialized iteration for the schedule formula.

  • LastErrorCode: (String) The last error code for the schedule.

  • LastModifiedDate: (DateTime) The last date the schedule was modified.

  • LastModifiedId: (String) Who modified the schedule last.

  • NumberOfTimesRun: (Int64) How many times the schedule has been run.

  • Type: (String)

  • Owner: (String) Schedule owner.

  • PasswordId: (String) Id for the credential password.

  • Priority: (Int64) Priority of the schedule.

  • RequestId: (String) The front-end RequestID that created this schedule.

  • RunAsUser (String) User context the schedule jobs will run as.

  • RunWithE2: (Boolean) Whether the schedule is for an AMP workflow.

  • ScheduleName: (String) Name of the schedule.

  • StartDateTime: (DateTime) Date-time the workflow should start running.

  • Timezone: (String) Timezone for the schedule.

  • WorkerTag: (String) The worker tag for the schedule

The AS_TileSetAccessTimes Collection is no longer used.

The AS_TileSets Collection contains data on workflows stored in the service database. The corresponding AS_TileSets.Files Collection is used if the document exceeds MongoDB's max document size.

  • _id: (ObjectId) Document primary key.

  • __Version: (Int32) Version number.

  • Checksum: (String) The SHA256 checksum of the tileset.

  • TileSetPool: (String) The Pool ID.

  • RenderSettings: (String) Render settings.

  • YxdbInfo: (Binary) Meta info for the YXDB file.

The AS_TileSets Collection contains table/collection version data for migrations.

  • _id: (ObjectId) Document primary key.

  • id: (String)

  • tableName: (String) Name of the table.

  • versionNumber: (Int32) Version number.

  • completionDate: (String) Date the job was completed.