Custom web services

1. Create a Source code schema 

1. Go to the Configuration section and select a custom package to add the schema.

2. Click Add → Source code on the section list toolbar.

   

3. Go to the Schema Designer and fill out the schema properties:

   • Set Code to "UsrCustomConfigurationService."
   • Set Title to "CustomConfigurationService."
   

   Click Apply to apply the properties.

2. Create a service class 

1. Go to the Schema Designer and add the namespace nested into Terrasoft.Configuration. You can use an arbitrary name. For example, UsrCustomConfigurationServiceNamespace.
2. Add the namespaces the data types of which to utilize in the class using the using directive.
3. Add a class name that matches the schema name (the Code property).
4. Specify the Terrasoft.Nui.ServiceModel.WebService.BaseService class as a parent class.
5. Add the [ServiceContract] and [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)] attributes to the class.

3. Implement the class method 

Go to the Schema Designer and add the public string GetContactIdByName(string Name) class method that implements the endpoint of the custom web service. The method executes database queries using EntitySchemaQuery. Depending on the value of the Name parameter in the query string, the response body will contain:

• The ID of the contact (string type) if the contact is found.
• The ID of the first found contact (string type) if several contacts are found.
• The empty string if no contacts are found.

View the source code of the UsrCustomConfigurationService custom web service below.

namespace Terrasoft.Configuration.UsrCustomConfigurationServiceNamespace
{
    using System;
    using System.ServiceModel;
    using System.ServiceModel.Web;
    using System.ServiceModel.Activation;
    using Terrasoft.Core;
    using Terrasoft.Web.Common;
    using Terrasoft.Core.Entities; 

    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class UsrCustomConfigurationService: BaseService
    {
        
        /* The method that returns the contact ID by the contact name. */
        [OperationContract]
        [WebInvoke(Method = "GET", RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
        ResponseFormat = WebMessageFormat.Json)]
        public string GetContactIdByName(string Name) {
            /* The default result. */
            var result = "";
            /* The EntitySchemaQuery instance that accesses the Contact database table. */
            var esq = new EntitySchemaQuery(UserConnection.EntitySchemaManager, "Contact");
            /* Add columns to the query. */
            var colId = esq.AddColumn("Id");
            var colName = esq.AddColumn("Name");
            /* Filter the query data. */
            var esqFilter = esq.CreateFilterWithParameters(FilterComparisonType.Equal, "Name", Name);
            esq.Filters.Add(esqFilter);
            /* Retrieve the query results. */
            var entities = esq.GetEntityCollection(UserConnection);
            /* If the service receives data. */
            if (entities.Count > 0)
            {
                /* Return the "Id" column value of the first query result record. */
                result = entities[0].GetColumnValue(colId.Name).ToString();
                /* You can also use this option:
                result = entities[0].GetTypedColumnValue<string>(colId.Name); */
            }
            // Return the results.
            return result;
        }
    }
}

Click Save then Publish on the Designer's toolbar.

Outcome of the example 

As a result, Creatio will add the custom UsrCustomConfigurationService REST web service that has the GetContactIdByName endpoint.

Access the GetContactIdByName endpoint of the web service from the browser and pass the contact name in the Name parameter.

http://mycreatio.com/0/rest/UsrCustomConfigurationService/GetContactIdByName?Name=Andrew%20Baker

If you access the web service without preauthorization, an error will occur.

Log in to Creatio and execute the request once more. If Creatio finds the contact from the Name parameter in the database, the GetContactIdByNameResult property will return the contact ID value.

If Creatio finds no contacts from the Name parameter in the database, the GetContactIdByNameResult property will return an empty string.

http://mycreatio.com/0/rest/UsrCustomConfigurationService/GetContactIdByName?Name=Andrew%20Bake

1. Create a Source code schema 

1. Go to the Configuration section and select a custom package to add the schema.

2. Click Add → Source code on the section list toolbar.

   

3. Go to the Schema Designer and fill out the schema properties:

   • Set Code to "UsrAnonymousConfigurationService."
   • Set Title to "AnonymousConfigurationService."
   

   Click Apply to apply the properties.

2. Create a service class 

1. Go to the Schema Designer and add the namespace nested into Terrasoft.Configuration. You can use an arbitrary name. For example, UsrAnonymousConfigurationServiceNamespace.
2. Add the namespaces the data types of which to utilize in the class using the using directive.
3. Add the class name that matches the schema name (the Code property).
4. Specify the Terrasoft.Nui.ServiceModel.WebService.BaseService class as a parent class.
5. Add the [ServiceContract] and [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)] attributes to the class.
6. Add the SystemUserConnection system connection to enable anonymous access to the custom web service.

3. Implement the class method 

Go to the Schema Designer and add the public string GetContactIdByName(string Name) class method that implements the endpoint of the custom web service. The method executes database queries using EntitySchemaQuery. Depending on the value of the Name parameter in the query string, the response body will contain:

• The ID of the contact (string type) if the contact is found.
• The ID of the first found contact (string type) if Creatio several contacts are found.
• The empty string if Creatio no contacts are found.

Specify the user on whose behalf to process the HTTP request. To do this, call the SessionHelper.SpecifyWebOperationIdentity method of the Terrasoft.Web.Common namespace after retrieving SystemUserConnection. This method enables business processes to manage the database entity (Entity) from the custom web service that uses anonymous authentication.

Terrasoft.Web.Common.SessionHelper.SpecifyWebOperationIdentity(HttpContextAccessor.GetInstance(), SystemUserConnection.CurrentUser);

View the source code of the UsrAnonymousConfigurationService custom web service below.

/* The custom namespace. */
namespace Terrasoft.Configuration.UsrAnonymousConfigurationServiceNamespace
{
    using System;
    using System.ServiceModel;
    using System.ServiceModel.Web;
    using System.ServiceModel.Activation;
    using Terrasoft.Core;
    using Terrasoft.Web.Common;
    using Terrasoft.Core.Entities; 

    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class UsrAnonymousConfigurationService: BaseService
    {
        /* The link to the UserConnection instance required to access the database. */
        private SystemUserConnection _systemUserConnection;
        private SystemUserConnection SystemUserConnection {
            get {
                return _systemUserConnection ?? (_systemUserConnection = (SystemUserConnection)AppConnection.SystemUserConnection);
            }
        }
        
        /* The method that returns the contact ID by the contact name. */
        [OperationContract]
        [WebInvoke(Method = "GET", RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
        ResponseFormat = WebMessageFormat.Json)]
        public string GetContactIdByName(string Name){
            /* Specify the user on whose behalf to process the HTTP request. */
            SessionHelper.SpecifyWebOperationIdentity(HttpContextAccessor.GetInstance(), SystemUserConnection.CurrentUser);
            /* The default result. */
            var result = "";
            /* The EntitySchemaQuery instance that accesses the Contact database table. */
            var esq = new EntitySchemaQuery(SystemUserConnection.EntitySchemaManager, "Contact");
            /* Add columns to the query. */
            var colId = esq.AddColumn("Id");
            var colName = esq.AddColumn("Name");
            /* Filter the query data. */
            var esqFilter = esq.CreateFilterWithParameters(FilterComparisonType.Equal, "Name", Name);
            esq.Filters.Add(esqFilter);
            /* Retrieve the query results. */
            var entities = esq.GetEntityCollection(SystemUserConnection);
            /* If the service receives data. */
            if (entities.Count > 0)
            {
                /* Return the "Id" column value of the first query result record. */
                result = entities[0].GetColumnValue(colId.Name).ToString();
                /* You can also use this option:
                result = entities[0].GetTypedColumnValue<string>(colId.Name); */
            }
            /* Return the results. */
            return result;
        }
    }
}

Click Save then Publish on the Designer's toolbar.

4 Register the custom web service that uses anonymous authentication 

1. Go to the ..\Terrasoft.WebApp\ServiceModel directory.

2. Create a UsrAnonymousConfigurationService.svc file and add the following record to it.

   <% @ServiceHost
       Service = "Terrasoft.Configuration.UsrAnonymousConfigurationServiceNamespace.UsrAnonymousConfigurationService"
       Debug = "true"
       Language = "C#"
   %>
   

   The Service attribute contains the full name of the web service class and specifies the namespace.

5. Enable both HTTP and HTTPS support for the custom web service that uses anonymous authentication 

1. Open the ..\Terrasoft.WebApp\ServiceModel\http\services.config file and add the following record to it.

   ..\Terrasoft.WebApp\ServiceModel\http\services.config file

   <services>
       ...
       <service name="Terrasoft.Configuration.UsrAnonymousConfigurationServiceNamespace.UsrAnonymousConfigurationService">
           <endpoint name="[Service name]EndPoint"
               address=""
               binding="webHttpBinding"
               behaviorConfiguration="RestServiceBehavior"
               bindingNamespace="http://Terrasoft.WebApp.ServiceModel"
               contract="Terrasoft.Configuration.UsrAnonymousConfigurationServiceNamespace.UsrAnonymousConfigurationService" />
       </service>
   </services>
   

2. Add an identical record to the ..\Terrasoft.WebApp\ServiceModel\https\services.config file.

6. Enable all users to access the custom web service that uses anonymous authentication 

1. Open the ..\Terrasoft.WebApp\Web.config file.

2. Add the <location> element that defines the relative path and access permissions to the web service.

   ..\Terrasoft.WebApp\Web.config file

   <configuration>
       ...
       <location path="ServiceModel/UsrAnonymousConfigurationService.svc">
           <system.web>
               <authorization>
                   <allow users="*" />
               </authorization>
           </system.web>
       </location>
       ...
   </configuration>
   

3. Add the relative web service path to the value attribute of the AllowedLocations key in the <appSettings> element.

   ..\Terrasoft.WebApp\Web.config file

   <configuration>
       ...
       <appSettings>
       ...
           <add key="AllowedLocations" value="[Previous values];ServiceModel/UsrAnonymousConfigurationService.svc"  />
       ...
       </appSettings>
       ...
   </configuration>
   

7. Restart Creatio in IIS 

Restart Creatio in IIS to apply the changes.

Outcome of the example 

As a result, Creatio will add the custom UsrAnonymousConfigurationService REST web service that has the GetContactIdByName endpoint. You can access the web service from the browser, with or without pre-authentication.

Access the GetContactIdByName endpoint of the web service from the browser and pass the contact name in the Name parameter.

http://mycreatio.com/0/ServiceModel/UsrAnonymousConfigurationService.svc/GetContactIdByName?Name=Andrew%20Baker

If Creatio finds the contact from the Name parameter in the database, the GetContactIdByNameResult property will return the contact ID value.

If Creatio finds no contacts from the Name parameter in the database, the GetContactIdByNameResult property will return an empty string.

http://mycreatio.com/0/ServiceModel/UsrAnonymousConfigurationService.svc/GetContactIdByName?Name=Andrew%20Bake

1. Create a custom web service 

This example uses the UsrCustomConfigurationService custom web service. Learn more about developing the service in a separate article: Develop a custom web service that uses cookie-based authentication.

Change the Method parameter of the WebInvoke attribute in the UsrCustomConfigurationService custom web service to POST.

View the source code of the custom web service the example uses below.

namespace Terrasoft.Configuration.UsrCustomConfigurationServiceNamespace
{
    using System;
    using System.ServiceModel;
    using System.ServiceModel.Web;
    using System.ServiceModel.Activation;
    using Terrasoft.Core;
    using Terrasoft.Web.Common;
    using Terrasoft.Core.Entities; 

    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class UsrCustomConfigurationService: BaseService
    {
        
        /* The method that returns the contact ID by the contact name. */
        [OperationContract]
        [WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
        ResponseFormat = WebMessageFormat.Json)]
        public string GetContactIdByName(string Name) {
            /* The default result. */
            var result = "";
            /* The EntitySchemaQuery instance that accesses the Contact database table. */
            var esq = new EntitySchemaQuery(UserConnection.EntitySchemaManager, "Contact");
            /* Add columns to the query. */
            var colId = esq.AddColumn("Id");
            var colName = esq.AddColumn("Name");
            /* Filter the query data. */
            var esqFilter = esq.CreateFilterWithParameters(FilterComparisonType.Equal, "Name", Name);
            esq.Filters.Add(esqFilter);
            /* Retrieve the query results. */
            var entities = esq.GetEntityCollection(UserConnection);
            /* If the service receives data. */
            if (entities.Count > 0)
            {
                /* Return the "Id" column value of the first query result record. */
                result = entities[0].GetColumnValue(colId.Name).ToString();
                /* You can also use this option:
                result = entities[0].GetTypedColumnValue<string>(colId.Name); */
            }
            /* Return the results. */
            return result;
        }
    }
}

2. Create a replacing contact record page 

1. Go to the Configuration section and select a custom package to add the schema.

2. Click Add → Replacing view model on the section list toolbar.

   

3. Select the ContactPageV2 package's Display schema — Contact card view model schema to replace in the Parent object property. After you confirm the parent object, Creatio will populate the other properties.

   
4. Enable the ServiceHelper module as a dependency in the declaration of the record page module. Learn more about the module dependencies in a separate article: AMD concept. Module definition.

3. Add the button to the contact record page 

1. Click the button in the Localizable strings block of the properties panel and fill out the localizable string properties:

   • Set Code to "GetServiceInfoButtonCaption."
   • Set Value to "Call service."

2. Add the button handler.

   Call the web service using the callService() method of the ServiceHelper module. Pass the following parameters of the callService() function:

   • UsrCustomConfigurationService, the name of the custom web service class
   • GetContactIdByName, the name of the custom web service method to call
   • the callback function in which to process the service output
   • serviceData, the object that contains the initialized incoming parameters for the custom web service method
   • the execution context

   View the source code of the ContactPageV2 replacing view model below.

   ContactPageV2

   define("ContactPageV2", ["ServiceHelper"],
   function(ServiceHelper) {
       return {
           /* The name of the record page object's schema. */
           entitySchemaName: "Contact",
           details: /**SCHEMA_DETAILS*/{}/**SCHEMA_DETAILS*/,
           /* The methods of the record page's view model. */
           methods: {
               /* Check if the [Full name] page field is filled out. */
               isContactNameSet: function() {
                   return this.get("Name") ? true : false;
               },
               /* The button click handler method. */
               onGetServiceInfoClick: function() {
                   var name = this.get("Name");
                   /* The object that initializes the incoming parameters for the service method. */
                   var serviceData = {
                       /* The name of the property matches the name of the service method's incoming parameter. */
                       Name: name
                   };
                   /* Call the web service and process the outcome. */
                   ServiceHelper.callService("UsrCustomConfigurationService", "GetContactIdByName",
                       function(response) {
                           var result = response.GetContactIdByNameResult;
                           this.showInformationDialog(result);
                       }, serviceData, this);
               }
           },
           diff: /**SCHEMA_DIFF*/[
               /* The metadata to add the custom button to the page. */
               {
                   /* Add the element to the page. */
                   "operation": "insert",
                   /* The name of the parent control to add the button. */
                   "parentName": "LeftContainer",
                   /* Add the button to the control collection of the parent whose metaname is specified in parentName. */
                   "propertyName": "items",
                   /* The name of the button to add. */
                   "name": "GetServiceInfoButton",
                   /* The additional field properties. */
                   "values": {
                       /* Set the type of the added element to button. */
                       itemType: Terrasoft.ViewItemType.BUTTON,
                       /* Bind the button caption to the localizable schema string. */
                       caption: {bindTo: "Resources.Strings.GetServiceInfoButtonCaption"},
                       /* Bind the button click handler method. */
                       click: {bindTo: "onGetServiceInfoClick"},
                       /* Bind the button availability property. */
                       enabled: {bindTo: "isContactNameSet"},
                       /* Set up the field location. */
                       "layout": {"column": 1, "row": 6, "colSpan": 2, "rowSpan": 1}
                   }
               }
           ]/**SCHEMA_DIFF*/
       };
   });
   

3. Click Save on the Designer's toolbar.

Outcome of the example 

As a result, Creatio will display the Call service button on the contact page after you refresh the Creatio web page. Click the button to call the GetContactIdByName method of the UsrCustomConfigurationService custom web service. The method returns the ID of the current contact.

Integrate external applications with custom Creatio web services via HTTP requests to the services. Editing and debugging tools, such as Postman or Fiddler, help to understand the request creation principles.

Postman is a request testing toolset. The purpose of Postman is to send test requests from the client to the server and receive the server's responses. The example in this article calls a custom web service that uses cookie-based authentication from Postman.

This example uses the UsrCustomConfigurationService custom web service. Learn more about developing the service in a separate article: Develop a custom web service that uses cookie-based authentication.

Since this custom web service uses cookie-based authentication, authorize in Creatio first. Do this by calling the AuthService.svc system web service. Learn more about authentication in a separate article: Authentication.

1. Create a request collection 

1. Go to the Collections tab on the Postman request toolbar and click + New Collection.

   

2. Fill out the request collection fields:

   • Set Name to "Test configuration web service."

     
3. Click Create to create a request collection.

2. Set up an authentication request 

1. Go to the request working area in Postman and right-click the name of the Test configuration web service collection → Add request.

2. Fill out the request fields:

   • Set Request name to "Authentication."

     
3. Click Save to Test configuration web service to add the request to the collection.

4. Select the POST request method in the drop-down list of the Postman workspace toolbar.

   

5. Enter the string of the authentication service request in the Postman workspace toolbar.

   [Creatio application URL]/ServiceModel/AuthService.svc/Login
   

   http://mycreatio.com/ServiceModel/AuthService.svc/Login
   

6. Set the request data format:

   1. Go to the Body tab.
   2. Set the "raw" option.

   3. Select the "JSON" type.

      

7. Go to the Body tab in the Postman workspace and fill out the body of the POST request. The body is a JSON object that contains the login credentials.

   Body of the POST request

   {
       "UserName": "User01", 
       "UserPassword":"User01"
   }
   

3. Execute the authentication request 

Click Send in the Postman workspace toolbar to execute the request from Postman.

As a result, Postman will receive a response that contains a JSON object. View the response body on the Postman Body tab.

The indicators of a successfully executed request are as follows:

• The server returns the 200 OK status code.
• The Code parameter of the response body contains "0."

The response also contains BPMLOADER, .ASPXAUTH, BPMCSRF, and UserName cookies. Postman displays them on the Cookies and Headers tab.

Use these cookies in further requests to Creatio services that use cookie-based authentication.

If you enabled the CSRF attack protection, always use the BPMCSRF cookie for request methods (POST, PUT, DELETE) that modify (add, change, or delete) the entity. If you do not use the BPMCSRF cookie, the server returns the 403 Forbidden status code. Creatio does not check for the BPMCSRF cookie for GET requests. You do not have to use the BPMCSRF cookie with Creatio demo sites since they have CSRF attack protection disabled by default.

The request fails if it contains errors in the string or the body.

The indicators of an unsuccessfully executed request are as follows:

• The Code parameter of the response body contains "1."
• The Message parameter of the response body contains the reason for the authentication failure.

4 Set up the request to the custom web service that uses cookie-based authentication 

The UsrCustomConfigurationService custom web service accepts GET requests only.

To set up the request to the custom web service that uses cookie-based authentication:

1. Go to the request working area in Postman and right-click the name of the Test configuration web service collection → Add request.

2. Fill out the request fields:

   • Set Request name to "Configuration web service."

     
3. Click Save to Test configuration web service to add the request to the collection.

4. Postman selects the GET method by default. Enter the string of the UsrCustomConfigurationService custom web service request in the request field of the Postman workspace toolbar.

   [Creatio application URL]/0/rest/UsrCustomConfigurationService/GetContactIdByName?Name=[Contact name]
   

   http://mycreatio.com/0/rest/UsrCustomConfigurationService/GetContactIdByName?Name=Andrew Baker
   

5. Go to the Headers tab in the Postman workspace and add the cookies received as a result of the authorization request to the headers of the custom web service request. Add the cookie name to the Key field and copy the corresponding cookie value to the Value field.

   

5. Execute the request to the custom web service that uses cookie-based authentication 

Click Send on the workspace toolbar to execute a request from Postman.

Outcome of the example 

As a result, Postman will receive a response that contains a JSON object. View the response body on the Postman Body tab.

If Creatio finds the contact from the Name parameter in the database, the GetContactIdByNameResult property will return the contact ID value.

If Creatio finds no contacts from the Name parameter in the database, the GetContactIdByNameResult property will return an empty string.