Interface IBlendingTran

The system entity for a blending transaction, which contains the configuration for creating a blended transaction

See https://web.lemonedge.com/help/blending-transactions/ for more information

Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.BlendingTran, "dbo.LT_BlendingTrans", "BlendingTransaction", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "blending-transactions")]
[DefaultEntityIcon(ImageType.BlendingTransactionTypes)]
public interface IBlendingTran : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

Algorithm

The Algorithm to use for processing this Blending Transaction configuration.

Algorithms inherit BlendTransactionProcessorExtender

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The algorithm for blending transactions and creating new blend transactions.")]
[Required]
string Algorithm { get; set; }
Property Value
Type Description
System.String

Description

A user friendly description for this blending transaction

Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this blending transaction.")]
string Description { get; set; }
Property Value
Type Description
System.String

Enabled

Indicates if this Blending Transaction configuration can be used to process a Blended Transaction.

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if this blending transaction is enabled for use in the system or not.")]
bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

HasStartDate

Indicates that a Blended Transaction will require a Start Date value as well for this algorithm to run

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if this blending transaction requires the use of a star date.")]
bool HasStartDate { get; set; }
Property Value
Type Description
System.Boolean

Name

[Key] The unique user friendly name of this Blending Transaction

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this blending transaction.")]
[Required]
string Name { get; set; }
Property Value
Type Description
System.String

RepeatDatesEvery

If using a start date the algorithm will run from the Start to End date.

If you select to Repeat then it will repeat start/end dates starting from the start date up to the end date by the repeat interval and how often.

For instance if repeating every month a start/end date of 1 Jan 2020 to 31 Mar 2020 would effectively run the algorithm 3 times, one for each date set of 1 Jan 202 - 31 Jan 2020, 1 Feb 2020 - 28 Feb 2020, and 1 Mar 2020 - 31 Mar 2020.
Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[Required]
[HardCodedDefaultValueOnNew("0")]
BlendingTranRepeat RepeatDatesEvery { get; set; }
Property Value
Type Description
BlendingTranRepeat

RepeatDatesEveryInterval

Indicates when to repeat dates. If repeat dates it set to months, and this holds 2, then it would be every 2 months.

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[Required]
[HardCodedDefaultValueOnNew("0")]
short RepeatDatesEveryInterval { get; set; }
Property Value
Type Description
System.Int16

Rounding

The default rounding level to use when applying this algorithm

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[Required]
[HardCodedDefaultValueOnNew("0")]
RoundingLevel Rounding { get; set; }
Property Value
Type Description
RoundingLevel

SourceAppliesToInstrumentSetTypeID

Links to IInstrumentSetType. If the source is Instruments, then this filters the allowable types of Instrument Sets the user can select to just these that match this Instrument Set Type. If left blank then they can select any Instrument Set.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.InstrumentSetType, "ID", SingleJoinType.ZeroToOne, "IInstrumentSetType", "Source Applies To Instrument Set", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The source type (empty for all) of instrument sets this blending transaction can work with.")]
Guid? SourceAppliesToInstrumentSetTypeID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

SourceAppliesToSQLWrapperID

Links to ISQLWrapper. If the source is SQLWrapper, then this specifies the SQL Wrapper to use when running the blenged transaction.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper Source", "Blending Transactions", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The source SQL Wrapper to use.")]
Guid? SourceAppliesToSQLWrapperID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

SourceAppliesToSQLWrapperParam

The parameters for running the sql wrapper source

Declaration
[EntityProperty(SQLType.VarBinary, true)]
[EntityDescription("The parameters for running the sql wrapper source.")]
byte[] SourceAppliesToSQLWrapperParam { get; set; }
Property Value
Type Description
System.Byte[]

SourceType

The type of data that is a source for the algorithm: Instruments or Transaction

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[HardCodedDefaultValueOnNew("0")]
BlendingTranSourceType SourceType { get; set; }
Property Value
Type Description
BlendingTranSourceType

TargetAppliesToInstrumentSetTypeID

Links to IInstrumentSetType. If the target is Instruments, then this filters the allowable types of Instrument Sets the user can select to just these that match this Instrument Set Type. If left blank then they can select any Instrument Set.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.InstrumentSetType, "ID", SingleJoinType.ZeroToOne, "IInstrumentSetType", "Target Applies To Instrument Set", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The target type (empty for all) of instrument sets this blending transaction can work with.")]
Guid? TargetAppliesToInstrumentSetTypeID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

TargetType

The type of data the system uses as a Target to create the new transactions against: Instruments, Source Instruments, Allocate From Rule, Replicate From Rule, Path, or Path Inverted

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[HardCodedDefaultValueOnNew("0")]
BlendingTranTargetType TargetType { get; set; }
Property Value
Type Description
BlendingTranTargetType

Extension Methods

See Also