Blog posts by Shoma

Blog posts by Shoma2016-01-29T15:47:29.0000000Zhttps://world.optimizely.com/blogs/shoma/ Optimizely World Pickles : Living documentation generatorRecently there came a requirement from the business,they wanted to know a high level view of the specification/requirements of an Project. A colleague suggested that feature files written in gherkin statements where ideal for this purpose. Therefore we had to look for a tool that would translate the feature files to a more business-friendly format (word,pdf,html), so that the business could have a look at it at their convenience without having to reach out developers. There were 2 main tools that suited this requirement namely: <ol> <li><a href="http://www.relishapp.com/">Relish</a></li> <li><a href="http://www.picklesdoc.com/">Pickles</a></li></ol> Relish is based on Ruby plus it comes with a <a href="http://www.relishapp.com/plans-and-pricing">subscription fee</a>. They do have a Free plan, but all your projects will be public! Pickles is open-source and easily installed via nuget. The documentation can be found <a href="http://docs.picklesdoc.com/en/latest/">here.</a> Pickles can be run via commandline, GUI,PowerShell or MSBuild <h2>Sample Example using CommandLine</h2> Pickle supports Html, Dhtml,word,JSON and Excel formats. Install Pickles in your project: using nuget console manager : Install-Package Pickles.CommandLine Open Command Prompt in Administrator mode – > Navigate to your Specs project and execute the below command ..\packages\Pickles.CommandLine.2.3.0\tools\pickles.exe --feature-directory=C:\BitBucket\TestProj.Specs --output-directory=c:\my-features-output --documentation-format=dhtml where --feature-directory =  is the path to your test project --output-directory =  path to your output file --documentation-format =  format of the output (optional) . The default output is html If you want the output in word format then set --documentation-format=word <h2>Plus</h2> The above command can be copied to a .bat-file. Pickles can also be integrated into automated build or continuous integration tool like <a href="http://docs.picklesdoc.com/en/latest/HowToGeneratePicklesDocOnTeamCity/">TeamCity</a>.2016-01-29T15:47:29.0000000Z

Blog post

EPiServer Integration with DotMailer<h1>EPiServer Integration with DotMailer</h1> Hello, This is very first attempt to write a blogpost but definitely not the last! This blog intends to show DotMailer could be integrated into EPiserver using both Dotmailer’s SDK. More documentation regarding DotMailer can be found <a href="https://developer.dotmailer.com/">here</a> and some sample code can be found at <a href="https://github.com/dotmailer/community-supported-projects">gitHub</a> .   <h2>Pre-requisites</h2> 1. Create a Dotmailer account if you do not have one. 2. Create a API user account. Information on how to get a API user key can be found <a href="https://www.dotmailer.com/resources/dev-tools-guides/getting-started-with-the-dotmailer-api/">here</a>. 3. Comma separated CSV file   <h2>Integrating dotMailer Using SDK</h2> Download  the SDK from <a href="https://www.dotmailer.com/media/1104/dotmailersdkv150.zip">here</a> or using the nuget Package manager console command : Install-Package dotMailerSdk <h2>Let’s get started : Using SDK</h2> 1. Create a static class helper class, i have called it DotMailerHelperClass 2. We first need to create a DmService using DmServiceFactory.Create() private static DmService _dmFactoryService;         public static DmService DmFactoryService         {             get { return _dmFactoryService ?? (_dmFactoryService = SetDmFactoryService()); }             set { _dmFactoryService = value; }         }                private static DmService SetDmFactoryService()         {             DmService dmFactoryService = DmServiceFactory.Create(UserName, Password);             return dmFactoryService;         }     3. Once we have a DmService, we need to either import contacts to an existing address book or create a new address book to your account. This can be achieved using the DmFactoryService.AddressBookFactory class. public static DmAddressBook UpdateExistingOrCreateNewAddressBook_UsingSDK(string addressBookName)         {                                    var addressBookList = DmFactoryService.AddressBookFactory.ListAddressBooks();             var addressBook = addressBookList.FirstOrDefault(x => x.Name == addressBookName);             if (addressBook != null)             {                 return addressBook;             }             return DmFactoryService.AddressBookFactory.CreateAddressBook(addressBookName);                             } 4. Before we import contacts, we need to convert the csv file into an IEnumeble<IDmContact> format. The code below does the trick, just pass the path of the csv file: public static IList<IDmContact> GetContactsForImport_ForSDK(string path)         {                        var reader =  new StreamReader(File.OpenRead(path));             string format = "dd MMM yyyy hh:mm";             IList<IDmContact> dmContacts = new List<IDmContact>();                                    var readLine = reader.ReadLine();             if (readLine != null)             {                 var headers = readLine.Split(',');                 while (!reader.EndOfStream)                 {                     var line = reader.ReadLine();                     if (line != null)                     {                         var values = line.Split(',');                         DmContact dmContact = DmFactoryService.ContactFactory.CreateNewDmContact(values[0]);                         for (int i = 1; i < headers.Count(); i++)                         {                             if (headers[i] == "DATE_FORMAT")                             {                                 DateTime dateTime= values[i].ToDateTime();                                 dmContact[headers[i]] = dateTime.ToString(format);                             }                             else                                 dmContact[headers[i]] = values[i];                         }                                               dmContacts.Add(dmContact);                     }                 }             }                         return dmContacts;         }             A couple of things are to be noted here: <ul> <li>If the csv file contains Date in string format, then this has to be converted into a proper date format. <li>The code also takes care of any custom data fields. <li>Custom fields for a DmContact can be accessed using properties.</li></li></li></ul> <blockquote> Ex : dmContact[“Country”]</blockquote> 5. Import the IEnumerable<IDmContact> into the address book. public static ImportContactResult ImportContacts_SDK(IEnumerable<IDmContact> contacts, int addressBookId)         {                        try             {                 ImportContactOptions importContactOptions = new ImportContactOptions();                 var importContactResult =                     DmFactoryService.AddressBookFactory.ImportContactsIntoAddressBook(importContactOptions,                         addressBookId, contacts)                         .GetImportWatcher().Watch();                                                                                    importContactResult.GetImportWatcher().Dispose();                 return importContactResult;             }             catch (Exception exception)             {                 Log.ErrorFormat("Exception in Importing contacts {0}",exception.Message);                              }             return null;         }      A couple of things are to be noted here: <ul> <li>.GetImportWatcher().Watch();  waits for the import to complete.    GetImportWatcher() is a overloaded method where Timespan can also be specified to wait a particular duration of time.       <li>It’s the implementers responsibility to dispose the watch.     <li>The  ImportContactResult has information about the import status and importContactResult.ImportReport can be used to generate the report.</li></li></li></ul>   <h2>Hope that helps!</h2> Thanks2015-11-11T14:27:29.0000000Z

Blog post