Show / Hide Table of Contents

    Systems.Bpm.UserBusinessRules Entity

    Namespace: Systems.Bpm

    Represents user-defined business rule. Entity: Sys_User_Business_Rules

    Default Visualization

    Default Display Text Format:
    {Name:T}
    Default Search Members:
    Code; Name
    Code Data Member:
    Code
    Name Data Member:
    Name
    Category: Settings
    Show in UI: ShownByDefault

    Aggregate

    An aggregate is a cluster of domain objects that can be treated as a single unit.

    Aggregate Tree

    • Systems.Bpm.UserBusinessRules
      • Systems.Bpm.UserBusinessRuleActions
      • Systems.Bpm.UserBusinessRuleConditions
      • Systems.Bpm.UserBusinessRuleEvents

    Attributes

    Name Type Description
    Code string (16) The unique code of the UserBusinessRule. Required Filter(eq;like) ORD
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    Icon byte[] nullable Visual icon of the rule in .PNG format.
    Id guid
    IsActive boolean Specifies whether the rule is activated. Required Default(false) Filter(eq)
    Layer Layer Specifies in which layers the rule will be available. The available events and actions depend on the chosen layer. Allowed values: FTE=Front-End, BKE=BackEnd, COM=Common (both). Required Default("BKE") Filter(multi eq)
    Name MultilanguageString (254) The name of this UserBusinessRule. Required Filter(like)
    Notes string (max) nullable Notes for this UserBusinessRule.
    ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
    RepositoryName string (128) The name of the repository, for which this business rule is defined. Required Filter(eq;like)
    ScriptLanguage ScriptLanguage The programming language used to define the rule actions. Required Default("Integrated")
    ScriptText string (max) nullable The program code used to define the rule actions.
    UserStartable boolean nullable Specifies, that the rule can be manually started by the user. Default(false) Filter(eq)

    Child Collections

    Name Type Description
    Actions UserBusinessRuleActions List of UserBusinessRuleAction(Systems.Bpm.UserBusinessRuleActions.md) child objects, based on the Systems.Bpm.UserBusinessRuleAction.UserBusinessRule(Systems.Bpm.UserBusinessRuleActions.md#userbusinessrule) back reference
    Conditions UserBusinessRuleConditions List of UserBusinessRule<br />Condition(Systems.Bpm.UserBusinessRuleConditions.md) child objects, based on the Systems.Bpm.UserBusinessRuleCondition.UserBusinessRule(Systems.Bpm.UserBusinessRuleConditions.md#userbusinessrule) back reference
    Events UserBusinessRuleEvents List of UserBusinessRuleEvent(Systems.Bpm.UserBusinessRuleEvents.md) child objects, based on the Systems.Bpm.UserBusinessRuleEvent.UserBusinessRule(Systems.Bpm.UserBusinessRuleEvents.md#userbusinessrule) back reference

    Attribute Details

    Code

    The unique code of the UserBusinessRule. Required Filter(eq;like) ORD

    Type: string (16)
    Indexed: True
    Category: System
    Supported Filters: Equals, Like
    Supports Order By: True
    Maximum Length: 16
    Show in UI: ShownByDefault

    DisplayText

    Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

    Type: string
    Category: Calculated Attributes
    Supported Filters: NotFilterable
    Supports Order By: ****
    Show in UI: HiddenByDefault

    Icon

    Visual icon of the rule in .PNG format.

    Type: byte[] nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Show in UI: ShownByDefault

    Id

    Type: guid
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Default Value: NewGuid
    Show in UI: CannotBeShown

    IsActive

    Specifies whether the rule is activated. Required Default(false) Filter(eq)

    Type: boolean
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Default Value: False
    Show in UI: ShownByDefault

    Layer

    Specifies in which layers the rule will be available. The available events and actions depend on the chosen layer. Allowed values: FTE=Front-End, BKE=BackEnd, COM=Common (both). Required Default("BKE") Filter(multi eq)

    Type: Layer
    Category: System
    Allowed values for the Layer(Systems.Bpm.UserBusinessRules.md#layer) data attribute
    Allowed Values (Systems.Bpm.UserBusinessRulesRepository.Layer Enum Members)

    Value Description
    FrontEnd The rule is registered for front-end applications.. Stored as 'FTE'.
    Database Value: 'FTE'
    Model Value: 0
    Domain API Value: 'FrontEnd'
    BackEnd The rule is registered for server execution.. Stored as 'BKE'.
    Database Value: 'BKE'
    Model Value: 1
    Domain API Value: 'BackEnd'
    Common The rule is registered both for server and client.. Stored as 'COM'.
    Database Value: 'COM'
    Model Value: 2
    Domain API Value: 'Common'

    Supported Filters: Equals, EqualsIn
    Supports Order By: False
    Default Value: BackEnd
    Show in UI: ShownByDefault

    Name

    The name of this UserBusinessRule. Required Filter(like)

    Type: MultilanguageString (254)
    Category: System
    Supported Filters: Like
    Supports Order By: False
    Show in UI: ShownByDefault

    Notes

    Notes for this UserBusinessRule.

    Type: string (max) nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Maximum Length: 2147483647
    Show in UI: ShownByDefault

    ObjectVersion

    The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

    Type: int32
    Category: Extensible Data Object
    Supported Filters: NotFilterable
    Supports Order By: ****
    Show in UI: HiddenByDefault

    RepositoryName

    The name of the repository, for which this business rule is defined. Required Filter(eq;like)

    Type: string (128)
    Category: System
    Supported Filters: Equals, Like
    Supports Order By: False
    Maximum Length: 128
    Show in UI: ShownByDefault

    ScriptLanguage

    The programming language used to define the rule actions. Required Default("Integrated")

    Type: ScriptLanguage
    Category: System
    Allowed values for the ScriptLanguage(Systems.Bpm.UserBusinessRules.md#scriptlanguage) data attribute
    Allowed Values (Systems.Bpm.UserBusinessRulesRepository.ScriptLanguage Enum Members)

    Value Description
    Integrated Integrated value. Stored as 'Integrated'.
    Database Value: 'Integrated'
    Model Value: 0
    Domain API Value: 'Integrated'
    CSharp CSharp value. Stored as 'CSharp'.
    Database Value: 'CSharp'
    Model Value: 1
    Domain API Value: 'CSharp'

    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: Integrated
    Show in UI: ShownByDefault

    ScriptText

    The program code used to define the rule actions.

    Type: string (max) nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Maximum Length: 2147483647
    Show in UI: ShownByDefault

    UserStartable

    Specifies, that the rule can be manually started by the user. Default(false) Filter(eq)

    Type: boolean nullable
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Default Value: False
    Show in UI: ShownByDefault

    API Methods

    Methods that can be invoked in public APIs.

    GetAllowedCustomPropertyValues

    Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
    Return Type: Collection Of CustomPropertyValue
    Declaring Type: EntityObject
    Domain API Request: GET

    Parameters

    • customPropertyCode
      The code of the custom property
      Type: string

    • search
      The search text - searches by value or description. Can contain wildcard character %.
      Type: string
      Optional: True
      Default Value: null

    • exactMatch
      If true the search text should be equal to the property value
      Type: boolean
      Optional: True
      Default Value: False

    • orderByDescription
      If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
      Type: boolean
      Optional: True
      Default Value: False

    • top
      The top clause - default is 10
      Type: int32
      Optional: True
      Default Value: 10

    • skip
      The skip clause - default is 0
      Type: int32
      Optional: True
      Default Value: 0

    CreateNotification

    Creates a notification and sends a real time event to the user.
    Return Type: void
    Declaring Type: EntityObject
    Domain API Request: POST

    Parameters

    • user
      The user.
      Type: Users

    • notificationClass
      The notification class.
      Type: string

    • subject
      The subject.
      Type: string

    CreateCopy

    Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
    Return Type: EntityObject
    Declaring Type: EntityObject
    Domain API Request: POST

    Business Rules

    • R28043 UserBusinessRule - Valid Icon Format
    • R28545 UserBusinessRule - Script Text Max Length
    • R31067 UserBusinessRule - Code(Code)

    Front-End Business Rules

    None

    API

    Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Bpm_UserBusinessRules?$top=10

    Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Bpm_UserBusinessRules?$top=10

    • Improve this Doc
    Back to top Generated by DocFX