sharing: serverside module to set json data in db (encapsulate the EfficyAPI calls)

Thu, 21 Nov 2019 13:48:55 +0000

Hi developpers community,

this is a serverside module I use to set json data in DB quickly in serverside js that encapsulate all the EfficyAPI calls.

so basically i want to add a company in db i just have something like this to code :

rec.set({
    k_company: 0,
    name: "ma société",
    kind: 3,
    memo: "company created by a cool js module"
})

this is a more complete example of what you can set

var inserted = rec.set({
    k_company: 0,
    name: "my company",
    kind: 3,
    memo: "company created by a cool js module"
});

// inserted == 3001

var arrayInserted = rec.set([
    {
        k_company: inserted,
        memo: "updated memo"
    }, {
        k_company: 0,
        name: "my second company",
        f_custom_field: "valuecustom"
    }
]);

// arrayInserted == [3001, 3002]

declaring the module

//@import rec from finopsys/recordMgr

initializing the module (setting the entity you want to set)

rec.init({
     entity: ntComp
});

note that you can import several instances of this module if you don't want to reinitialize the module on each call (in case of you have serverals record kinds to set for each line)

you can also add special properties to the record parameter

var inserted = rec.set({
    k_company: 0,
    name: "my company",
    kind: 3,
    memo: "company created by a cool js module",
    s_usersecurity: [{k_user: 1, security: 3}],
    s_detail2: [{entity: ntCont, key: 365}]
});

susersecurity: [{kuser: 1, security: 3}]
add the security level 3 to the user 1 to this record (setUserSecurity)

s_detail2: [{entity: ntCont, key: 365}]
add a link to the contact with key 365 (insert detail2)

this is the code of the module : recordMgr.js

//@import $ from finopsys/jUtils

return (function(){
var options = {
entity: ntComp,
keyfield: "k_company"
};

function test(){
return "returned from custom server module";
}

function init(_options){
if (typeof _options === "object"){
$.forEach(Object.keys(_options), function(_key){
if (options.hasOwnProperty(_key)) options[_key] = _options[_key];
});
}

options.keyfield = Efficy.sqlQueryValue([
"select ",
"    LOWER(F.NAME)",
"from",
"    <#TABLE NAME=SYS_FIELDS> F",
"    inner join <#TABLE NAME=SYS_TABLES> T on T.K_TABLE = F.K_TABLE",
"    inner join <#TABLE NAME=SYS_ENTITIES> E on E.K_TABLE = T.K_TABLE",
"where",
"    F.USAGE = 'K'",
"    and E.K_ENTITY = :param1"
].join("\n"), options.entity, "");

return options;
}

function set(_data){
var result;

if (typeof _data !== "object") throw new Error("the records to set are not in an array");
if (_data.hasOwnProperty("length")){
result = setRecords(_data);
} else {
result = setRecord(_data);
}

return result;
}

function setRecord(_record){

if (typeof _record !== "object") throw new Error("the record to set is not an object");
if (!_record.hasOwnProperty(options.keyfield)) throw new Error("the record to set has no keyfield property");

var key = _record[options.keyfield];

var editHandle = Efficy.openEditContext(options.entity, _record[options.keyfield], false);
try {
var ds = Efficy.getMasterDataSet(editHandle, 0);
ds.edit();

$.forEach(Object.keys(_record), function(_key){
if (_key === options.keyfield){
key = ds.fieldByName(_key).value;
} else if (ds.findField(_key)) {
if(typeof _record[_key] === "string") ds.fieldByName(_key).asString = _record[_key];
else ds.fieldByName(_key).value = _record[_key];
}
});

if (_record["s_usersecurity"]){
$.forEach(_record["s_usersecurity"], function(_usersecurity){
Efficy.setUserSecurity(editHandle, _usersecurity.k_user, _usersecurity.security);
});
}

if (_record["s_detail2"]){
$.forEach(_record["s_detail2"], function(_detail2){
Efficy.insertDetail2(editHandle, _detail2.entity, _detail2.key, false);
});
}

Efficy.commitChanges(editHandle, false);            
} finally {
Efficy.closeContext(editHandle);
}

return key;
}

function setRecords(_records){
var result = new Array();

$.forEach(_records, function(_record){
result.push(setRecord(_record));
});

return result;
}

var public = {
test: test,
init: init,
set: set
};

return public;
})();

and this is the code of jUtils.js a module I ve done to help the serverside script with some usefull functions

return (function(){

function forEach(_array, _iterator){
var result;

for (var i=0; i<_array.length; i++){
result = _iterator.call(this, _array[i], i);
if (result === false) break;
}

return result;
}

function each(_array, _iterator){
var result;

for (var i=0; i<_array.length; i++){
result = _iterator.call(this, i, _array[i]);
if (result === false) break;
}
}

function merge(){
var result = {};

each(arguments, function(_index, _value){
for(key in _value){
if (!result[key]){
result[key] = _value[key];
} else if (typeof result[key] === "object" && typeof result[key].length === "undefined") {
result[key] = merge(result[key], _value[key]);
} else {
result[key] = _value[key];
}
}
});

return result;  
}

function getItem(_array, _searchFunction, _startIndex){
_startIndex = _startIndex || 0;

var result = undefined;

forEach(_array, function(_value, _index){
if (_searchFunction(_value, _index)){
result = _value;
return false;
}
});

return result;
}

function format() {
var args = arguments;
var result = args[0].replace(/\$\d+/g, function (cap) {
return args[1 + parseInt(cap.match(/\d+/), 10)];
});
}

function indexOfObject(_array, _searchFunction){

for (var i=0; i<_array.length; i++){
if (_searchFunction(_array[i])) {
return i;
}
}

return -1;
}

function getFunctionName(_function){
var result = _function.toString();
result = result.substr('function '.length);
result = result.substr(0, result.indexOf('('));
return result;
}

var public = {
merge: merge,
forEach: forEach,
each: each,
getItem: getItem,
format: format,
indexOfObject: indexOfObject,
getFunctionName: getFunctionName
};

return public;
})();

Gamification Design

Tue, 24 Sep 2019 10:46:43 +0000

Hello

Starting to implement the gamification module for a sales promotion starting this week.
I went deeply through the dev guide but still have some questions that should be share with the Efficy community (https://help.efficy.com/edn/dev/crft_11_gam_introduction)

Is it possible to change the design of the map ? Does Efficy propose (off the package) other graphics ?

If within a challenge, a new quizz starts, how can we alert the players ?
Do they have to enter in the game dashboard everyday to check if a new quizz is to be answered.

Thanks
Patrice

Implement the "gamification module" in the extranet

Fri, 24 May 2019 21:11:20 +0000

Hello,

For one of my customer, we are thinking of using the gamification module, to create quizz / survey in the Extranet. We showed him a few screenshot, he like the idea.

Would that be hard to implement ? I need to make a first estimate (in hours of dev) before the customer sign for it.

Regards,

Loïc

Efficy Overflow Q&A - Recent questions tagged gamification-module

sharing: serverside module to set json data in db (encapsulate the EfficyAPI calls)

Gamification Design

Implement the "gamification module" in the extranet