Class BusinessRuleSchedule

Schedules business rules to run on a regular time frame.
Note: If schedules do not complete within 15 minutes, next execution will be skipped

Inheritance
object
BusinessRuleSchedule
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class BusinessRuleSchedule

Properties

CronExpression

Cron expression to specify run time.
Refer to https://github.com/HangfireIO/Cronos#cron-format for reference.
Minimum interval supported is 15 minutes.

Declaration
[JsonProperty("cronExpression", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string CronExpression { get; set; }
Property Value
string

Description

Language specific description.

Declaration
[JsonProperty("description", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TranslatedStringDictionary Description { get; set; }
Property Value
TranslatedStringDictionary

DocType

Doc type of items that should be loaded.

Declaration
[JsonProperty("docType", Required = Required.Always)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public BusinessRuleTriggerDocType DocType { get; set; }
Property Value
BusinessRuleTriggerDocType

Filter

Filter to apply when searching for items to load.

Declaration
[JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public FilterBase Filter { get; set; }
Property Value
FilterBase

IsEnabled

Indicates if schedule is enabled.

Declaration
[JsonProperty("isEnabled", Required = Required.Always)]
public bool IsEnabled { get; set; }
Property Value
bool

Names

Language specific names.

Declaration
[JsonProperty("names", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TranslatedStringDictionary Names { get; set; }
Property Value
TranslatedStringDictionary

RuleIds

IDs of business rules to run during schedule, regardless of trigger point

Declaration
[JsonProperty("ruleIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> RuleIds { get; set; }
Property Value
ICollection<string>

SearchString

Search string to apply when searching for items to load.

Declaration
[JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string SearchString { get; set; }
Property Value
string

Methods

FromJson(string)

Declaration
public static BusinessRuleSchedule FromJson(string data)
Parameters
string data

Returns
BusinessRuleSchedule

ToJson()

Declaration
public string ToJson()
Returns
string