Class ADGArgs

Args for use in the document/{id}/generate endpoint. Includes all of the parameters necessary to generate a new document from a template.

Inheritance

object

ADGArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Quantellia.WMServer.Asset.Model.Document

Assembly: WMServer.dll

Syntax

public class ADGArgs

Properties

Arguments

Dictionary of name = value pairs specifiying values to set for an execution run of the model.

Declaration

public Dictionary<string, object> Arguments { get; set; }

Property Value

Type	Description
Dictionary<string, object>

Remarks

The name (key) specified for each entry can be:

• The short Name of each DecisionModelElement whose value is to be set. This requires that the Name is unique in the model.
• The FullyQualifiedName of the DecisionModelElementwhose value is to be set. This should be used in preference of the short Name if the short Name is not unique in the model.

The object may be either a native data type (int, double, string, DateTime, etc.) or a subtype of ElementValue.

DecisionModelID

ID of the decision model to generate this document with. The elements of the decision model will be parsed, and if in correct form, will be used to generate a new document with using a template document.

Declaration

public string DecisionModelID { get; set; }

Property Value

Type	Description
string

ProcessorID

ID of the processor that should process the request. If null, a new processor is created and its ID is returned to the caller in the object returned by the GenerateFromTemplate(string, ADGArgs) operation.

Declaration

public string? ProcessorID { get; set; }

Property Value

Type	Description
string

Remarks

The first time a DecisionModel is run by a WMProcessor instance, World Modeler Server will create a new WMProcessor instance, assign it a unique ID, and pass this back to the caller in the return value of theis invocation.

Using the cached WMProcessor instance uses resources more efficiently as it prevents multiple WMProcessor instancesto be created for the same DecisionModel (although this is permissable if required), but more imporantly, allows the state of the DecisionModel being evaluated to be retained from one invocation to the next so that the model does not need to be initialized and re-run to achieve its previous state every time the processor is invoked with a change in the arguments.

ReplacementKeys

An additional set of arguments which are automatically decoded as IADGFormattable> objects for use as replacement keys. While elements in the Arguments array will only be used as replacement keys if they are of the IADGFormattable type, objects in the ReplacementKeys array will automatically be converted to IADGFormattable in cases where they are sent as a solitary object, such as a string.

Declaration

public Dictionary<string, object> ReplacementKeys { get; set; }

Property Value

Type	Description
Dictionary<string, object>

SaveTo

A reference to a document to save the automatically generated document to. May reference an existing document with ID or full path name, or a newly created document with a full path name that doesn't already belong to an asset.

Declaration

public string SaveTo { get; set; }

Property Value

Type	Description
string