Show / Hide Table of Contents

    Systems.Core.Jobs Entity

    Namespace: Systems.Core

    The jobs, which are configured in the system. Entity: Sys_Jobs (Introduced in version 20.1)

    Default Visualization

    Default Display Text Format:
    {Name}
    Default Search Members:
    Name
    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.Core.Jobs

    Attributes

    Name Type Description
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    Id guid
    IsActive boolean Specifies whether the job is active and ready for running. Required Default(true) Filter(eq)
    JobType JobType The system type of the job. DOC=Document Change State, POS=Run Postponed Events, DNT=Delete Old Notifications, DPI=Delete Old Print Images, DDV=Delete Old Document Versions. Required Filter(multi eq)
    Name string (254) The name of the job. Required Filter(eq;like) ORD
    Notes string (max) nullable Notes for this Job.
    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.
    RunOnIdle boolean Specifies whether to automatically run the job when the server is idle. Required Default(true) Filter(eq)

    Attribute Details

    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

    Id

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

    IsActive

    Specifies whether the job is active and ready for running. Required Default(true) Filter(eq)

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

    JobType

    The system type of the job. DOC=Document Change State, POS=Run Postponed Events, DNT=Delete Old Notifications, DPI=Delete Old Print Images, DDV=Delete Old Document Versions. Required Filter(multi eq)

    Type: JobType
    Category: System
    Allowed values for the JobType(Systems.Core.Jobs.md#jobtype) data attribute
    Allowed Values (Systems.Core.JobsRepository.JobType Enum Members)

    Value Description
    DocumentChangeState DocumentChangeState value. Stored as 'DOC'.
    Database Value: 'DOC'
    Model Value: 0
    Domain API Value: 'DocumentChangeState'
    RunPostponedEvents RunPostponedEvents value. Stored as 'POS'.
    Database Value: 'POS'
    Model Value: 1
    Domain API Value: 'RunPostponedEvents'
    DeleteOldNotifications DeleteOldNotifications value. Stored as 'DNT'.
    Database Value: 'DNT'
    Model Value: 2
    Domain API Value: 'DeleteOldNotifications'
    DeleteOldPrintImages DeleteOldPrintImages value. Stored as 'DPI'.
    Database Value: 'DPI'
    Model Value: 3
    Domain API Value: 'DeleteOldPrintImages'
    DeleteOldDocumentVersions Delete old document versions. Stored as 'DDV'.
    Database Value: 'DDV'
    Model Value: 4
    Domain API Value: 'DeleteOldDocumentVersions'

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

    Name

    The name of the job. Required Filter(eq;like) ORD

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

    Notes

    Notes for this Job.

    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

    RunOnIdle

    Specifies whether to automatically run the job when the server is idle. Required Default(true) Filter(eq)

    Type: boolean
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Default Value: True
    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

    None

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX