Efficy Overflow Q&A - Recent questions tagged serverjs

Syntax for function OnAddLinkOppoPubl(Key, DetailKey)

Tue, 22 Apr 2025 10:17:09 +0000

Hi,
What is the syntax using the function OnAddLinkOppoPubl(Key, DetailKey) ?
I just want to update the STATUS field of the opportunity after adding a link from the publication to the opportunity.
Thank you
Dimitri

Get regional settings in serverJS

Fri, 17 Feb 2023 11:47:47 +0000

Is it possible to get usersettings by a serverJS function?

This is an working example:
var maxUsedDays = Efficy.getSetting('User', 'MaxUsedDays');

This is what I am looking for and currently not working:
Efficy.getSetting('User', 'DecimalPoint')
Efficy.getSetting('User', 'decimalPoint')
Efficy.getSetting('User', 'ShortDateFormat')
I also tried:
Efficy.getSetting('Efficy.User', '')
etc.

Questions:
Is it possible to get this working?
Is there a list of working examples?
Or an other way to get user regional settings?

How translate message / label into a standard serverJS like spyCases.js

Thu, 16 Jun 2022 09:23:06 +0000

We need to customize the Spycase file with lot of translations into the declared var MAILS.

Depending on USER language preferences we want to translate in some language all the value.

var MAILS = {
Close  : "The case has been closed by the SpyCase.",
Remind : "The Customer/Partner has not replied in $0 days.\nPlease send a reminder or tentatively close the case.",
Revive : "This case has not changed in $0 days.\nThe ticket was waiting for $1.\nPlease take action to activate this case.",
Links  : "\n___________________________________\nThis case is linked to $0$1$2"
}

So we basically searched into the standard to find all those labels into the EfficyLabels txt file and adding our own definitions. But without any success.
So we try to compare with native serverJS where some labels are translated.
So we found some translation into few serverJS like invoicing/invoicing.js with

if (!mainLinkedEntityId) throw new Error(format(Utils.translate('The main linked $0 could not be retrieved'), linkedEntity));

or into workload/roadmapElement.js

if (!this.hasRight(right, projKey, nodeType, nodeKey, fields)) {
throw new Error(
format(
Request.translate('You need the $0 right on the $1 #$2 to perform this action'),
right,
Efficy.entityCatalog.getEntityName(ntTable),
nodeKey
)
);
}

We tried to add needed modules to run a translation but nothing worked.
So anybody has already translated this kind of labels into a serverJS used into the Scheduled Efficy Service ?

Thank's
Laurent Tuffraud

How to reset user (using SetUsers true) except resources.

Tue, 16 Nov 2021 13:02:32 +0000

I want to reset users into the workflow but I need to keep all users like resources.
Is there a quick way to do that with an Efficy function ?

My only alternative way is to check user before reset, identify the ressources and add them into my varArrayOf users I want to set.

Efficy.sendExternalEmail creates wrong URL - where can we correct the behaviour?

Wed, 27 Jan 2021 11:11:08 +0000

Hi all,

if we you the built in

Efficy.sendExternalMail(sendFrom, sendTo, sendCc, subject, body, entity, idLinked, sendCode)

function and set the parameter sendCode = 'S'
The added URL to the mail follow the Efficy 10 schema:

https://mydomain.here/efficy.dll/dialog?page=remote/DialogOperation.htm&action=view;Cont;99958&close=T

instead it should look like:

https://mydomain.here/crm/view/Cont/99958

Where can we change this behavior?

Thank you

Tim

Loadserverjs can not be used in the "module" way

Wed, 25 Mar 2020 15:18:52 +0000

Hi all,

I am doing an upgrade for a customer and i am moving the serverscript files to serverjs.
I made a serverjs file with an object "module" and i am using it to make my api calls.
Now i want to use one of the functions inside my object with a loadserverjs/runscript but this is not working (what is logic), is there a solution for this or do i need to create a new file with the same function without using an object (copy/paste way)?

Thanks in advance!

Kind regards,
Bart

What is the key value for SYNCHRO_RELATION_CONTACT in constant.js for flexmail.

Mon, 27 Jan 2020 17:16:25 +0000

I have to change the way to synchronize flexmail to a new entity. I manipulated the constant.js file into the serverJs and I want to understand what are the variable values.

 var SYNCHRO_RELATION_CONTACT = 2,
SYNCHRO_RELATION_PREFERENCE = 24,
TABLEID_CONTACTS = 11000,
TABLEID_PROFILES = 24000,
LK_PROF_FLEXKIND_PREFERENCE = '2',
SYNC_D_CHANGE_ERROR = 10 / 86400,
APPID_SYNCSERVER = 27,
TIMEZONE_UTC = 100,
TIMEZONE_ROMANCE = 172, //172 = GMT+1

I don't know what are :

SYNCHRORELATIONCONTACT. (Maybe the USERKEY of ADMIN ?)
SYNCHRORELATIONPREFERENCE (24 seem to be relative to the profile table number ?)
APPID_SYNCSERVER ?

The other variable are clear.

so can I do something like that and if 2 is the key of administrator user maybe having a customized SYNCHRORELATIONFONCTION variable is not useful.

var SYNCHRO_RELATION_CONTACT = 2,
SYNCHRO_RELATION_FONCTION = ??? KEY,
SYNCHRO_RELATION_PREFERENCE = 24,
TABLEID_CONTACTS = 11000,
TABLEID_FONCTIONS = 51000,
TABLEID_PROFILES = 24000,
LK_PROF_FLEXKIND_PREFERENCE = '2',
SYNC_D_CHANGE_ERROR = 10 / 86400,
APPID_SYNCSERVER = 27,
TIMEZONE_UTC = 100,
TIMEZONE_ROMANCE = 172, //172 = GMT+1

Implementing a UserOption feature through sys_storage and serverside scripts

Tue, 21 Jan 2020 15:46:34 +0000

Hi guys,

I recently needed to implement a session persistent user options feature in Efficy
since sys_storage is the recommended way to do so I ve made a module that will allow you to set and get user options from a serverjs module.

this is how to implement / use it :

/*
@import SUO from serverjs/storageUserOptions
*/

SUO.init({id: 123});      // optional: only if you  want to use options of another User (default is Efficy.currentUserId)

// for now there is no sys_storage named userOption_123 (yet)

var temp = SUO.get()    
// expected temp = "";

SUO.set("myOption", 12);
// there is now a sys_storage named userOption_123 whose value is : "{\"myOption\": 12}"    //---(string)

temp = SUO.get();
// expected temp = {"myOption: 12"}   //---(object)  

temp = SUO.get("myOption");
// expected temp = 12       //---(number)

SUO.set("myOption2", {
    mySubOption1: true,
    mySubOption2: "subOptionValue2",
    mySubOption3: {
        id: 1
    }
});
// there is now a sys_storage named userOption_123 whose value is : (string)
// {
//     "myOption": 12,
//     "myOption2": {
//         "mySubOption1": true,
//         "mySubOption2": "subOptionValue2",
//         "mySubOption3": {
//             "id": 1
//         }
//     }
// }

this is the code of the serverjs/storageUserOptions module :

/*
@import $ from serverjs/jUtils
*/
return (function(){
    var options = {
        id: Efficy.currentUserId
    };

    function test(_options){
        return "test"
    }

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

        return options;
    }

    function get(_optionName){
        var result;
        var data = _getStorageUserOptions();

        if (typeof _optionName === "string") result = data[_optionName];
        else result = data;

        return result;
    }

    function set(_optionName, _optionValue){
        if(typeof _optionName !== "string") throw new Error("storageUserOptions.set() invalid arguments");

        var data = {};
        data[_optionName] = _optionValue;

        _setStorageUserOptions(data);

        return;
    }

    function _setStorageUserOptions(_options){

        var result = _getStorageUserOptions();
        result = $.merge(result, _options);

        Efficy.setSysStorageValue("userOption_" + options.id, JSON.stringify(result, null, "\t"));

        return result;
    }

    function _getStorageUserOptions(){
        var result = Efficy.getSysStorageValue("userOption_" + options.id) || "{}";

        try{
            result = JSON.parse(result);
        } catch(e){
            throw new Error(["",
                "_getStorageUserOption parse error", 
                "id: " + options.id,
                "value: " + result,
                "message: " + e.message
            ].join("<br/>"));
        }

        return result;
    }

    var public = {
        test: test,
        init: init,
        set: set,
        get: get

    };

    return public;
})();

and the serverjs/jUtils module that allow me to add some intresting polyfill (like object.keys, merge, ...)

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 keys = (function() {
        'use strict';
        var hasOwnProperty = Object.prototype.hasOwnProperty,
          hasDontEnumBug = !({ toString: null }).propertyIsEnumerable('toString'),
          dontEnums = [
            'toString',
            'toLocaleString',
            'valueOf',
            'hasOwnProperty',
            'isPrototypeOf',
            'propertyIsEnumerable',
            'constructor'
          ],
          dontEnumsLength = dontEnums.length;

        return function(obj) {
          if (typeof obj !== 'function' && (typeof obj !== 'object' || obj === null)) {
            throw new TypeError('Object.keys called on non-object');
          }

          var result = [], prop, i;

          for (prop in obj) {
            if (hasOwnProperty.call(obj, prop)) {
              result.push(prop);
            }
          }

          if (hasDontEnumBug) {
            for (i = 0; i < dontEnumsLength; i++) {
              if (hasOwnProperty.call(obj, dontEnums[i])) {
                result.push(dontEnums[i]);
              }
            }
          }
          return result;
        };
      }());

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

    return public;
})();

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;
})();

EditNewWithScript2 with server js

Mon, 28 Oct 2019 15:16:30 +0000

Hi all,

I needed to created a button which duplicate an opportunity whitout his details.
To do this i used the following code: EditNewWithScript2('Oppo', extraParams, '../serverjs/entities/oppo', 'duplicateOppo');

It is possible to call a serverjs but in the "serverscript" way. Is it possible to call a real serverjs (with module and privates) via this code snippet?

Thanks in advance!

Could we create companies reference using Efficy designer?

Thu, 03 Oct 2019 10:23:57 +0000

Hello,

I want to create a reference for companies, could we use the designer or we should do it using a database workflow?

Thank you

Regards

How to customise a "private method" in a standard serverJS file

Fri, 13 Sep 2019 12:42:13 +0000

Hello Efficy Team,

This question is related to the answer of Kristof.
We would like to customise the method "importTimesheetFromDataSet", but we cannot access the method.

How could we do that ?

Regards,

Loïc

How to customize something in a module of a serverJS

Fri, 13 Sep 2019 10:27:06 +0000

Hello Efficy team,

I need to customize the method "importToTimesheet" from serverJS/workload/timesheet".
This method is part of literal object "module".

How could I do that without coping the all file ?

We tried this (in a timesheet.js file, in the custom) :

/*
@import Timesheet from "workload/timesheet";
*/

Timesheet.importToTimesheet = function() {
throw new Error('Hello ?');
}

return Timesheet;

But we get this error (when the page load) :

What is the best practice ? Coping the all file make no sens.

Regards,

Loïc

What is exactly a "tableViewIndex"

Thu, 25 Apr 2019 19:58:25 +0000

Hello Efficy Team,

The question is quite simple. What is exactly a "tableViewIndex" ?
We can find the tableViewIndex in multiple serverJs function, as parameters.

I guess it is the "id of the table" from the sys_tableviews. Is it well the table id returned by the function Efficy.entityCatalog.tableIdFromEntityDetail (and some other functions) ?

Then, how to use it ? Can you give us concrete exemple of cases where we should use this parameter with another value than 0 ?

Thanks in advance for the enlightenment,

Loïc

Efficy 11: Different ways to call a serverside script (which is the best one)

Thu, 25 Apr 2019 14:11:07 +0000

Hi guys,

We can call a serverscript in multiple ways (and we can find both in the standard).
For now (Efficy 11.2), and for the futur, Is there a way better than the others ? Is there a depracate way ?

Utils.runServerJsAjax
Utils.runScriptAjax2
$.ajax({
url: ...,
method: ...,
data: ...
}).done(function (html) {
...
});

Get only what's change during the edit context

Tue, 12 Mar 2019 07:49:17 +0000

Hello Efficy Team,

I got a complex process where I need to do something with the "new element" of a detailDataSet, or the deleted elements of the detailDataSet during the edit context.

What is the best way retrieve only those element ?

Here is what I did :

    var k_project = Efficy.getEditKey(editHandle);
var relationTable = Efficy.entityCatalog.getRelationEntityTableName(ntProj, TEntityHandle);
var kElement = Efficy.entityCatalog.keyFieldName(TEntityHandle);

var dsDetails = Efficy.sqlQueryDataSet('select * from ' + relationTable + ' where k_project = :param1', k_project, 45);
var newDetails = Efficy.getDetailDataSet(editHandle, TEntityHandle);

var changesInTheEditContext = [];

if(dsDetails || !dsDetails.isEmpty()) {

    // the project is already committed. We need to get only the "new" one
    // for that, we filter the "new one" based on the "old one"

    var existing = [];
    dsDetails.first();
    while (!dsDetails.eof()) {
        existing.push(dsDetails.fieldByName(kElement).asFloat);
        dsDetails.next();
    }

    // ho yeah it is ugly. But seems that "not in ()" does not work
    newDetails.filter = kElement +' <> ' + existing.join(' AND ' +  kElement +  ' <> ');
    newDetails.FilterOptions = existing.length;
    newDetails.Filtered = true;

}

// then we get, for each "new one", useful information's : entity, key, name

if(newDetails.isEmpty() || !newDetails) return false;
newDetails.first();

while(!newDetails.eof()) {

    changesInTheEditContext.push({
        entity : Efficy.entityCatalog.getEntityName(TEntityHandle),
        key : newDetails.fieldByName(kElement).asFloat,
        name : getName(newDetails.fieldByName(kElement).asFloat, TEntityHandle),
        operation : 'add'
    })

    newDetails.next();
}

newDetails.Filtered = false;

// we also need to detect the opposite : a contact deleted during the edit context
// we use the same ticks, but in the opposite (current detailDataSet filter the SQL)

if(dsDetails || !dsDetails.isEmpty()) {

    var fromRelationTable = [];

    newDetails.first();
    while (!newDetails.eof()) {

        fromRelationTable.push(newDetails.fieldByName(kElement).asFloat);
        newDetails.next();

    }

    // ho yeah it is ugly. But seems that "not in ()" does not work
    dsDetails.filter = kElement +' <> ' + fromRelationTable.join(' AND ' +  kElement +  ' <> ');
    dsDetails.FilterOptions = fromRelationTable.length;
    dsDetails.Filtered = true;

    if(dsDetails.isEmpty() || !dsDetails) return false;
    dsDetails.first();

    while(!dsDetails.eof()) {

        changesInTheEditContext.push({
            entity : Efficy.entityCatalog.getEntityName(TEntityHandle),
            key : dsDetails.fieldByName(kElement).asFloat,
            // name : getName(newDetails.fieldByName(kElement).asFloat, TEntityHandle), -- we don't need the name, he's already displayed
            operation : 'delete'
        })

        dsDetails.next();
    }

    dsDetails.Filtered = true;

}

return changesInTheEditContext;

Is there, by any chance, a way to get those change in a more "Efficy way" than comparing two dataSet ?

Regards,

Loïc

Flexmail: missing contact status once the campaign is sent

Thu, 28 Feb 2019 09:54:33 +0000

I added a new status in the lookup LK_PUBL_STATUS but if I select it in a new personalized email, the contact status is not assigned to the selected value.

[Solution] Don't be fooled by parseInt()

Wed, 23 Jan 2019 10:51:51 +0000

Hello Team,

I would like to share with you a problem I encountered yesterday.
If, like me, you never worked on old version of Javascript, with old browser, you could be used to do that :

parseInt("011") // return 11

But Efficy use not the same version of Javascript as your browser. He use a version before ECMA5.

So, this :

parseInt("011") // return 9

The explanation is simple. Before ES5, the base used by default was not always 10 (it was depending the string you wanted to parse). The documentation is clear about that : parseInt sur MDN

So the solution is :

parseInt("011", 10) // return 11

Or, even better, the Efficy function :

strToFloat("011") // ALWAYS return 11

I hope you won't spend as much time as I did :)

Loïc

Efficy 11: What is the best way to override standard serverjs scripts like flexmail ?

Fri, 03 Aug 2018 12:29:00 +0000

Dear all,

I need to change some part of flexmail integration for a customer, like adding the contact title to the contact sent to flexmail.

I looked at the sample custom and the buildnotes of Efficy 11, but I didn't find the proper way to just change the "fields.js" file

is it like the macro files, can I just copy past the fields.js to my custom folder "serverjs/flexmail" or do I have to completly copy the flexmail folder in my custom to do the modification ?

Best Regards,
Stéphane