Class VirtualApplicationEntity

Virtual Application Entity (VAE).

A VAE identifies a service or application similar to a DIMSE AE but is designed to be used for DICOMWeb.

For example, users can configure VAEs on DICOMWeb STOW-RS endpoints to enable data input plug-ins, IInputDataPlugIn. This allows different plug-ins to be associated with each VAE for data manipulation, etc...

In addition, one can trigger a new workflow request with the workflows defined in Workflows when studies are posted to a VAE-enabled STOW-RS endpoint.

Inheritance
System.Object
MongoDBEntityBase
VirtualApplicationEntity
Inherited Members
Namespace: Monai.Deploy.InformaticsGateway.Api
Assembly: Monai.Deploy.InformaticsGateway.Api.dll
Syntax
public class VirtualApplicationEntity : MongoDBEntityBase

Constructors

| Improve this Doc View Source

VirtualApplicationEntity()

Declaration
public VirtualApplicationEntity()

Properties

| Improve this Doc View Source

CreatedBy

Gets or set the user who created the DICOM entity.

Declaration
public string CreatedBy { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DateTimeUpdated

Gets or set the most recent date time the DICOM entity was updated.

Declaration
public DateTime? DateTimeUpdated { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

Name

Gets or sets the name of a MONAI DICOM application entity. This value must be unique.

Declaration
[Key]
[Column(Order = 0)]
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PlugInAssemblies

Optional list of data input plug-in type names to be executed by the IInputDataPlugInEngine.

Declaration
public List<string> PlugInAssemblies { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

UpdatedBy

Gets or set the most recent user who updated the DICOM entity.

Declaration
public string UpdatedBy { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

VirtualAeTitle

Gets or sets the virtual AE TItle which is used as the URL fragment in the DICOMWeb STOW-RS endpoint. E.g. POST /dicomweb/vae/{aet}/studies where {aet} is the value from this property.

Declaration
public string VirtualAeTitle { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Workflows

Optional field to map AE to one or more workflows.

Declaration
public List<string> Workflows { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Methods

| Improve this Doc View Source

SetAuthor(ClaimsPrincipal, EditMode)

Declaration
public void SetAuthor(ClaimsPrincipal user, EditMode editMode)
Parameters
Type Name Description
System.Security.Claims.ClaimsPrincipal user
EditMode editMode
| Improve this Doc View Source

SetDefaultValues()

Declaration
public void SetDefaultValues()
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Extension Methods