AlteryxService MongoDB Schema

Version:
2020.2
Last modified: September 01, 2020

The AlteryxService MongoDB is the service-layer database for your Server instance. This article covers the AlteryxService MongoDB schema version 28, which corresponds to the 2020.2 Server version. 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.

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.

Version 2020.2 MongoDB Schema Changes

In the 2020.2 version release, the AlteryxGallery MongoDB includes these new fields, obsolete fields, and updated fields.

New Fields

  • The AS_Queue Collection has a new AS_ScheduleID field. This is the ID of the schedule associated with the queue record.

Changed Fields

  • The __ServiceData field in the AS_PackageDefinitions Collection now has an e2 flag that identifies packages is using the AMP (e2) engine.
AS_App_Chunks

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.
  • Checksum: (String) Checksum ID.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
AS_ApplicationVersions

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.
  • ApplicationId: (String) Workflow ID.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
  • __UpdateCheck: (Array) Contains GUID for internal locking and update validation.
AS_Applications

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.
  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the workflow.
  • CPUName: (String) Hostname or IP address of the workstation or Gallery node that created the record.
  • CreationDateTime: (String) Date-time (local server time) the record was created.
  • ModuleName: (String) Workflow file name.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
AS_Insights

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.
  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the insight.
  • CreationDateTime: (String) Date-time (local server time) the record was created.
  • InsightId: (String) Insight ID.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
AS_PackageDefinitions

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.
  • __ServiceData: (Binary) Base 64 encoded binary data. The e2 flag identifies if a package is using AMP (e2) engine.
  • __Version: (Int32) Version number.
AS_Queue

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.
  • AS_Application_ID: (String) Workflow ID from AS_Applications.
  • [New] AS_ScheduleID: (String) ID of the schedule associated with the queue record.
  • 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: (String) 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:  (String) Date-time (local server time) job was completed.
  • QOS_Priority: (String) Job priority.
  • IsAnonymous: (String) Flag for job queued by anonymous user.
  • IsHidden: (String) 
  • RestrictOutput: (String)
  • AppName: (String) Workflow name.
  • ClientType: (String) Client type that created the job.
  • __ServiceData: (Binary) Base64-encoded binary data. e2 flag identifies packages is using the AMP (e2) engine.
  • __Version: (Int32) Version number.
  • __Priority: (Int64) Long integer used to sort the queue.
  • __UpdateCheck: (Array) Contains GUID for internal locking and update validation.
AS_QueueInputs

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.
  • UserName: (String) Username or database ID of the user associated to the job.
  • CreationDateTime: (String) Date-time the user uploaded the file.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.

 

AS_ResourcePermissions

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.
  • ResourceId: (String) Resource ID.
  • ContextId: (String) Permission context ID.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
AS_Resources

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.
  • ResourceId: (String) Resource ID.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
  • __UpdateCheck: (Array) Contains GUID for internal locking and update validation.
AS_Results

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.
  • AS_Queue_ID: (String) Service queue ID.
  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the job.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
AS_ResultsFiles

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.
  • AS_Queue_ID: (String) Service queue ID.
  • UserName: (String) Username or MongoDB user ID (as found in the AlteryxGallery.users Collection) of the user associated with the job.
  • FileName: (String) File name.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
AS_RunAsCredentials

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.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
AS_Schedules

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.
  • AS_Application__ID: (String) ID of the database record containing the workflow data.
  • 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 Gallery node that created the schedule.
  • CreationDateTime: (String) Date-time (local server time) the schedule was created.
  • NextRunDateTime: (String) Date-time (local server time) the schedule is next scheduled to run.
  • UntilDateTime: (String) Schedule end date-time (local server time).
  • LastRunDateTime: (String) Date-time (local server time) the schedule last ran.
  • Status: (String) Schedule status.
  • LC_ScheduleName: (String) Workflow name.
  • LC_Owner: (String) Schedule owner.
  • ClientType: (String) Type of schedule created.
  • AS_PackageDefinition__ID: (String) Package definition ID.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
  • __UpdateCheck: (Array) Contains GUID for internal locking and update validation.
AS_TileSetAccessTimes

The AS_TileSetAccessTimes Collection is no longer used.

AS_TileSets

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.
  • Checksum: (String) Checksum ID.
  • __ServiceData: (Binary) Base64-encoded binary data.
  • __Version: (Int32) Version number.
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.