Class Process

A Process represents an automated business workflow.

Hierarchy (View Summary)

Constructors

constructor

Properties

classOid context fields fieldsWithAlias isNew lists name oid ownerOid? ClassName ClassOid

Accessors

Name Oid OwnerOid

Methods

AddRecordAsync DeleteRecordAsync DeleteRecordsAsync Get GetKey GetListAsync GetOwnerAsync GetVersionsAsync LogChange Parse SaveAsync SaveRecordListAsync Set UpdateRecordAsync FindAsync Parse

Constructors

constructor

  • new Process(context: Context): Process

  • Create a new instance of the type Process. This constructor is used by the library's code and should not be used by API users.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    Returns Process

Properties

ProtectedclassOid

classOid: string = ""

Protectedcontext

context: Context

Protectedfields

fields: IDictionary

ProtectedfieldsWithAlias

fieldsWithAlias: IDictionary

ProtectedisNew

isNew: boolean = false

Protectedlists

lists: IDictionary

Protectedname

name: string = ""

Protectedoid

oid: number = 0

Protected OptionalownerOid

ownerOid?: number

StaticClassName

ClassName: string = "Venki.Process.Process"

StaticClassOid

ClassOid: string = "82b7b003-ace3-4a5b-a20b-5acae69702ea"

Accessors

Name

Oid

OwnerOid

  • get OwnerOid(): number

  • Get the identifier of the process owner

    Returns number

  • set OwnerOid(value: number): void

  • Set the identifier of the process owner

    Parameters

    • value: number

    Returns void

Methods

AddRecordAsync

  • AddRecordAsync(fieldName: string, record: any): Promise<CustomType>

  • Add a row to the record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • record: any

      A dictionary containing all the fields of the row.

    Returns Promise<CustomType>

    A promise to retrieve the content of the new object added to the record list.

DeleteRecordAsync

  • DeleteRecordAsync(fieldName: string, instanceId: string): Promise<void>

  • Delete a row in a record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • instanceId: string

      Identifier of the row of the record list.

    Returns Promise<void>

DeleteRecordsAsync

  • DeleteRecordsAsync(fieldName: string, instances: string[]): Promise<void>

  • Delete a list of rows in a record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • instances: string[]

    Returns Promise<void>

Get

ProtectedGetKey

GetListAsync

  • GetListAsync(fieldName: string): Promise<CustomType[]>

  • Retrieve all rows from a record list field.

    Parameters

    • fieldName: string

      Name of the record list.

    Returns Promise<CustomType[]>

    A promise to retrieve the content record list.

GetOwnerAsync

GetVersionsAsync

ProtectedLogChange

  • LogChange(
        className: string,
        fieldName: string,
        key: string | number,
        value: any,
    ): void

  • Parameters

    • className: string
    • fieldName: string
    • key: string | number
    • value: any

    Returns void

Parse

  • Parse(data: IDictionary): void

  • Populate the object's fields with data from the record.

    Parameters

    • data: IDictionary

      A dictionary holding the record's data.

    Returns void

SaveAsync

  • SaveAsync(context: Context): Promise<string | number>

  • Save all pending changes of an object.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    Returns Promise<string | number>

    Identifier of the saved record.

SaveRecordListAsync

  • SaveRecordListAsync(context: Context, fieldName: string): Promise<void>

  • Save all pending changes of a field of type record list.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    • fieldName: string

      Name of the record list.

    Returns Promise<void>

Set

  • Set(fieldName: string, value: any): void

  • Set the value of a custom field.

    Parameters

    • fieldName: string

      Name or alias of the field. (click the script icon in the edition dialog)

    • value: any

      Current value of the custom field.

    Returns void

UpdateRecordAsync

  • UpdateRecordAsync(
        fieldName: string,
        instanceId: string,
        record: any,
    ): Promise<void>

  • Update a row in a record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • instanceId: string

      A list of identifiers for the rows in the record list.

    • record: any

      A dictionary containing all the fields of the row.

    Returns Promise<void>

StaticFindAsync

  • FindAsync(context: Context, id: number): Promise<Process>

  • Find a process by an identifier

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    • id: number

      Identifier of the instance.

    Returns Promise<Process>

    Promise to get the object instance of a process.

StaticParse

  • Parse(context: Context, data: any[]): Process

  • Load the object's content from JSON data.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    • data: any[]

      An array of key-value pairs (JSON data).

    Returns Process

    Object instance initialized.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods