Sample: Add a record to a queue

This sample shows how to add a record to a queue. It creates source and destination queues. It adds a letter activity to the source queue and then moves it to the destination queue. You can download the sample from here.

Note

Unsure about entity vs. table? See Developers: Understand terminology in Microsoft Dataverse.

This sample requires additional users that are not in your system. Create the users manually in Microsoft 365 in order to run the sample without any errors. For this sample, create a user profile as is shown below.

First Name: Kevin
Last Name: Cook
Security Role: Sales Manager
UserName: kcook@yourorg.onmicrosoft.com

How to run this sample

  1. Download or clone the Samples repo so that you have a local copy.
  2. (Optional) Edit the cds/App.config file to define a connection string specifying the Microsoft Dataverse instance you want to connect to.
  3. Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in cds/App.config, any sample you run will use that connection information.

If you do not specify a connection string in cds/App.config file, a dialog will open each time you run the sample and you will need to enter information about which Dataverse instance you want to connect to and which credentials you want to use. This dialog will cache previous connections so that you can choose a previously used connection.

Those samples in this repo that require a connection to a Dataverse instance to run will include a linked reference to the cds/App.config file.

What this sample does

The AddToQueueRequest message is intended to be used in a scenario where it contains data that is needed to move a table record from a source queue to destination queue.

How this sample works

In order to simulate the scenario described in What this sample does, the sample will do the following:

Setup

  1. Checks for the current version of the org.
  2. The Queue method creates source and destination queues and store their returned GUIDs in variable.
  3. Creates a Letter table.
  4. The AddToQueueRequest method adds a table record into a queue, in this sample it associates the letter with first queue.
  5. Retrieves the user created manually in Microsoft 365 for assigning the queue items to the user's queue.

Demonstrate

  1. The RetrieveUserQueueRequest message retrieves the known private queues for the user.
  2. The AddToQueueRequest message adds the record from a source queue to destination queue.

Clean up

Display an option to delete the sample data that is created in Setup. The deletion is optional in case you want to examine the tables and data created by the sample. You can manually delete the records to achieve the same result.