Efficy Overflow Q&A - Recent questions and answers in WorkFlow / Serverscript

How to queue a function call in a workflow script to execute it async?

Wed, 12 Nov 2025 08:29:40 +0000

Hi,

I am working on an integration with Efficy and Exact. One of the flows i need to implement is uploading invoices from exact to Efficy as an attachment. I currently put it in a workflow function and it works fine. However, this flow is very slow (multiple calls to exact so can't make it faster) and is blocking the end user from doing anything for 20-30 seconds. Is there a way without using schedulers to execute this flow in an async way? A bit like queueing that the function should be executed in the background.
Or is the only solution using a scheduler service and just use a small time interval?

Answered: Syntax for function OnAddLinkOppoPubl(Key, DetailKey)

Wed, 14 May 2025 10:09:19 +0000

Hello Dimitri,

If you are linking the Publication from Opportunity you will enter into OnAddLinkOppoPubl(Key, DetailKey).
In this case the Key parameter is a key of the Opportunity.
You will need to openEditContext of the opportunity and update the field.
ex.:

var editOppo= Efficy.openEditContext(ntOppo, Key);
try {
  Efficy.updateField(editOppo, 0, "STATUS", STATUSVAL);
  Efficy.commitChanges(editOppo, false);
} finally {
  Efficy.closeContext(editOppo);
}

If you want to avoid the workflow events of Opportunity be triggered during the status update don't forget to include disableWorkflow property.

var editOppo= Efficy.openEditContext(ntOppo, Key);
Efficy.disableWorkflow = true;
try {
  Efficy.updateField(editOppo, 0, "STATUS", STATUSVAL);
  Efficy.commitChanges(editOppo, false);
} finally {
  Efficy.disableWorkflow = false;
  Efficy.closeContext(editOppo);
}

Implement the logic in bidirectional if needed: OnAddLinkPublOppo(Key, DetailKey), where Opportunity key will be then DetailKey.

Kind regards,
Hamid

Answered: Is there any AfterLoad Trigger or Hook? (Efficy (Build 12.1.28052.0 2024-10-11 15:00))

Mon, 24 Feb 2025 09:26:10 +0000

Hi Stefan

Efficy does not expose a workflow event that fires when entity records are consulted or queried. When existing entity records are edited, the event OnEditingXxxx can be implemented to update a field value of the dataset before it gets displayed. This is where you could decrypt it.

I'm not sure it helps you?

How to emplement runscript for email template

Mon, 17 Feb 2025 15:55:01 +0000

Hello,

I'm used to create runscripts to personnalize docx files, but it seems to be different with email templates.

This runscript [$RunScript(module="templates/email", name="iu_nom_prenom")] works fine in a docx template, but I have no result in an email template.

While debugging, I fugured out that the contKey = 0 while editing the email template but I got the good value with a docx version :

var contKey = Efficy.getMainDetail(editHandle, ntCont);

Do you have any tips/informations ?

Thanks

Answered: Efficy.setUserSecurity: You can't assign a security level you don't have as default right !

Thu, 26 Sep 2024 15:46:36 +0000

When working with setUserSecurity in ServerJs, it's best to execute it in a block where Efficy.disableSecurity === true.

It's because the current user has for instance no Delete table rights, but gives group Everyone or other users "Full Control".

This protection prevents users giving user security "Full" on a record and override Table rights for themselves or others. In a script context, this is often exactly what you want to do.

Thank you to Kristof for his help.

How not to link product abd subproducts in an opportunity with fragments

Sun, 26 Nov 2023 18:59:14 +0000

Hello,

When using fragments, if you insert a product in an opportunity, if the selected product has subproducts, all the products are liked in the opportunity.
Pnce all the products are liked to the opportunity, if you modify the quantity, the quantities of all the products are modified.
If you want to delete the main product, all the subproducts are deleted.
The reason is that in the database, ech subproduct has his own K_PARENT field filled.
Is it possible just to insert the selected product and not all the subproducts ?
Thank you
Dimitri

Generate stats in Excel format

Tue, 19 Sep 2023 07:14:33 +0000

Hi,

I want to generate some stats (server side) and I want to have an excel format (no csv)

I know I can use strSaveTextFile to generate file, but how could I generate excel ?

thanks in advance :)

Answered: Created new Entity, but Swedisch translation is not working

Fri, 08 Sep 2023 15:15:46 +0000

Fixed

Business-data-providers was set in dealer base,
CustomLabels from that custom took over your the regular customlabels.

Deactivated of the dealer base, is for now a workarround.

Next time I could check, the dealerbase label conflicts first.

how can I create an extranet password link with few days duration option

Tue, 01 Aug 2023 16:34:03 +0000

hello
I have to generate some documents that I need to share with some news contacts with no extranet access.
So In a publication I have a button with a script to generate lot of documents. In this publication all the contacts will receive an email with their each custom access on the extranet + the link when acc_auth is empty with the generated url from : Efficy.generateExtranetPasswordURL

Problem this url has a short time of validity. My contacts may will be connected only few days after.

Is there a way to change availability duration of this generated url ?

thank for your backup
laurent

Answered: actionlauncher: open Oppo Edit

Fri, 16 Jun 2023 05:59:45 +0000

The actionLauncher is a custom extension of the standard efficy/js/misc/action module that is responsible to parse the URL action verbs such as createRelation, refreshOpener, runTemplate.

The custom module is invoked by overriding the action.launch method. When you hit apply in an edit window, just like the standard "action" commands are not executed, it's the same story for the workflow defined action verbs.

I'm not sure that hooking up the module to a command such as "Apply" will give a stable result. It's quite tricky.

Answered: Why can't I bypass the read-only dataset with Efficy.disableSecurity

Thu, 01 Jun 2023 09:35:00 +0000

You should disable the security before you open the editContext.

Answered: Cannot access certain field of Product in template

Mon, 17 Apr 2023 05:54:11 +0000

In a merge context, only fields and categories from the merged entity (Document in your example) + the fields from the relation datasets are available. The field PRODUCTS.FAMILY is not accessible because it's not from the relation DOCU_PROD. Efficy does some special tricks for common fields [NAME, OPENED, SUBJECT, DONE] but not for the others.

Options:

Copy R_FAMILY from ProdDataSet to DOCU_PROD.COMMENT
Create a custom field and copy FAMILY from ProdDataSet to DOCU_PROD.F_FAMILY. You also need to implicitly set R_F_FAMILY unless you commit the document.
Use a template script to complete your product table with additional fields from Products.

The best option depends on the amount of Product fields you need and your skills and time. The first is surely the easiest.

Answered: Do we have a workflow trigger for workStages?

Mon, 27 Feb 2023 17:28:21 +0000

It is AfterCommitWrkStag

Merging 2 projects how to keep all the Stages/Deliverables and Steps of both projets on the kept projet?

Thu, 12 Jan 2023 17:15:15 +0000

We remarked that when we merge 2 projets from the search window, the Stages/Deliverables and Steps of the projet that is not kept (deleted project) are also deleted and they are not relink to the kept projet.

Is there an easy way to enable to keep all the Stages/Deliverables and Steps from both projects on the merged project ?

Answered: How to delete all detail attachements/files contains in an Efficy Document where some of the files have revision?

Mon, 09 Jan 2023 14:25:25 +0000

Here is the R&D answer:

Indeed, the particular case delete for file as detail is not handled.
You can get the detail dataset, and call its delete method.
Either you loop on the dataset and delete when the K_FILE corresponds, or you can use the dataset.locate method.
If you pass the K_FILE;VERSION, then you can position the dataset on the exact record you want to delete.
If you pass only the K_FILE the it positions on the first one; you can then iterate (locate returns false when no record is found)

Answered: How do I know if an email is blocked in SYS_MAILS because of an incorrect address?

Tue, 20 Dec 2022 16:44:49 +0000

Have you set the Administrator Email of the Mail Dispatch Service ? if so the Administrator should have received the error saying the email could not be sent.

https://help.efficy.io/edn/admin/scpr_systemmaildispatchproperties

Answered: how to use an UTF8-BOM file with SmartDecompressEx(myStream);

Mon, 14 Nov 2022 13:00:53 +0000

It seems that it is working if csv file is converted into AINSI in place of UTF8/UTF8-BOM

Answered: set a dataset field to null

Tue, 25 Oct 2022 10:18:17 +0000

You can use DataSet.fieldByName('F_FIELD').Clear();
See Data.DB.TField.Clear

But, that being said, it is much better to make your (SQL) queries that use the F_FIELD smarter by handling "" and NULL as the same. Efficy does it automatically, but in SQL you must use NVL or coalesce.

Answered: Encoding issue using OpenUrlSecure

Fri, 14 Oct 2022 07:25:48 +0000

Yes, this is a known limitation in that version of openUrlSecure. That's why the new API method was added in superior versions. Upgrading is the only path to success here

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

Tue, 21 Jun 2022 11:54:32 +0000

Hello Laurent,

I don't think you can use Request in scheduled task context.

See comment in /serverjs/invoicing/utils.js > translate() -> // Prevent error when Request is not available in context (ex: scheduled task)

if (typeof Request !== 'undefined') { // Prevent error when Request is not available in context (ex: scheduled task)
return Request.translate(label);
}

In case of Spycase.js looks like it sends email to the case manager and the body message is base on MAILS object.
You might have to customize Spycase.js. and map translation directly in to it.

var MAILS = {
Close: {
EN: "The case has been closed by the SpyCase.",
FR: "...."
},
Remind : {
EN: "The Customer/Partner has not replied in $0 days.\nPlease send a reminder or tentatively close the case.",
FR: "...."
}
}

var MAILS = {
EN: {
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."
},
FR: {
Close  : "....",
Remind : "...."
}
}

Based on case manager language you can select the needed translation.
Be careful you will need to review all references of MAILS in Spycase.js to adapt the translation. MAILS[ManagerLanguage or by default EN].Close, MAILS.[ManagerLanguage or by default EN].Links, etc.

Answered: Opportunity : set Linked Prod read only

Wed, 15 Jun 2022 07:38:20 +0000

Hello Sébastien,

There is no security on the links in Efficy Entreprise.
But there is an option in SYS_SETTINGS of "Efficy" : relationSecurityLevel
Level of permissions on the relations. 0 = None, 1 = One, 2 = Both.

cf EDN settings and EDN relationSecurityLevel

Hope this will help you

Answered: How to create a directory on the Efficy Server by workflow ?

Tue, 14 Jun 2022 17:55:25 +0000

Hi,
You can use these 2 functions:

https://help.efficy.io/edn/serverjs#Library-directoryExists

https://help.efficy.io/edn/serverjs#Library-createDir

var path =  "C:\\dir\\";  
if (!directoryExists(path)) createDir(path);

Kr,

Answered: How to convert windows 1252 to UTF-8 ?

Fri, 10 Jun 2022 17:02:52 +0000

Hi Luc,

Did you try this method:
https://help.efficy.io/edn/serverjs#Efficy-openUrlSecureUtf8

Kr,

Answered: How to read file from form (POST)

Mon, 09 May 2022 11:32:28 +0000

Dear Max,

I don't think there is a cleaner way than the one you trying to achieve which is parsing the raw content of the request.

Here you can fin an example using a node endpoint for pictures:
https://overflow.efficy.io/?qa=4394/upload-documents-files-from-a-guest-page&show=4394#q4394

Your other form values are then set into contentParts[X].

If you are inside Efficy you must use the FileHelper library btw.

Kr,

Answered: Efficy 12.0 user securities list is missing options

Fri, 26 Nov 2021 11:03:12 +0000

Thanks to Kristof to pointing me this out:
If you don't have Delete Table Rights, you can like not to give Full Control permissions (security). I think this GUI filtering is a way to prevent the "You cannot give permissions that you don't have" kind of error.

This is also something that was corrected along the way, since 11.2 (build 16235):
Editing: the owner of the record can always modify the security, even when the record is “read-only”. (This feature was lost in Efficy 2014.)

Conclusion: this is not an error of Efficy. This is standard behavior in order to avoid error message when committing.

Reminder: Combining rights and securities: which ones prevail?
When rights conflict with securities, apply this rule: the most restrictive setting wins!

Cf EDN to learn more about right and securities: https://help.efficy.io/edn/admin/dsgn_rightssecurities

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

Wed, 17 Nov 2021 11:46:25 +0000

Hi Laurent

You could use the ProjUtil module Users to get a JS Array of all resources in the Application. Then you can check if the user is contained in the resources list with .find.

function isResource (k_User) {
    return Users.getResources().find(function(u) {
        return u.K_USER === k_User;
    }).K_USER > 0;
}

Answered: Error: "data corrupted" when upload images from DataSynchro Remote

Wed, 20 Oct 2021 13:25:41 +0000

Try working with smartCompressEx and smartDecompressEx around streams. See a usage example of compressing here and decompression here.

Answered: Efficy.currentUserCode() is returning email address

Wed, 01 Sep 2021 13:08:45 +0000

I'm not convinced it is possible to make a normal user session using your email address.
Maybe it was related to Azure AD authentication and an "older" version of Efficy...

Answered: format settings difference between efficy and scheduleur

Thu, 26 Aug 2021 11:41:23 +0000

we just find another solution with Pascal using this

formatDateTime("yyyy'/'mm'/'dd hh:nn:ss", dateItemNomenclature)

in place of this

formatDateTime("yyyy/mm/dd hh:nn:ss", dateItemNomenclature)

Answered: Error in FieldByName

Thu, 19 Aug 2021 09:09:55 +0000

Hello,

Why are you passing the K_COMPANY to the OpenConsultContext function ?
Regarding the API reference : https://help.efficy.io/edn/serverjs#Efficy-openConsultContext
It just needs the entity ; then you use Efficy.consult() to open the record and retrieve the dataset.

Best regards,
Sébastien

Answered: Call EditInitializedPackProd on edit and on add

Tue, 29 Jun 2021 13:56:01 +0000

Hi Janne

What happens in the front (a click of button) does not always translate into a unqiue server-side operation. So, knowing "what button" what pressed on the server is not possible.

What I recommend is that you try the OnEditingXxxxYyyy and AfterInsertXxxxYyyy events. See the order of execution in this schema.

Still, inserted should be true anyway when it concerns a new (non committed) entity (or relation) record.

Learn more about Efficy workflow here

AfterLoaded add pack to docu

Wed, 23 Jun 2021 08:11:47 +0000

Hello

I'm trying to do some custom coding when a user adds a package to a document. I'm trying to edit the AfterLoaded function in docuEdit.js.

When I call the following code, a list of all packs linked to the document is returned, but the onclick function only works when the pack is selected as main. The second problem with this code is that the list is returned with every change on the document.

var packlink = document.getElementsByName("Pack-MAIN");
    console.log(packlink);
    if(packlink) {
        for (var i = 0 ; i < packlink.length ; ++i) {
            packlink[i].onclick = OnPackLinkChanged
        }
    }

Is there a way for me to know which package is added to the document and only execute the custom code for the package that is added?

Answered: duplicate document in workflow

Wed, 23 Jun 2021 08:01:02 +0000

Efficy support helped me out and I got it working with the following code:

var docuName = Efficy.getFieldValue(edithandle, 'NAME')
var nbDuplicates = Efficy.sqlQueryValue('select count(k_document) from documents where name=:p1', docuName, 0)

if ( nbDuplicates > 0) return

Answered: Error : (ZEOS-2174) External exception C000001D

Tue, 22 Jun 2021 14:24:28 +0000

Does the query succesfully executes when you run it in MSSQL, while replacing the :MISS_CONT_K_MISSION parameter with 0?

Since the error is external exception, I would look for an external cause first.

Is it always or randomly occuring?
Other queries too?

Answered: InsertDetail AfterCommit

Thu, 27 May 2021 10:07:41 +0000

Hi Janne

Always use the API methods to get relational information in favor of SQL queries. The reason is that you cannot query the database in before commit, because it's not yet committed to the DB.

There are two methods you can use. For a single value, use the first

Efficy.getMainDetail(EditHandle, ntComp); Returns the main linked K_COMPANY key
Efficy.getDetailDataSet(EditHandle, ntComp); Returns a TDataSet of CASE_COMP

Answered: Reference key of the editHandle

Tue, 25 May 2021 06:34:13 +0000

EDN documentation explains getReferenceToGenerate(editHandle) like this:

In BeforeCommit events, retrieves the key of the reference that will be applied when committing the edit context.

So, it means it has only use in BeforeCommit (not in AfterCommit), when a reference has been selected and before it is applied (=generated).

With this event, you could conditionally execute logic in the BeforeCommit instead of AfterCommit, because you already know what reference will be applied. Think about activating a category for instance. Or you could also implement custom security rules and abort the commit if the person cannot select the reference for some reason.

Conditionaly logic on reference should be made on both getReferenceToGenerate(editHandle) and the value of REFERENCE.

Answered: Duplication Merge Workflow?

Wed, 19 May 2021 13:14:58 +0000

Indeed, PrepareDuplicateMerge is fired multiple times as explained in this topic.

It looks like you need the fairly new AfterDuplicateMerge event introduced in Efficy 11.3. I highly recommend to postpone the development until the customer can be upgraded to Efficy 11.3 or newer.

This new worfklow event was delivered because handling merges in prior versions was very hard!

Related material:
Workflow events
Duplicate Merging

Answered: Break from BeforeCommit

Wed, 19 May 2021 05:58:02 +0000

You have to abort the workflow by throwing an exception and not catching it. The custom EfficyJavaAlert that you execute in the catch does not throw an exception. So remove the try/catch and just let the Error fire.

Answered: Delete WrkAlloc function in workflow

Wed, 12 May 2021 06:11:34 +0000

Hi Janne

Because JavaScript is case sensitive, the trigger workflow function names are too. Your function should be OnBeforeDeleteWrkAlloc or OnAfterDeleteWrkAlloc. I see you made a mistake with the first letter.

FYI, these are the events that are fired when you just delete a single Allocation from the planning.

// Events caused by ServerJs method Planning.removeAllocationItem
OnEditingWrkTeam
OnBeforeDeleteWrkAlloc
OnAfterDeleteWrkAlloc

// Events caused by ServerJS method Planning.pushToHistory
OnEditingProj
BeforeCommitProj
AfterCommitProj

Answered: is there a way to make difference between '' and null value in a dataset returned by an sqlQueryDataset

Mon, 10 May 2021 14:24:31 +0000

Hi Vincent, there is no standard workaround for this. I also like and prefer this default behavior with respect to the datatype conversion. Not only strings, but also NULL numbers are forced to 0 when JSON converted.

Logic that depends on wether a string is '', 0 or NULL is to be avoided anyway. So, I would suggest to accept the difference and work your way around it, instead of trying to build a solution with coalesce

Answered: set datetime with fieldbyname

Tue, 27 Apr 2021 10:04:41 +0000

Efficy Appointments and Tasks are both actions, but only Appointments have a time component and appear in the agenda.

You can't have tasks with a specific start time. So, you must set PLANNED='1'

Answered: Efficy usersInGroup function is not working under Efficy 11.3.23950

Sat, 03 Apr 2021 16:42:08 +0000

Hi Stéphane

Efficy API method usersInGroup returns an olevariant. You need to use the specific varArrayLowBound and varArrayHighBound to loop through it. It's actually wel documented...

function userInGroup(userId, groupId) {
  var users = Efficy.usersInGroup(groupId);
  if (!users)
    return false;
  for (var i = varArrayLowBound(users, 1); i <= varArrayHighBound(users, 1); i++) {
    var userId2 = varArrayElement(users, i);
    if (userId2 === userId)
      return true;
  }
  return false;
}

Efficy function varArrayOf is not working under Efficy 11.3.23950

Fri, 02 Apr 2021 10:46:02 +0000

Dear All,

At a customer we used the varArrayOf function to translate JavaScript array into Array of Variants : https://help.efficy.io/edn/serverjs#Library-varArrayOf

But it is seems that it is not working in Efficy 11.3.23950.0

Here is the test I did to show that it is not working in a standard Efficy.
I created a scheduleScript with this code, which is pretty straight forward :

/*
@import "ecma";
*/
function main() {
var users = [1,2,3,4]
var userArr = varArrayOf(users);
Efficy.log('\r\nUsers:' + JSON.stringify(users) + '\r\nUsers Array Of: ' + JSON.stringify(userArr));
}

And here is the result :

[2021/04/02 12:38:46.018] 
[2021/04/02 12:38:46.018] === Run Job ===
[2021/04/02 12:38:46.042] [Efficy113Std - 2] 
[2021/04/02 12:38:46.042] [Efficy113Std - 2] ========================================================================================
[2021/04/02 12:38:46.042] [Efficy113Std - 2] Task 2: Test usersInGroup
[2021/04/02 12:38:46.042] [Efficy113Std - 2] Log on Database Efficy113Std - User ADMIN113
[2021/04/02 12:38:46.084] [Efficy113Std - 2] Load Script File: C:\inetpub\wwwroot\11.3\customs\default\efficy\serverjs\testUsersInGroups.js
[2021/04/02 12:38:46.085] [Efficy113Std - 2] ----------------------------------------------------------------------------------------
[2021/04/02 12:38:46.086] [Efficy113Std - 2] 
Users:[1,2,3,4]
Users Array Of: undefined
[2021/04/02 12:38:46.086] [Efficy113Std - 2] ========================================================================================

Answered: EntityCatalogue get Relation table Name is empty ?

Thu, 01 Apr 2021 10:52:09 +0000

Hello Stephane,

The method getRelationEntityTableName searches for the name in SYS_RELENTITIES that does not contain this relation in standard. You can add it in custom.
Regards,

Pascal

Answered: UserSession.ExecuteCommand alternative to make it work in Save of Action, and not only in Apply

Fri, 12 Feb 2021 11:11:39 +0000

Hello Stijn

We published a new module + project guide that allows you to control client-side actions, such as alert, view or edit from a workflow event.

https://help.efficy.io/edn/projectguides/actionLauncher

This module is 11.2+ compatible.

Answered: FlexMail Synchro Exception "Query TimeOut"

Wed, 10 Feb 2021 14:15:29 +0000

First of all, having or not a fullaccess user will change the parts of the statements to evaluate, so clearly this does generate a different strategy for execution in the SQL server.
That being said, we see in the "slow" (I guess this is the one "without security "), that 86% of time is spent on the Primary key lookup on PROF_CONT...
My understanding is that with full access, the inner join ("PROFJOIN" table) will load way too much records, that will need to be joined to contacts that also have not been reduced via security, and this is only the other where clauses that will reduce the final dataset IMO.
I would have a look at the index fragmentation on PKPROF_CONT index.

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

Wed, 27 Jan 2021 11:50:07 +0000

Hello Tim

You will need to modify the meetingInvitationURL property

Prefix to construct the links that allow to accept and decline a
meeting invitations by e-mail. Example: http://eff.efficy.com/crm/

You can search this settings property on this page.
https://help.efficy.io/edn/settings

Answered: Catching exceptions in triggered workflow event

Thu, 21 Jan 2021 09:11:00 +0000

This was indeed observed, and due to a non reset of a flag when an uncatched exception had happened in a second internal invocation of a serverJS method (
commit entityX -> workflow JS -> commit entityY -> workflow JS with uncatched exception) in that case the exception would be raised all the way up to the delphi context.

Well spotted !

This is solved in svn r24164 and will be shipped in future builds.

KR,
Yann

Answered: Error using Addlink2

Mon, 04 Jan 2021 14:01:17 +0000

Hi Mathieu

Efficy does not have a solid foreign key constraint check on entity_entity relation tables such as PROF_PROF, PROD_PROD, COMP_COMP etc. It means, that when you delete the entity, it does not delete the records from the tree correctly.

So, you likely have selected a K_PROFILE2 that does no longer exist in PROFILES, hence the constraint violation you have in the error.

There error is quite specific actually ;-)

Solution

Join PROFILES to exclude orphaned PROF_PROF.K_PROFILE2 relations

Answered: Prevent "subprojects" from being determined as content to be secured

Mon, 04 Jan 2021 06:54:48 +0000

When you link a project as a child to a parent project with security inheritance enabled, the project inherits the security and content security. It's a one time initialisation caused by the linking operation.

From that moment, you can indepentenly alter the content security of the child project.

When you place an existing project with content security enabled inside a tree, it will not inherit the security.

Tested this morning with Efficy 12.0