web service | Community Creatio

17:11 Oct 24, 2022

Hi,

Are you talking about a service created in the configuration or in the "Web services" section?

Alexandr Bezbozhnov

17:40 Oct 24, 2022

Dmytro Vovchenko, in the web services section

Alexandr Bezbozhnov

17:45 Oct 24, 2022

the question is how to set up its call in c#, so that in the future to use its result in one of the fields of the section

Exposing service to portal users

15:56 Oct 25, 2022

Alexandr Bezbozhnov,

As far as I know, currently, there is no direct way of running this sort of web service from code. However, you can run it inside a business process and you can run this process inside C# code using

ProcessEngineService.svc, with it you even can get the result values of the process.

Show all comments

Kevin Brady

23:58 Sep 27, 2022

Hello all,

I am trying to enable access for a portal user to trigger a service within Creatio. I'm following the steps as listed in this academy page but when I try to declare _baseService and publish, I receive an error saying that GlbInterviewService is "'GlbInterviewService' is a namespace but is used like a type"

namespace Terrasoft.Configuration.KeenGlbInterviewService
{
	using System;
	using System.IO;
	using System.Collections.Specialized;
	using System.Globalization;
	using System.Runtime;
	using System.Runtime.Serialization;
	using System.ServiceModel;
	using System.ServiceModel.Web;
	using System.ServiceModel.Activation;
	using System.Threading;
	using System.Threading.Tasks;
	using System.Web;
	using Terrasoft.Core;
	using Terrasoft.Core.Factories;
	using Terrasoft.Web.Common;
    using Terrasoft.Web.Common.ServiceRouting;
 
	#region Class: KeenGlbInterviewService
 
	[DefaultServiceRoute, SspServiceRoute]
	[ServiceContract]
	[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
	public class KeenGlbInterviewService : BaseService
	{
 
		#region Methods: Public
		private static readonly GlbInterviewService _baseService = new GlbInterviewService();
 
		[OperationContract]
		[WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
		public InterviewServiceResponse Start(InterviewServiceRequest request)
		{
			return _baseService.Start(request); 
		}
 
		[OperationContract]
		[WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
		public InterviewServiceResponse Complete(InterviewServiceRequest request)
		{
			return _baseService.Complete(request);
		}
 
		#endregion
 
	}
 
	#endregion
 
	#region DataContract
 
	[DataContract]
	public class InterviewServiceResponse : ConfigurationServiceResponse
	{
		[DataMember(Name = "isSuccess")]
		public bool IsSuccess {get; set;}
	}
 
	[DataContract]
	public class InterviewServiceRequest
	{
		[DataMember(Name = "interviewId")]
		public Guid InterviewId { get; set; }
	}
 
	#endregion
 
}

From what I can tell I've set everything up exactly as the article says but I still receive the error. Though they declare _baseService the same way. Any suggestions as to what I could be doing wrong?

3 comments

Best reply

17:01 Sep 28, 2022

Kevin Brady,

Ok, according to the error you should have the Terrasoft.Configuration.GlbInterviewService namespace in your system, but you try to create a new method that has the same name as the namespace (as well as your current class KeenGlbInterviewService has the same name as your namespace Terrasoft.Configuration.KeenGlbInterviewService). So theoretically adding "using Terrasoft.Configuration.GlbInterviewService" to your code should fix this issue, but still you need to rename either classes or namespaces since they shouldn't have the same name.

12:23 Sep 28, 2022

Hello Kevin,

I used the same exact code and created a source code in my local app and it didn't return error messages. Try recreating it and also check if the error message is returned from the source code you've shared.

Kevin Brady

16:50 Sep 28, 2022

Oleg Drobina,

I recreated the code and also tried pasting the above code directly back into Creatio to ensure that there weren't any changes that occurred in creating this post and I still received the error.

Issue with port number length

17:01 Sep 28, 2022

Kevin Brady,

Show all comments

Discussion

web service

Franck Lehmann

21:30 Sep 12, 2022

Hi all,

I tried to implement a web service with the configuration section in Creatio for SAP business one Service Layer and the default port for service layer is 50000. URL is the Https://myserver.com:50000/ Configuring the webservice Creatio omitted last 0 and the computed Uri was 0/b1s/... instead of /b1s/ and the connection try was resulting unable to connect because it was attacking on port 5000. I had to change the settings of SAP Service Layer for 5000 then connection succeeded. As we are on prem with SAP no issue to patch but clients on cloud would have issues.

is it possible to fix this issue in Creatio accepting 5 digits for port number?

Thanks in advance,

Franck

Do you like this idea?

3 comments

Cherednichenko Nikita

14:21 Sep 15, 2022

Hi,

There are no restrictions on port length in Creatio.

Try to create the web service again and check how it works.

Perhaps the service settings are cached.

Franck Lehmann

14:39 Sep 15, 2022

Hi Nikita,

You can reproduce like this:

Create a new web service with the port 50000:

https://127.0.0.1:50000/mywebservice

Then click ok, you will see that the URI is truncated and a 0 has been put to the method. You may try to change the values but the system would not save it properly. Running on 7.18.3 same behavior on 8.0.3 on demo instance.

Thanks,

Franck

Cherednichenko Nikita

14:54 Sep 15, 2022

Thanks, I reproduced the described behavior.

You can change the service URL and method settings manually.

I changed it manually, and everything saved correctly for me.

Show all comments

Array parameter Web Service - Business Processs

Uriel Nusenbaum

22:53 Jul 11, 2022

Hi Community!!!

I used built in web service configuration to configure an integration with third party app.

The JSON that third party app receives looks like this:

{

"url": "https://test",

"events": ["a","b"]

}

The configuration for the events parameter into web service is as shown in the image below:

My issue is when I try to call this Web Service/Method from a Business Process. I cannot send the correct values for the events parameter. I tried several options for example: read a lookup values, create list or collection in a script task, etc. but I couldn't achive the goal.

The image below shows how the parameter is requested on the business process:

Below I show the trace with an example of the values I try to pass to the paramter:

"Parameter": "Events",

           "Value": {

               "Before execution": [

                   {

                       "Name": "invitee.created"

                   },

                   {

                       "Name": "invitee.canceled"

                   }

               ],

Any recomendation?

Regards.

3 comments

Cherednichenko Nikita

11:58 Jul 13, 2022

Hello,

You can send your values using a collection.

The values of collection parameters of a [ Call web service ] process element can be mapped to the nested parameters of another collection of a [ Read data ] or [ Call web service ] process element .Additionally, each item of the collection can be mapped to an individual subprocess instance in the [ Subprocess ] element.

You can find more detailed information on the academy website:

https://academy.creatio.com/docs/user/bpm_tools/process_elements_refere…

Uriel Nusenbaum

00:03 Jul 14, 2022

Cherednichenko Nikita,

Thank you! I tried it but the result is something like this:

[

                   {

                       "Name": "invitee.created"

                   },

                   {

                       "Name": "invitee.canceled"

                   }

               ],

The expected value is

[invitee.created","invitee.canceled"]

How can I achive this?

Regards.

webservice restful external integration

12:16 Jul 19, 2022

Hello,

The code

[

                   {

                       "Name": "invitee.created"

                   },

                   {

                       "Name": "invitee.canceled"

                   }

],

Is seen like : [{"Name": "invitee.created"}, {"Name": "invitee.canceled"}].

But, in your case, I believe you can use the parameter value "Collection of values"

Show all comments

dropdown

lookup

web service

#BusinessProcess

event

lookup changed detection

Studio_Creatio_enterprise_edition

7.18

Cascading Dropdown

Ensar

15:51 Jul 06, 2022

Hello,

I want to make a cascading dropdown. For example; user selects City, then County, then District, then Street... I want to fill the dropdowns from external web service whenever user selected previous dropdown.

How should i go about it?

3 comments

16:10 Jul 13, 2022

Hello Ensar,

Loos like you just need to add a filter to the column based on the other column value.

You can do it by adding attribute on the needed column.

For example:

"Transport": {
                "dataValueType": Terrasoft.DataValueType.LOOKUP,
                "lookupListConfig": {
                    "filters": [
                        function() {
                            var filterGroup = Ext.create("Terrasoft.FilterGroup");
                            filterGroup.add("WhatWeight",
                                Terrasoft.createColumnFilterWithParameter(
                                    Terrasoft.ComparisonType.GREATER,
                                    "[StTransport:Id].StMaxWeight",
                                    this.get("Weight")));
                            return filterGroup;
                        }
                    ]
                }

In this example we have column "Transport" and we wont to display values where their column "StMaxWeight" is greater that out column "Weight".

Ensar

08:30 Jul 14, 2022

Thanks for your reply Dmytro Vovchenko,

Filtering is ok. At the same time, i need to get data from external web service not database. Is there a way binding lookups to external web service dynamically?

Web service "dot" in json key

10:48 Jul 14, 2022

Not quite understand what are you trying to do but I think you can store the value from your web service in the schemas attribute and then work with it. To make it work you just need to somehow get the needed value from the web server in the schema code.

Show all comments

Lyle Quesada

10:40 May 07, 2022

Good day community,

I'm having trouble with adding the correct JSON path for my request body.

I have to send a POST request with the following JSON below:

{
  "members": [
    {
      "@odata.type": "--TYPE HERE--",
      "user@odata.bind": "--USER 1 HERE--"
    },
    {
      "@odata.type": "--TYPE HERE--",
      "user@odata.bind": "--USER 2 HERE--"
    }
  ]
}

This is how my parameter structure looks:

Generated JSON here:

{
	"chatType": "oneOnOne",
	"members": [
		{
			"@odata": {
				"type": "--TYPE HERE--"
			},
			"user@odata": {
				"bind": "--USER 1 HERE--"
			}
		}
	]
}

The problem with this structure is that it generates a nested key for type under @odata, and for bind as well. I don't wan't this to happen if possible.

Is there any way to get this to work using parameters in web service? Or would my only resort be to generate the request body via script?

2 comments

Studio_Creatio_enterprise_edition

11:19 May 09, 2022

Hello,

The body of the webservice seems to be generated properly since "members" is the array of objects "@odata" and "user@odata". The request was properly parsed and that's why you saw the result as on the screenshot. If this structure won't work in your business case then a separate script task should be created to sent the request.

Best regards,

Oscar

Lyle Quesada

18:32 May 09, 2022

Hi Oscar,

Thank you for you response.

In forming the json path, I would have made it as $.[members]["@odata.dataType"] or $.[members]["user@odata.bind"], but I'm guessing that this is not possible using the built-in function (nesting parameters) in Creatio?

I think I'll instead be resorting to creating a script task for this.

Thank you!

Lyle

Show all comments

7.18

Auth Code request URL is mandatory to set up OAuth 2.0 Authentication in web service

Pratik Sanghani

10:06 May 04, 2022

Hi Community,

I want to make use of and set up OAuth 2.0 Authentication in web service authentication. For that I found below the academy article :

https://academy.creatio.com/docs/user/no_code_customization/web_service…

While setting up as per the article, there is one required field in the OAuth Setting fields which is "Auth code request URL".

But the API endpoints for which, I have to make use of Web Service OAuth Authentication, is not having settings for Auth code request URL required parameter.

Please guide and help me on this point that how I can set up OAuth Authentication in web service without Auth code request URL.

1 comments

Bogdan

20:16 May 04, 2022

Hello Pratic,

Unfortunately, the is no way to set up OAuth Authentication in web service without Auth code request URL.

This parameter is necessary to identify users.

Best regards,

Bogdan

Show all comments

Call Creatio Web-Service inside Business Process

12:36 Apr 28, 2022

Hello Creatio community !

I would like to call the Creatio Webservice ..../0/rest/FinAppSpecService/InheritSpecificationsForFinApp which automatically populates the Product Terms in Application, inside a Business Process. I can not call it in a c# class because the the constructor of FinAppSpecService class does not accept UserConnection as e parameter. Which is the proper way to solve this problem ?

11 comments

Best reply

15:06 Apr 28, 2022

Hello Petrika,

It's possible if you create a webservice record where the POST method complete address will be {siteURL}/0/rest/FinAppSpecService/InheritSpecificationsForFinApp and in the request parameters specify the following header parameters:

BPMCSRF

ForceUseSession (default value set to true)

Connection (default value set to true)

and the following cookies parameters:

BPMSESSIONID

UserName

BPMLOADER

BPMCSRF

.ASPXAUTH

in the webservice settings (since the FinAppSpecService service is not anonymous). The most difficult part here is setting cookies parameters. I could only recommend the following scenario here:

1) Create a separate authentication service webservice request (to {siteURL}/ServiceModel/AuthService.svc/Login)

2) Specify UserName and UserPassword request body parameters:

3) Add the Set-Cookie response header parameter:

4) Validate the response by performing a test call. It should return the Set-Cookie header that will be then used in the process:

5) Create a separate business process and configure it to run once per hour or once per half a day (depending on the value of the "UserSessionTimeout" system setting). The set-Cookie response header should be parsed to extract values for the

BPMSESSIONID

UserName

BPMLOADER

BPMCSRF

.ASPXAUTH

headers. It can be done by means of the script-task. Extracted values should be set as values for the system settings created separately (one per each header).

6) In your process where you need to call the FinAppSpecService in the "Call webservice" element set the values for the cookie parameters as values from the system settings from step 5. And also specify the value for the BPMCSRF header parameter.

7) Add all other request body parameters and call the service.

This approach should work since we simulate the Postman call of the same service, but set cookie parameters and header parameters via the separate business process and system settings.

Best regards,

Oscar

15:06 Apr 28, 2022

Hello Petrika,

BPMCSRF

ForceUseSession (default value set to true)

Connection (default value set to true)

and the following cookies parameters:

BPMSESSIONID

UserName

BPMLOADER

BPMCSRF

.ASPXAUTH

in the webservice settings (since the FinAppSpecService service is not anonymous). The most difficult part here is setting cookies parameters. I could only recommend the following scenario here:

1) Create a separate authentication service webservice request (to {siteURL}/ServiceModel/AuthService.svc/Login)

2) Specify UserName and UserPassword request body parameters:

3) Add the Set-Cookie response header parameter:

4) Validate the response by performing a test call. It should return the Set-Cookie header that will be then used in the process:

BPMSESSIONID

UserName

BPMLOADER

BPMCSRF

.ASPXAUTH

headers. It can be done by means of the script-task. Extracted values should be set as values for the system settings created separately (one per each header).

7) Add all other request body parameters and call the service.

This approach should work since we simulate the Postman call of the same service, but set cookie parameters and header parameters via the separate business process and system settings.

Best regards,

Oscar

16:32 Apr 28, 2022

Thank you very much for you response Oscar. It was very helpful.

Is there any article or example in the academy regarding point 5, parsing set-Cookie response header to extract values (inside a script task) ?

https://stackoverflow.com/questions/9505400/extract-part-of-a-string-be…

16:39 Apr 28, 2022

Petrika,

This is the task that should be covered by the C# code, using substring method for example. It's something as if you had a task to substring the "test" word from the "Hello test wordl!" string. Please find the way using the topics as the following:

Please also notice that the cookies values length is always constant and all of them start with the cookie name and the "=" character and end with the ";" symbol. This shouldn't be a difficult task.

Once string parts are extracted you can set them as parameter values (here is the Academy article that may be useful) and use these parameters in formulas to set parameter values to correspondent system settings.

Best regards,

Oscar

17:47 Apr 28, 2022

Oscar Dylan,

BPMSESSIONID is generated in the set-Cookie response header, because it seems that it's not found there ? I managed to extract everything else as required

17:57 Apr 28, 2022

Petrika,

Sorry, made a little mistake. BPMSESSIONID cookie is not returned as a response to the /AuthService.svc/Login call, but as a result of the first call to any other working endpoint like /0/odata/Account after authentication. Just try it in Postman and check the response headers in the next request that goes after AuthService request.

Best regards,

Oscar

18:14 Apr 28, 2022

Oscar ,

When i make a request from postman to another web-service the BPMSessionId is generated, I tested it.

Are you suggesting that i put the BPMSESSIONID as a reponse parameter to the InheritSpecificationsForFinApp, not as a request parameter ?

If i understand correctly.

Ryan Farley

18:23 Apr 28, 2022

Petrika,

If you're calling a configuration service, there's no need to actually use it as a service. It's simply a C# class that you can use directly.

For example, something like this:

var svc = new Terrasoft.Configuration.FinAppSpecService();
svc.InheritSpecificationsForFinApp()

Depending on how the configuration service is implemented, you might need to also pass a UserConnection to it, which means you'd need to modify the service to allow this to be passed in.

You had mentioned: "I can not call it in a c# class because the the constructor of FinAppSpecService class does not accept UserConnection as e parameter. Which is the proper way to solve this problem?"

Why not just add two constructors to the class? One that is the default constructor and one that accepts a UserConnection? In the class you could add a method that either returns your private UserConnection variable (passed in by code consuming the class directly) or the one from the session (or BaseService) if being used as a service. I do it this way often and it is far more easy to consume the class directly than to call as a service when it's not needed to be used as a service (not to mention the extra overhead of using it as a service rather than consuming it directly)

Ryan

18:29 Apr 28, 2022

Ryan Farley,

FinAppSpecService() class constructor doesnt allow UserConnection as an argument. I can not modify the FinAppSpecService class because its part of the configuration.

18:33 Apr 28, 2022

Ryan Farley,

Are you suggesting that i copy the

FinAppSpecService class to my package and make proper modifications to it ?

Ryan Farley

19:01 Apr 28, 2022

Petrika,

I was assuming this was your class, that you could modify, not a configuration one that was uneditable by you.

I assume that FinAppSpecService inherits BaseService? If so, it has a UserConnection property that is protected (that does have a setter) as well as a protected constructor that accepts a UserConnection. Since they are protected you should be able to access them if your class is derived from it.

it might work to just make a new class that inherits from the FinAppSpecService that allows a UserConnection to be passed? I've not tried that but it might work - just to throw out some ideas.

Something like this:

public class UsrFinAppSpecServiceWrapper : FinAppSpecService
{
    public void SetUserConnection(UserConnection)
    {
        this.UserConnection = UserConnection;
    }
}

Then to use it:

var svc = new Terrasoft.Configuration.UsrFinAppSpecServiceWrapper();
svc.SetUserConnection(UserConnection);
svc.InheritSpecificationsForFinApp();

Again, I've not tested/tried that before, but I would assume something like this could work? If it does, still far easier route than calling it as a service IMO.

Ryan