Efficy Overflow Q&A - Recent questions in Remote API (JSON, SOAP, Node)

Last version of Efficy.Net.dll

Tue, 28 Nov 2023 13:51:39 +0000

Hello,

I am migrating a customer from Efficy 2012 to Efficy 12.0.
For this customer, we made a .NET Application to run some synchro between Efficy and another software.

This application doesn't work anymore with Efficy 12.0, we are encountering an error when creating Efficy session.

After some research, it appears that the component Efficy.Net.dll is pretty old and I can't find a recent one.

Edit specific detail from SOAP API when K_RELATION exists

Wed, 15 Mar 2023 13:53:11 +0000

when using the soap interface, the customer wants to update a detail (contact) on a relation where K_RELATION is present.

This is his request

<SOAP-ENV:Envelope xmlns:efficy=http://www.efficy.com xmlns:SOAP-ENV=http://schemas.xmlsoap.org/soap/envelope>
            <SOAP-ENV:Body>
                           <efficy:edit key="734871" entity="POLI">
                                           <updatedetail detailkey="27963" detail="CONT">
                                                           <f_role>2</f_role>
                                           </updatedetail>
                           </efficy:edit>
            </SOAP-ENV:Body>

and this the response :

<SOAP-ENV:Envelope xmlns:efficy=http://www.efficy.com xmlns:SOAP-ENV=http://schemas.xmlsoap.org/soap/envelope>
<SOAP-ENV:Body>
    <efficy:edit key="734871" entity="POLI" edithandle="4" error="true">
        <updatedetail detailkey="27963" detail="CONT">
            <f_role>2</f_role>
        </updatedetail>
    </efficy:edit>
    <SOAP-ENV:Fault>
        <faultcode>EEfficyException</faultcode>
        <faultstring>Cannot find detail with key "27963", relation "1"</faultstring>
        <faultid/>
        <Detail>CORE-1332</Detail>
    </SOAP-ENV:Fault>
</SOAP-ENV:Body>

does he need to search for the specific detail with the detail or is there a better way to obtain the K_RELATION to edit the correct detail ?

SOAP API Security

Wed, 22 Feb 2023 10:53:13 +0000

Good morning everyone,

I'm testing the configuration of the SOAP API and I'm a bit confused on how the security works.

Following the "Easy SOAP integration" project guide I created two queries : one to retrieve a contact's Key with a email parameter and another to retrieve the list of active opportunities of a specific department (no parameter, the department is set). Both query have the following security settings : Administrators group : full control.

I've setup the SOAP Group removing any Privileges and any Table Rights, only checking Query:Execute.
I've setup the SOAP User removing any User Privileges and any User Privileges in Designer ; setting the User Role as SOAP Group; removing the user from Everyone and adding it to the SOAP Group.

Testing the API calls with Postman I get the following results :
* the contact query returns the key value
* the opportunities query return no results unless I add the SOAP User to the right department group

Where does the different behaviour come from ?
Subsequently, how can I restrict the SOAP user from executing any request, allowing only the few specifically designed for the API purpose ?

Thank you for your help,

Alexandre

(API) How to send fax and sms from Efficy as it exists for emails notifications ?

Thu, 10 Nov 2022 10:26:34 +0000

Hello,

Is there any API for sending sms and/or faxes from Efficy ?

Thank you
Dimitri

What is WebHookDispatch service used for?

Wed, 19 Oct 2022 15:06:26 +0000

In Efficy 2021, we remarked that there is a new service call "WebHookDispatchAdmin.exe", do we need to installed it if we use Efficy WebHook ?

And what is used for ?

Is there a way to send mutlivalue fields values through the API ?

Wed, 05 Oct 2022 16:01:01 +0000

We try to use the API to call an Efficy Query that contains multivalue fields.

When we execute the query in Efficy, the result contains the value of the multivalue field, but when we execute the query through the API, the multivalue field is getting the key separated by semic-columns.

In order to test it in a standard Efficy 12.0 Efficy Entreprise, it is quite easy :

1- create an API key in Efficy Designer (link to admin user)
2- create an Efficy Query for instance :
[Select]
OPPORTUNITIES.K_OPPORTUNITY
OPPORTUNITIES.NAME
OPPORTUNITIES.COMPETITORS

[From]
OPPORTUNITIES

[Where]
OPPORTUNITIES.COMPETITORS notisnull ""

[Orderby]

[Options]
ChangeParameters=0
Distinct=0

[InlineEdit]

3- Call this query from Postman :

URL : http://{{YOUR_LOCAL_EFFICY}}/crm/json

HEADERS
X-Efficy-ApiKey:{{EfficyAPIKey}}
Cache-Control:no-cache
Content-Type:application/json
Accept:application/json
Cookie:{{EfficyCookie}}
X-Efficy-Logoff:False
X-Efficy-Lang:FR

BODY
[
{
"@name": "api",
"@func": [
{
"@name": "query",
"key": "{{Efficy Query KEY}}"
}
]
}
]

Result of the API :

{
    "K_OPPORTUNITY": 30,
    "NAME": "test",
    "COMPETITORS": ";1;2;"
},

Result in Efficy :

Attended Result from the API :

{
    "K_OPPORTUNITY": 30,
    "NAME": "test",
    "COMPETITORS": "Competitor1, Competitor2"
},

PS: I Tried with the Alias "MULTIVALUE" but that did not change a thing.

How to manage SOAP requests WSSE (open spec) authentication in JS ?

Tue, 04 Oct 2022 14:16:14 +0000

Hello,

Some context: I have a customer who want me to query the KBO OpenData API.
They use SOAP along with the WSSE open standard, for the authentication.

Do we have a library / tool / projutil to handle the generation of a WSSE header (given a password and username) ?

I swear I have looked around, but alas didn't find such tool

Thank you

Efficy Entreprise Remote API and Sessions : does the SS_ID is working with the JSON API and the API Key ?

Wed, 05 Jan 2022 15:32:12 +0000

On EDN efficysessionclass it is written that we can use the SS_ID parameter in order to create has many sessions we want with the SOAP api.

I suppose it works, but does this SS_ID parameter is working with the JSON API?
I also suppose that it works, but does this SS_ID parameter is working when we use an Efficy API KEY?
Do we have any limitation of the number of sessions that we can open/managed?
Do we have to manage a cookie for each session we open with the SS_ID?
I suppose we need to do it, but do we have to close each sessions once all the calls are finished?
If we don't use the SS_ID parameter is it possible to launch several Efficy API calls at the same time? if yes, how many simultaneous call can we do?

I know it is a lot of question, but I could not find any answer in EDN.

Alphanumeric field gives bizarre error in JSON API request

Thu, 14 Oct 2021 18:22:26 +0000

when executing the following request

[{
        "@name": "Edit",
        "entity": "Docu",
        "commit": "true",
        "closecontext": "true",
        "@func": [{
                "@name": "update",
                "@data": {
                    "NAME": "Klein testje 2021",
                    "F_DIENST": 6,
                    "F_TYPE": 70,
                    "F_ONTVANGSTWIJZE": 0,
                    "F_NR_AANGETEKEND": "220309282357",
                    "MEMOFORMATTED": 0,
                    "MEMO": "",
                    "F_STATUS": 0
                }
            }
        ]
    }
]

we get this error :

"#error": {
"errorcode": "EConvertError",
"errorstring": "'' is not a valid date and time"
}

The field F_NR_AANGETEKEND is the problem.
It's an alphanumeric field with a length of 32.

values like "" or "123" or "0" etc are no problem.
But values like this give the conversion error.
Is this a bug or is there another way how we can force the API to see the value as a string ?

This happens on a Efficy (Build 11.2.19857.0 2019-12-07 12:02)

is there a way to get the session ID

Fri, 21 May 2021 12:34:12 +0000

hi,

One of our customer is making a custom log module and he would like to get the session ID.
Is there an existing function to get that ?

Regards,

How to pass parameters to executeDatabaseQuery?

Mon, 10 May 2021 10:02:33 +0000

How do I provide the TEnhStringList parameter values for the remote executeDatabaseQuery operation?

The following code snippet converts params (a JS Array of values) into values of queryParameters (TEnhStringList object) named like PARAM1, PARAM2...

The query is executed, but with the default parameters, not the one provided

I'm looking for 11.2 compatible code

executeDatabaseQuery: function(idQuery, params) {
    try {
        var ds, operationHandle,
            queryParameters = TEnhStringList.create(),
            loadBlobs = false;

        if (Array.isArray(params)) {
            params.forEach(function(param, index) {
                // Does not work
                queryParameters.values("PARAM" + (index + 1)) = param;

                // Solved with Overflow answer, param must be lower case.
                queryParameters.values("param" + (index + 1)) = param;

            }.bind(this))
        }

        operationHandle = Efficy.executeDatabaseQuery(idQuery, queryParameters, loadBlobs);
        Efficy.executeBatch();

        ds = Efficy.getDataset(operationHandle);
        return JSON.parse(datasetToJSon(ds));
    } finally {
        queryParameters && queryParameters.free();
        ds && ds.free();
    }
}

Can we know the IP address of the sender of a node request?

Wed, 24 Feb 2021 11:17:08 +0000

In a serverjs/api/node file, I would like to track the IP address of the sender of the request.
Is it possible?

Is there anyone who plugged Efficy into an appointment scheduling tool?

Thu, 08 Oct 2020 08:31:19 +0000

Is there anyone who plugged Efficy into an appointment scheduling tool? The need is for Efficy to send a set of diaries to the tool and for this tool to highlight the slots where people are available to make appointments, also taking into account the travel times between 2 appointments.

when this log file is created ? efficy_ServerJS_YYYYDDMM.log

Tue, 25 Aug 2020 08:55:14 +0000

Hi everyone,

For a customer i've made a litle script used by node api.
In this script i've made some Efficy.log to log some things.
When we made test, we 've seen that the log where logged in this file efficy_ServerJS_YYYYDDMM.log

but since the test, this file hasn't been created anymore.
i search why, and what to do for that.

Regards,

Is it possible to pass a null value in JSON API request?

Wed, 19 Aug 2020 06:23:17 +0000

To create a company I'm using the following JSON API request:

[
{
"@name": "edit",
"entity": "Comp",
"key": 0,
"commit": true,
"@func": [
{
"@name": "update", 
"@data": 
{
"NAME": "Test 01",
"VAT": null
}
}
]
}
]

but getting "Unknown data type for field VAT" error:

[
    {
        "@name": "edit",
        "entity": "Comp",
        "commit": true,
        "@func": [
            {
                "@name": "update",
                "@data": {
                    "NAME": "Test 01",
                    "VAT": null
                },
                "#error": {
                    "errorcode": "EEfficyException",
                    "errorstring": "Unknown data type for field \"VAT\"",
                    "detail": "CORE-1326"
                }
            }
        ],
        "key": "13",
        "edithandle": "2",
        "#error": true
    },
    {
        "@name": "exception",
        "#error": {
            "errorcode": "EEfficyException",
            "errorstring": "Unknown data type for field \"VAT\"",
            "detail": "CORE-1326"
        }
    }
]

Is it possible to pass a null value somehow?
Skipping the line will make the request to work, but sometimes it is necessary to pass a null (not an empty string, 0, etc)

Erro 'Field must have a value' when it is filled in

Wed, 22 Apr 2020 14:56:14 +0000

Hi all,

For a customer I am creating a node API and when I execute the code below I get the error "Field company kind must have a value".

When I look in the dataset I can see that the field is filled in.
It's also not an error caused by workflow because I already disabled it in a test.

I think it has something to do with how the relation is created.
Because when i create a link between two companies in the UI a relation is created in both ways (it's some custom).

Maybe this screenshots are useful.

I hope somebody can help me.

Thanks in advance,
Bart

Is it possible to filter by null values using "consultmanyex" function (JSON API) ?

Mon, 02 Mar 2020 07:08:22 +0000

I'm using the JSON API to call the "consultmanyex" function and search for an entity that meet a certain predicate.

I would like to base my predicate on the existence of a value for a certain field.

Do you have an idea of how I can specify a "Null" value in my predicate ?

Here is a query example (that obviously does not work) of what I'm trying to achieve :

[{
    "@name": "api",
    "commit": true,
    "closecontext": true,
    "@func": [
        {
            "@name": "consultmanyex",
            "entity": "ContComp",
            "findfield": "k_contact;d_end",
            "keys": "3544;NULL",
            "separator": ";"
        }
    ]
}]

Remote API: Trouble linking a Case to a Document with JSON

Wed, 12 Feb 2020 12:39:13 +0000

Hi,

when I try to link a Case to a newly created Document I get the following error:

{
            "@name": "insertDetail",
            "detail": "Case",
            "detailKey": 31,
            "#error": {
                "errorcode": "EConvertError",
                "errorstring": "'' is not a valid floating point value"
            }
        }

I'm using the flowing to link the Case to the Document:

{
"@name": "insertDetail",
"detail": "Case",
"detailKey": 31
}

What could be the cause of this error?

PS. When I try to link in Efficy a Case to a Document I don't have any issues.

Best regards,
Jeroen

Insert an attachment through JSON?

Wed, 12 Feb 2020 09:19:07 +0000

Hi,

does anyone know how to insert an attachment through JSON?
I need this for a customer who wants to insert documents from a website.

Best regards,
Jeroen

OAuth2.0: Connection from serverside script

Tue, 19 Nov 2019 10:02:24 +0000

Hello,

for the integration of Rydoo, I need to use a specific authentication protocol called "OAuth2.0". I need to make the API call server-side but to retrieve the authentication token from the API they need this "side-call". It has to be provided as extra in the call, not in the header, body or in the URL params.

I managed to use the API via Postman, but it doesn't seem like there is a way in efficy to make this kind of call (or at least I couldn't find any documentation for it).

Here are some screenshots if it helps to explain my current problem.

How to use Remote Api when sso is activated

Mon, 14 Oct 2019 09:29:37 +0000

Hi All,

I have made an listle custom using /json and /node api.
Working good on the customer test server, but not in their prod server because sso is activated.

(receive a 401 access denied, exactly like you click cancel on the pop windows when trying to connect with a browser)

what do i need to do ?
sending "something" in the header of the request for sso ?
configuring "something" on the server to don't use sso for the remote api ?
other ?

Regards.

Remote Api node is working but return an error in header

Fri, 11 Oct 2019 11:08:18 +0000

Hi Everyone,

I've made a short node api for a customer.
When he use it, all is working good, but he receive this in the header of the response.

X-Efficy-Status:
  - error

i've try locally on my computer with postman and i didn't have this.
I've not yet try on customer test server with postman to see if we have this also

Do you know in which case this is returned in the headers ?

Regards,

Download CONTACTS.PICTURE using api

Mon, 12 Aug 2019 13:24:51 +0000

Is it possible to download pictures from for example contacts.picture using a json API request? I cannot find any documentation about this.

How can we get the real bytes of an attachment from the FILES.STREAM with .NET soap

Mon, 12 Aug 2019 11:57:31 +0000

with

EfficySession s = new EfficySession(...)
var dt = s.ExecuteSQLQuery("select * from ArdisICT.FILES WHERE K_TABLE=31000 AND K_1=:param1", 1, true, p2);
foreach (DataRow r in dt.Rows)
{
   string fname = r["PATH"].ToString();
   string streamv = r["STREAM"].ToString();
   byte[] bytes = s.ConvertFromBase64Attachment(streamv);
}

In bytes I get the zlib compressed data, but how can I get the right decompressed data?

Or can I use soap method similar to Efficy.getFileStream ?

Node not allowed in TConsultRequestHandler

Tue, 28 May 2019 04:53:13 +0000

Hello Efficy Team,

According to (my understanding of) the documentation, we can retrieve the data of a categoy in SOAP, with the node "category".

However, I get an error when I am trying to use it :

What did I missed ?

Obviously, I am not in >11.2, I cannot use RPC JSON request ... :(

Regards,

Loïc

How to best launch command line request?

Wed, 06 Mar 2019 13:45:46 +0000

Hello,

For a client that uses Efficy 10.2, there is already a sync in place between Efficy and their erp software "Talk".

There is a functionality to launch the Talk GUI in Efficy by pressing a button on the relevant contact/company consultation window.

This works fine in IE, but not in for example Chrome. I found that this is due to the use of the ActiveXObject.

What would be a better way to realize this so that all browser can support this functionality? I provided a part of the code below.

function InformNewTalk(Params) {
    var RunStr = "";
    try {
        RunStr += "cmd /K C: & CD c:\\Talkv3_speed\\ & "
        RunStr += "start " + Params.replace(/\==/g,"//")
        RunStr += " & exit";
        var w = new ActiveXObject("WScript.Shell");

        w.run(RunStr);
    } catch (ex) {
        alert(RunStr.replace(/\"/g,"") + "\nError:\n" + ex.message);
        return false;
    }
    return true;
}

Authentication error using openURL

Fri, 25 Jan 2019 14:44:24 +0000

Hello,

I am having a problem with soap requests being sent to a webservice designed to synchronise efficy changes with another system ( Navision ).
The client has upgraded the version of Navision and this is now located on a different server. Efficy version is 2014.

These webservices worked with the old version, but now there seems to be a problem.

The soap requests are triggered in the workflow ( you will find the code below ). After some digging, i found that the request was sending back an HTTP 401 status.
It seems that the authentication is now different than it was before.

The client thinks the new version of Navision does'nt support basic authentication anymore, and that NTLM is now required.

The soap-request itself is correct, i managed to get a result using SoapUI ( see screenshot ), but this seems to use the NTLM protocol.
I used the authentication utility in soapUI for this. ( adding the headers manually doesn't work ).

Could this mean we cannot use openURL to connect anymore? Does it only use basic authentication?

Any suggestions are welcome.

var oldURL = "http://hostname/DynamicsNAV90/WS/Dialog/Page/Integratie_Contact_Card";
var URL = "http://hostname/Dialog/WS/Dialog%20LIVE/Page/Integratie_Contact_Card";   
    var RequestHeader = TStringList.Create;
    try {
        RequestHeader.Add('POST /Dialog/WS/Dialog/Page/Integratie_Contact_Card HTTP/1.1');
        RequestHeader.Add('SOAPAction: urn:microsoft-dynamics-schemas/page/integratie_contact_card:Read');
        RequestHeader.Add('EffNtlmLogin: ...');
        RequestHeader.Add('EffNtlmPassword: ...');
               RequestHeader.Add('Content-Type: text/xml; charset=utf-8');
        var requestContent = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:int="urn:microsoft-dynamics- 
               schemas/page/integratie_contact_card">';
            requestContent += '<soapenv:Header/>';
                requestContent += '<soapenv:Body>';
                    requestContent += '<int:Read>';
                        requestContent += '<int:GTex_CustAddr></int:GTex_CustAddr>';
                        requestContent += '<int:No>' + navNumber + '</int:No>';
                    requestContent += '</int:Read>';
                requestContent += '</soapenv:Body>';
            requestContent += '</soapenv:Envelope>';

        var response = Database.OpenURL2(URL, requestContent, RequestHeader.text);

        navKey = GetTagValue(response, "Key");
        if (navKey == ""){
            Logger.Write("Reading: Company reading with ID: " + compKey + " failed. Response was: " + response);
        }       
} finally {
        RequestHeader.Free;
}

Web service VIES - contral validity VAT number in EU via SOAP

Mon, 07 Jan 2019 11:00:46 +0000

Did any Efficy project already implement this integration through SOAP request?
VIES: http://ec.europa.eu/taxation_customs/vies/vatRequest.html
SOAP: for the SOAP service you may send your xml request by using the following WSDL link: http://ec.europa.eu/taxation_customs/vies/checkVatTestService.wsdl
Br,
Eric

Failed to open an EfficySession in ASP.Net with Efficy 11

Thu, 25 Oct 2018 14:38:00 +0000

I have an ASP.Net web service in C# that connects to Efficy in order to retrieve data. It first instantiates class EfficySession coming from the library Efficy.EfficyCRM.Net (version 1.5.0.0, runtime version v2.0.50727) in order to open a session. The following code used to work with Efficy 10.0.7987 :

EfficySession db = new EfficySession("https://mydomain.com/efficy.dll/SOAP", "login", "pwd", "database", true) ;

But with Efficy 11 we had to change the connection URL from mydomain.com/efficy.dll/SOAP to mydomain.com/crm/SOAP?ss_id=1 :

EfficySession db = new EfficySession("https://mydomain.com/crm/SOAP?ss_id=1", "login", "pwd", "database", true) ;

And it now throws an error « Object reference not set to an instance of an object » when getting executed.

Could it be related to the connection URL? Is there a new version of the library Efficy.EfficyCRM.Net?

How to insert a project and link it to a company

Fri, 25 May 2018 13:31:18 +0000

Hi everyone.

Im working on a method with the C# proxy for add 377 projects with the same Name (Reporting)

and link it to a company with the efficyKey.

here is my code : 

 try
        {
            List<Company> Companies = GetAllCompanies();
            Companies = Companies.Where(a => a.TypeRelation == CompRelationType.Participee || Convert.ToInt32(a.TypeRelation) == 9).Select(a => a).ToList();

            TContextHandle EditContext;

            foreach (var Iterator in Companies)
            {
                EditContext = Proxy.OpenEditContext("PROJ", 0);

                Hashtable Fields = new Hashtable();
                Fields.Add("NAME", "Reporting");

                Proxy.UpdateFields(EditContext, Fields);

                TContextHandle EditDocuProd = Proxy.OpenEditContextRelation("PROJ", EditContext.Key, "COMP", Iterator.EfficyKey, -1);
                Proxy.CloseContext(EditDocuProd);
            }
        }
         catch(Exception E)
        {
            DisposeProxy();
            Helper.LogHelper.LogMessage(Helper.LogHelper.MessageType.Error, "Error EfficyDataLayer.AddDossierForSoc()");
            Helper.LogHelper.LogExceptionMessage(E);
        }

I got an error after the CloseContext because the project is not link to any company.

Do u have the right method to do that ?

Thanks.

Vessiere Thomas.

WebService: NullReferenceException when trying to perform a CloseContext()

Tue, 04 Jul 2017 14:54:02 +0000

Hello,

I am facing an issue with the efficy webservice.

My webservice receives data from the customer website in order to perform several actions in Efficy such as Update/Creation of Contact/Companies.

When I call the UpdateRecordWithFields method of the Record class, I received sometimes the following error:

System.NullReferenceException: Object reference not set to an instance of an object.
at EfficyProxy.SOAPClient.GetResponse()
at EfficyProxy.EfficySession.ExecuteBatch()
at EfficyProxy.EfficySession.CloseContext(TContextHandle ContextHandle, Boolean commit)
at Record.UpdateRecordWithFields(EfficySession Database, Double key, Hashtable fields) in c:\inetpub\efficy\customs\custom\WebService\App_Code\Record.cs:line 231

The line 231 of the Records class is the following:
-> Database.CloseContext(editContext);

This error is not coming from the Efficy Worfklow because everything is well executed.

The strange things are:
-> It not happen all the time
-> It is not linked to the sent data or code in the webservice because if the customer retry to call my webservice, it works

I think this issue is maybe related to a session issue but I don't know how to troubleshoot it.

Does anyone already met this issue or has an idea to solve it ?

Many thanks.

Best regards,
Pierre.

Get Product picture using SOAP Call

Thu, 24 Nov 2016 10:47:57 +0000

Hi Everyone,

Is it possible to get product picture via SOAP CALL to display on an external page?

Thx,
Can Demirci

Merge using SOAP of custom entity

Thu, 10 Nov 2016 10:31:02 +0000

Dear,

We we created a new custom entity and configured the metadata to enable a merge.
When we call the merge using soap we get following error:

<efficy:api page="" _macrofile="">
  <data id="1" operation="automergeduplicate" entity="Cntr" key1="5922849" key2="8023385" alwayskeepfirst="true"/>
</efficy:api>
<SOAP-ENV:Fault>
  <faultcode>EVariantInvalidArgError</faultcode>
  <faultstring>Invalid argument</faultstring><faultid/>
</SOAP-ENV:Fault>

Can some of you tell me how we can troubleshoot this error?
Something is missing but we can't seem to find it.

gr
Erwin

Webhook configuration

Fri, 21 Oct 2016 11:01:39 +0000

Hi Everyone,

For one of our client, I have to configure a webhook to allow a third party application to synchronise Ticket by sending us information (via an url) to notify Efficy when a ticket has been created/modified in the other platform so Efficy could pull the ticket and create it.

I know how to developp it but I'm wondering where should I create that page?
Should it be like a guest page? If I create an independent html page within Efficy, how should the url look like?

Thanks for your time.

KR,

Prince.

How do I read the content of the Field STREAM with Invemaco.Efficy.Net.dll

Wed, 07 Sep 2016 13:48:52 +0000

EfficySession Database;

try
{
/* EfficySession( address, login, password, EfficyAlias, autologin) */
//Database = new EfficySession("http://192.168.1.22/efficy.dll/SOAP", "ADMIN", "ADMIN", "efficy", true);

System.Data.DataTable dtResult = Database.ExecuteSQLQuery("select * from ADMIN.FILES where K_FILE=2");

// There is no column STREAM in the query result

}
finally
{
/* Dispose efficy session before closing the program */
if (Database != null)
Database.Dispose();
}

updatedetail fires EStringListError

Tue, 09 Aug 2016 09:55:14 +0000

<SOAP-ENV:Envelope 
xmlns:efficy="http://www.efficy.com" 
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope">
<SOAP-ENV:Body>
    <efficy:logon database="Development" user="formssoap" password="" handled="true"/>
        <efficy:api handled="true">
            <data id="1" operation="addlink" entity="PUBL" key="9002483" detail="CONT" detailkey="16543" ignoreexisting="true" handled="true">true</data>
        </efficy:api>
        <efficy:edit entity="CONT" key="16543" commit="true" closecontext="true" edithandle="3">
            <updatedetail id="1" detail="PUBL" detailkey="9002483">
                <F_MEMO>Test</F_MEMO>
            </updatedetail>
        </efficy:edit>
    <efficy:logoff/>
    <SOAP-ENV:Fault>
        <faultcode>EStringListError</faultcode>
        <faultstring>List index out of bounds (-1)</faultstring>
        <faultid/>
    </SOAP-ENV:Fault>
</SOAP-ENV:Body>

Anyone can help me on that error message? Or am i completely wrong with addlink and updatedetail?

Best,
Stefan

Set owner to a group using SOAP

Sat, 11 Jun 2016 17:06:55 +0000

Dear,

I saw that we can set K_USER to a group when creating a contact .
Will Efficy accept this?
In the GUI we can not select a group, only users. Can we except side-effects?

gr
Erwin

.NET C# : EfficySession.SetImpersonate() / How to cancel impersonation

Thu, 02 Jun 2016 08:59:11 +0000

Hello,

If I want to use the same session for multiple operations and I have called the method "SetImpersonate()". How to clear it.

Should I call SetImperonate() with string empty, null ?

Best regards

SetImpersonate : SOAP Error when using SetUsers()

Wed, 01 Jun 2016 12:50:19 +0000

Hello,

In our project, we have a WebApi who inserts data into Efficy DB using SOAP (EFFICY.EfficyCRM.NET.dll).

This WebAPI creates the Efficy's connection using an ADMIN login/password.

We want to impersonate a user in order to get the power of Efficy Securities/Right defined in Conficy.

We expect that if we call "DataBase.SetUsers" After impersonation, every records created
in the ACTI_USER table will be created according rights, groups, linked to this impersonated user in Conficy.

But, right now, we receive this error :

"ExceptionMessage": "SOAP Error: DSActiEdit1ActiUser: Cannot
modify a read-only dataset",

The ADMIN user has full access.

The code used in C# :

public void LierActionAvecAgent(double idAction, long idAgent)
        {
            _foremLogger.Trace($"Begin ActionEfficyRepository.LinkAgentToAction(idAgent={idAgent}, idAction={idAction}");
            var dbSession = _efficySessionPool.Get();

            try
            {
                dbSession.SetImpersonate("MNTMNQ");
                var context = dbSession.OpenEditContext(EfficyEntityHandles.Acti.GetDisplayName(),idAction);

                if (context == null)
                {
                    throw new Exception($"Erreur d'ouverture de context Efficy pour l'entité ACTIONS avec la clef {idAction}");
                }

                dbSession.SetUsers(context,new double[] { idAgent} , false );

                dbSession.CloseContext(context);
            }
            finally
            {
                if (dbSession != null)
                {
                    _efficySessionPool.Put(dbSession);
                }
            }
        }

The Exception is thrown by the call to method SetUsers().

Disable notifications for SOAP created events

Wed, 01 Jun 2016 11:27:50 +0000

Hello,

A customer recently asked for a way to disable email notifications sent when an event is created/modified/deleted through SOAP.
Sadly, the DisableNotification is a global setting and therefore not really useful in their case.

The workaround is a bit tricky :
- Find a way to “flag” the notifications coming from SOAP created events (in HTML body as exemple)
- Put a greater Dispatch interval (15 min)
- Make a scheduled serverscript that will check the SYS_MAIL table and delete the items with the “flag” before they are sent by Mail Dispatcher

Not a really “clean” solution though.

Is there a way to implement the DisableNotification setting per record in the SOAP itself?

Soap: Inserting an email with attachment via Soap Call

Wed, 04 May 2016 14:29:51 +0000

Hello,

I'm trying to save and email with an attachement in Efficy via soap.
It seems to work fine but when I try to open the attachment ('msg' file) I have the following error:

Here is my call:

<SOAP-ENV:Envelope xmlns:efficy="http://www.efficy.com" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope">
<SOAP-ENV:Body>
    <efficy:logon database="PROD" user="ipacic" password="TheTable!"/>
    <efficy:api id="1">
        <data operation="impersonateuser" user="EHO" id="129"/>
    </efficy:api>
    <efficy:edit entity="Mail" key="0" commit="true" closecontext="true">
        <update tableview="0">
            <SUBJECT>This is a test mail</SUBJECT>     <!--Subject of the email, cann't be changed afterwards by the user-->
            <TITLE>CLIENT NAME: This is a test mail</TITLE>         <!--This can be a copy of the subject or a customized version, the user can modify this field in Efficy-->
            <OPENED>1</OPENED>
            <MAILFROM>ppa@vogeleer.be</MAILFROM>
           <MAILTO>ppa@efficy.com</MAILTO>
            <MAILCC></MAILCC>
            <K_FOLDER>2</K_FOLDER>      <!--2: Mail received - 3: Mail send-->
            <K_MAILTHREAD>0</K_MAILTHREAD>  <!--Leave at 0-->
            <D_RECEIVED>04/05/2015 13:50</D_RECEIVED>
            <MAILBCC></MAILBCC>
            <BODY>
                               <![CDATA[                
                                                       <html>
                                                                      <body>
                                                                                     <p>test</p>
                                                                      </body>
                                                       </html>]]>
            </BODY>       <!--Better to provide this value, it's easier for the user afterwards in Efficy-->
            <HTMLBODY>
                                                       <![CDATA[                
                                                       <html>
                                                                      <body>
                                                                                     <p>test</p>
                                                                      </body>
                                                       </html>]]>
                                                       </HTMLBODY>
        </update>
        <insertattachment id="1" type="1" path="C:\Users\ppt\Documents\url.msg"/>
        <updateattachment id="2" key="0" encodingkind="MIME64">dGVzdA==</updateattachment>
        <insertdetail id="3" detail="Case" detailkey="627284" maincomp="false"/>
    </efficy:edit>
    <efficy:logoff/>
</SOAP-ENV:Body>

Am I doing something wrong?

KR...

Setting security using SOAP call

Tue, 12 Apr 2016 08:19:21 +0000

Dear,

How can we set the security using SOAP messages?
What is the syntax?

gr
Erwin Vogeleer

Example how to use DownloadFile in Invemaco.Efficy.Net.dll

Mon, 02 Nov 2015 15:23:30 +0000

I 'm looking for an example of how "Download File " can be used in Invemaco.Efficy.Net.dll .

I have attached a PDF file to a document in Efficy, the code below creates a JPG file instead of the PDF.

int docuId = Convert.ToInt32(dr["K_DOCUMENT"]);
EfficyFile file = session.DownloadFile("Docu", docuId, "STREAM");

byte[] data = file.Bytes;
MemoryStream ms = new MemoryStream(data);
mailMessage.Attachments.Add(new Attachment(ms, file.FileName, file.ContentType));

Efficy SOAP vs. ServerScripts

Thu, 17 Sep 2015 09:17:10 +0000

Hi guys!

We need to integrate efficy data and processes into a website.
Including sending emails etc.

I wondered if it is possible to call a server script via SOAP just like <%RunScript()%>.
Otherwise I need to update some hidden fields field and let workflow do the job...

Thank you

Tim

P.S. overflow.efficy.com does a great job! Well done!

XML Soap message: error inserting email

Fri, 31 Jul 2015 06:50:58 +0000

Dear,

I'm having troubles inserting an email using the XML Soap messages.
This is my message:

<SOAP-ENV:Envelope xmlns:efficy="http://www.efficy.com" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope">
<SOAP-ENV:Body>
    <efficy:logon database="databasealias" user="username" password="password"/>
    <efficy:edit entity="Mail" key="0" commit="true" closecontext="true">
        <update tableview="0">
            <SUBJECT>This is a test mail</SUBJECT>     <!--Subject of the email, cann't be changed afterwards by the user-->
            <TITLE>CLIENT NAME: This is a test mail</TITLE>         <!--This can be a copy of the subject or a customized version, the user can modify this field in Efficy-->
        </update>
        <insertattachment id="1" type="1" path="This is a test mail.msg"/>
        <updateattachment id="2" key="0" encodingkind="MIME64">
            {MIME BASE64}
        </updateattachment>
        <insertdetail id="3" detail="Case" detailkey="37" maincomp="false"/>
    </efficy:edit>
    <efficy:logoff/>
</SOAP-ENV:Body>

And this is the error I get:

      <SOAP-ENV:Fault>
     <faultcode>Exception</faultcode>
     <faultstring>Error during CommitChanges on "Mail": Could not convert variant of type          (Null) into type (Double)
     </faultstring>
     <faultid/>
     </SOAP-ENV:Fault>

Any ideas? Is my syntax correct?

Greetings
Erwin

SOAP request to launch existing query in Efficy

Thu, 23 Jul 2015 11:27:45 +0000

Is it possible to launch a existing ( non-system ) query through SOAP ?
If yes, how ?

Impersonating a user

Fri, 03 Jul 2015 13:24:42 +0000

Dear,

Is it possible in Efficy using the or .NET SOAP API or XML webservice messages to impersonate a user?

My client wants to create and update information in Efficy using one of both interface possibilities but he also wants that the applied changes are not all logged in sys_changed under the same user, used for executing the soap calls.
He prefers it is logged as an other user, also known in Efficy.

A possible workaround could be by working with workflow and/or database triggers but it looks cleaner to use impersonate.

Any suggestions?

gr
Erwin

Efficy SOAP DLL: Webservice Inserting an Attachment

Thu, 18 Sep 2014 13:44:34 +0000

Hello,

I would like to know how to use to use the insertattachment function that is available in the Efficy SOAP dll.

Best Regards,

Stéphane R.