dyn-xrm-api

MS Dynamics CRM client for Nodejs

This node module provides a set of methods to interact with MS Dynamics CRM Online services. This is a pure SOAP proxy that supports LiveId authentication.

The module was named dynamicscrm-api and was created as part of KidoZen project, as a connector for its Enterprise API feature in year 2013.

The module was updated and renamed to xrm-api by Innofactor AB in 2016.

The code was exported from https://npmjs.com/ database and carefully saved in git repository preserving history as much as possible. Fork was done after trying reach original maintainers at KidoZen with propose update original package dynamicscrm-api and receiving no answer. All copyrights are preserved in LICENSE file as well in the package.json.

---

This fork was made for personal use to add missing features (customized) and made public to npm 'dyn-xrm-api' in 2018.

Main differences from original module (xrm-api):

• Added "In" conditional operator to RetrieveMultiple.
• Fixed param "RelatedEntities" on Create and Update (fk assignment value).
• New method: ExecuteSetState, used to change state of entity and trigger events on CRM (EntityMoniker).
• Added LinkEntities for RetrieveMultiple;
• Added Sort for RetrieveMultiple;
• Added Criteria for RetrieveMultiple;
• Fixed some bugs.

Future plans:

• Update code to ES2015;
• Code neeed major refactor to become more readable;
• Update tests;
• Update documentation;

Installation

Use npm to install the module:

> npm install dyn-xrm-api

RunKit - Playground - Simple demo

https://runkit.com/wmkdev/dyn-xrm-api-sample

API

Due to the asynchrounous nature of Nodejs, this module uses promises in requests. All functions that promises call have 1 argument: either err or data depending on event type fired.

Constructor

The module exports a class and its constructor requires a configuration object with following properties

• domain: Required string. Provide domain name for the On-Premises org.
• organizationid: Required string. Sign in to your CRM org and click Settings, Customization, Developer Resources. On Developer Resource page, find the organization unique name under Your Organization Information.
• username: Optional dynamics Online's user name.
• password: Optional user's password.
• returnJson: Optional, default value is "true". Transforms the CRM XML Service response to a clean JSON response without namespaces.
• discoveryServiceAddress: Optional. You should not change this value unless you are sure. default value is "https://dev.crm.dynamics.com/XRMServices/2011/Discovery.svc"

const dynXrmApi = require("dyn-xrm-api");
const _dynamics = new dynXrmApi({ 
	domain: process.env.CRM_HOST,
	hostName: process.env.CRM_HOST,
	port: +(process.env.CRM_PORT || 80),
	organizationName: process.env.CRM_ORGNAME,	
	timeout: 2 * 60 * 1000, // timeout 2 minutes
	returnJson: true, // return response in json
	authType: 'ntlm', // authentication type ntlm to access resource using xrm soap api
	username: process.env.CRM_USERNAME,
	password: process.env.CRM_PASSWORD,	
	useHttp: true, // to use http or https/
});

Methods

All public methods has the same signature. The signature has one argument: options.

• options must be an object instance containig all parameters for the method.

RetrieveMultiple(options)

This method should be used to retrieve multiple entities.

Parameters:

• options: A required object instance containing parameters:
  • EntityName: String. The name of the entity to create (Lead, Contact, etc. )
  • ColumnSet: Array of strings with the names of the columns to retrieve (empty = *).
  • TopCount: Limit number of objects to return.
  • Criteria: Criteria to search on CRM (where clause).
  • Order: Field to order the search on CRM.
  • LinkEntities: Relation to perform "join" on crm.

 const options = {
      EntityName: 'systemuser',
      ColumnSet: [
        'fullname',
        'internalemailaddress',
        'address1_telephone1',
        'systemuserid',
        'isdisabled',        
        'modifiedon',
      ],
      TopCount: 100,
      Criteria: {
        Conditions: [
          {
            AttributeName: 'modifiedon',
            Operator: 'GreaterEqual', //'GreaterEqual','GreaterThan','LessEqual','LessThan','Equal','NotEqual', 'In'.
            Value: dateFilter.toISOString(),
          },
        ],
        FilterOperators: ['And'],
      },
      LinkEntities: [
        {
          LinkFromAttributeName: 'main_user',
          LinkFromEntityName: 'account',

          LinkToAttributeName: 'contactid',
          LinkToEntityName: 'contact',

          EntityAlias: 'ac',
          JoinOperator: 'LeftOuter', // LeftOuter, Inner, Natural

          ColumnSet: [
		'fullname',
		'internalemailaddress',						
		],
        },
      ],
      Order: {
        Conditions: [
          {
            AttributeName: 'modifiedon',
            OrderType: 'Descending', // Ascending, Descending
          },
        ],
      },
    };

    const resultCrm = await this._dynamics.RetrieveMultiple(options);

Create(options)

This method should be used to create new entities such as leads, contacts, etc.

Parameters:

• options: A required object instance containing parameters:
  • LogicalName: String. The name of the entity to create (Lead, Contact, etc. )
  • Attributes: Array of Key-Value strings .
  • RelatedEntities: Array of FK entities related to the new one.

    const options: any = {
        LogicalName = 'contact',
        Attributes = [
            { key: 'firstname', value: entity.name },
            { key: 'lastname', value: entity.lastname },
            { key: 'emailaddress1',value: entity.email },
        ],
        RelatedEntities = [
        {
          key: 'parentcustomerid',
          Id: accountCrmId,
          LogicalName: 'account',
        },
      ],
    };
    
    const resultCrm = await this._dynamics.Create(options);

Update(options)

This method should be used to update an entity.

Parameters:

• options: A required object instance containing parameters:
  • id: Entity unique identifier.
  • LogicalName: String. The name of the entity to create (Lead, Contact, etc. )
  • Attributes: Array of Key-Value strings .
  • RelatedEntities: Array of FK entities related to the new one.

    const options: any = {
        id = entityCrmId,
        LogicalName = 'contact',
        Attributes = [
            { key: 'firstname', value: entity.name },
            { key: 'lastname', value: entity.lastname },
            { key: 'emailaddress1',value: entity.email },
        ],
        RelatedEntities = [
        {
          key: 'parentcustomerid',
          Id: accountCrmId,
          LogicalName: 'account',
        },
      ],
    };
    
    const resultCrm = await this._dynamics.Update(options);

ExecuteSetState(options)

This method should be used to retrieve multiple entities.

Parameters:

• options: A required object instance containing parameters:
  • EntityMoniker: Object. The Id and LogicalName of the entity to be updated.
  • Parameters: Array. Array of objects to pass to crm.
  • RequestName: String. Name of the request.

  const options: any = {
    RequestName = 'SetState',
    EntityMoniker = {
      Id: userId,
      LogicalName: 'contact',
    },
    Parameters = [
      { key: 'State', value: 0 },
      { key: 'Status', value: 1 },
    ],
  };    

  const resultCrm = await this._dynamics.ExecuteSetState(options);

------------------------------

Information below is outdated/not tested, sorry!

------------------------------

Delete(options)

This method should be used to delete an entity.

Parameters:

• options: A required object instance containing authentication's parameters:
  • id: Entity unique identifier.
  • EntityName: String. The name of the entity to create (Lead, Contact, etc. )

	var options = {};
	options.id = '00000000-dddd-eeee-iiii-111111111111';	
	options.EntityName = 'lead';

	dynamics.Delete(options)
        .then(function (data)) {
            console.log("Success!");
        })
        .catch(function (err) {
            console.log("Failure...");
        });

Retrieve(options)

This method should be used to retrieve a single entity.

Parameters:

• options: A required object instance containing authentication's parameters:
  • id: Entity unique identifier.
  • EntityName: String. The name of the entity to create (Lead, Contact, etc. )
  • ColumnSet: Array of strings with the names of the columns to retrieve.

	var options = {};
	options.id = '00000000-dddd-eeee-iiii-111111111111';	
	options.EntityName = 'lead';
	options.ColumnSet = ['firstname'];
	
	dynamics.Retrieve(options)
        .then(function (data)) {
            console.log("Success!");
        })
        .catch(function (err) {
            console.log("Failure...");
        });

Associate(options)

This method should be used to create a relation between entities.

Parameters:

• options: A required object instance containing authentication's parameters:
  • EntityId: Entity unique identifier.
  • EntityName: String. The name of the entity to create (Lead, Contact, etc. )
  • RelationShip: Object with the crm relationship details, such as schemaName ({ SchemaName: 'contact_customer_accounts'}).
  • RelatedEntities: Array of related entities objects with the following values:
  • • Id: Related entity unique identifier.
  • • LogicalName: Name of the related entity.

	var options = {};
	options.EntityId = '00000000-dddd-eeee-iiii-111111111111';	
	options.EntityName = 'account';
	options.RelationShip = { SchemaName: 'contact_customer_accounts'};
	options.RelatedEntities = [{Id : '00000000-dddd-0000-0000-111111111111',LogicalName : 'contact'}];
	
	dynamics.Associate(options) 
        .then(function (data)) {
            console.log("Success!");
        })
        .catch(function (err) {
            console.log("Failure...");
        });

Disassociate(options)

Parameters:

• options: A required object instance containing authentication's parameters:
  • EntityId: Entity unique identifier.
  • EntityName: String. The name of the entity to create (Lead, Contact, etc. )
  • RelationShip: Object with the crm relationship details, such as schemaName ({ SchemaName: 'contact_customer_accounts'}).
  • RelatedEntities: Array of related entities objects with the following values:
  • • Id: Related entity unique identifier.
  • • LogicalName: Name of the related entity.

	var options = {};
	options.EntityId = '00000000-dddd-eeee-iiii-111111111111';	
	options.EntityName = 'account';
	options.RelationShip = { SchemaName: 'contact_customer_accounts'};
	options.RelatedEntities = [{Id : '00000000-dddd-0000-0000-111111111111',LogicalName : 'contact'}];
	
	dynamics.Disassociate(options)
        .then(function (data)) {
            console.log("Success!");
        })
        .catch(function (err) {
            console.log("Failure...");
        });

Execute(options)

Parameters:

• options: A required object instance containing authentication's parameters:
  • RequestName: Name of the crm method to execute.
  • Parameters: : Array of Key-Value strings with the method's parameters names and values.

	var options = {};
	options.RequestName = 'account';
	
	dynamics.Execute(options)
        .then(function (data)) {
            console.log("Success!");
        })
        .catch(function (err) {
            console.log("Failure...");
        });

#License

Copyright (c) 2013 KidoZen, inc. Copyright (c) 2016 Innofactor AB, inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.