DCS Using Script

DCS Using Script

Overview

DCS now can have data without using questionnaire, it's setting by script:

DCS using with script, required a workflow:

- The workflow must return CustomDataCacheSpecificationBuildResult with UniqueIds and NonUniqueIds

(Also support to select Ids and NonUniqueIds on DCS)

selectMultiColumn(SYS_SCRIPT_NONUNIQUEID_SYS, SYS_SCRIPT_UNIQUEID_SYS) where true;

- The workflow get 5 parameters:

• 1: Any parameter you have specified in the setup

• 2: The DateTime (or Empty) from which to include data in a partial rebuild

• 3: The Entire array of Non Unique Ids from last rebuild (or empty if full rebuild)

• 4: The Entire array of Unique Ids from last rebuild (or empty if full rebuild)

• 5: The extraParameter, can be set when the rebuild is instanciated from cgscript

The first parameter can be set on UI:

Or can be set by cgscript:

Dictionary d1 = {"Key1":99, "Key2": "xxx"};
Dictionary d2 = {"": "yyy"};
DataCacheSpecification dcs = new DataCacheSpecification(dcsRId);
dcs.BuildUsingWorkflowScriptResourceId = workflowRId;
dcs.BuildUsingWorkflowScriptParameter={d1,d2};
dcs.Save();

The fifth parameter can be set when rebuild DCS, see more on dcs.Rebuild

dcs.Rebuild(true, true, 0, true, extraParameter);

Example

Example 1

A simple DCS with one column name "test" and 5 rows, value for each row is a random number. Like this:

How to do it:

- Create a new DCS:

+ Choose using script

+ Add a custom column

- Create a workflow and insert the workflow in to the DCS

Code on workflow must return CustomDataCacheSpecificationBuildResult, how many rows on DCS belonging the length of array Ids and NonUniqueIds. In this example, res is returned with array 5 items, therefor the DCS have 5 rows

CustomDataCacheSpecificationBuildResult res = new CustomDataCacheSpecificationBuildResult();
res.NonUniqueIds.AddRange({1,2,3,4,5});
res.Ids.AddRange({5,6,7,8,9});
return res;

After rebuild DCS, we have the DCS like this:

Example 2

Let continue with another example using parameter:

Add another column "Order" in to the above DCS, value for each row is a text: "Order number 1" to "Order number 5"

How to do:

- Add custom column name "Order", type full column on the DCS:

Because on script of Order custom column, have an undefined variables x, therefore we can not create that Order column on UI, just make by cgscrip:

DataCacheSpecification dcs = new DataCacheSpecification(15640179);
QcsCustomColumn cc = new QcsCustomColumn("Order", "string", true, dcs);
cc.CgScript = "array param = Workflow_getParameters();
Dictionary localCache = param[0];
FullCustomColumnSettings fs = param[1];
array result = {};
number numberRows = fs.UpdatedNumberOfRows;
for(number i = 0; i < numberRows; i++) {

    result.Add(x + convertToString(i+1));
}
return result;";
cc.Save();
dcs.Save();

( On the above script is used FullCustomColumnSettings for getting row number, see more the class here )

- In workflow, add 1 more line to set value:

res.AddVariableForFullCustomColumns("x", "Order number ");

After rebuild the DCS, "x" will be replace by "Order number "

Example 3

Let add one more column order same with the column Order above, name "Order1"

But this time row value will be set from parameter.

How to do:

- Put parameter on DCS:

- Create a full custom column name "Order1"

- On workflow need adding code for get parameter

array param = Workflow_getParameters();// array param with 5 items
array a = param[0];// array a with 1 item type dictionary 
Dictionary d = a[0];
string value = d["key"];

And also need add one line for setting value

res.AddVariableForFullCustomColumns("y", value );

After rebuilding DCS, value for row will be replace "y" by value "Order number " which was wet from DCS parameter

Example 4

DCS can also get value while buiding DCS, by using the fifth parameter

Let make an example, add another column name "Date" to the DCS, value for each row is current dateTime when build DCS

How to do:

- First, add a full custom column name "Date"

- On workflow add a line to get the fifth parameter

array extraParameter = param[4];

And also add a line for set the parameter

res.AddVariableForFullCustomColumns("z", extraParameter );

- Values will be set when rebuild DCS by dcs.Rebuild

DataCacheSpecification dcs = new DataCacheSpecification(DCSRid);
array extraParameter = getCurrentDateTime();
dcs.Rebuild(true, true, 0, true, extraParameter);

DCS will look like below after rebuiding: