Toggle menu

listDigests()

List all digests currently registered, including the digest register and tables.

Parameters

NameTypeDescription
getdetailsBoolean, optionalDefault: false. If true the full digest specification will be returned which includes scheduling information, column size and index

Returns

Returns an array of object where each object represents a digest and has two properties.

NameTypeDescription
specObjectThe name, filter and columns used in registerDigest() to create this digest
infoObjectThe table and view names and mappings of this digest

Example

Request

function(params, credentials) {
    let resp = this.callWorkerMethod("history", "listDigests", {
        getdetails: true
    });
    return resp;
}

Response

{
    "spec": {
        "filter": {
            "EQ": "Customer Enquiry",
            "key": "labela"
        },
        "columns": [{
            "size": 50,
            "name": "businesskey",
            "index": "businesskey_index",
            "type": "varchar",
            "operation": "label",
            "key": "labelb"
        }, {
            "name": "started",
            "type": "datetime",
            "operation": "firsttimestamp"
        }, {
            "eventFilter": {
                "EQ": "Mail Sent",
                "key": "event"
            },
            "name": "first_response_time",
            "type": "datetime",
            "operation": "firsttimestamp"
        }, {
            "columns": [{
                "size": 250,
                "name": "eventdescription",
                "type": "varchar",
                "operation": "value",
                "key": "description"
            }, {
                "name": "eventtime",
                "type": "datetime",
                "operation": "timestamp"
            }],
            "name": "all_descriptions",
            "type": "table",
            "operation": "all"
        }, {
            "columns": [{
                "size": 250,
                "name": "involveduser",
                "type": "varchar",
                "operation": "value",
                "key": "userId"
            }],
            "name": "involved_users",
            "type": "table",
            "operation": "distinct"
        }],
        "name": "exampledigest",
        "description": "testing",
        "started": 0,
        "finished": 0,
        "enabled": true,
        "frequency": 20
    },
    "info": {
        "childViewMappings": {
            "dh_exampledigest_involved_users": "dh_exampledigest_involved_users_vw",
            "dh_exampledigest_all_descriptions": "dh_exampledigest_all_descriptions_vw"
        },
        "mainViewName": "dh_exampledigest_vw",
        "childTableMappings": {
            "all_descriptions": "dh_exampledigest_all_descriptions",
            "involved_users": "dh_exampledigest_involved_users"
        },
        "mainTableName": "dh_exampledigest"
    }
}

Last modified on 15 November 2023

Share this page

Facebook icon Twitter icon email icon

Print

print icon