Blog posts by Manh Nguyen2024-09-12T07:14:32.0000000Zhttps://world.optimizely.com/blogs/manh-nguyen/Optimizely WorldIntroduce the ablility to select then delete items manually on FIND UI<p>In FIND 16.3.0 we introduce an ability to select items and delete them manually, it will helps you to delete unexpected items from the UI without any line of code.</p>
<p>To do so, go to menu Search & Navigation > Indexed Content > Explore tab then you could see the column next to Type column on the right. Just select the items you want to delete then click [x] button. A confirmation dialog appears with the warning message that the deleting action could not be undone. Hit "Delete" button on the dialog to delete your selected content.</p>
<p>See our <a href="https://support.optimizely.com/hc/en-us/articles/23973547163917-2024-Search-Navigation-release-notes">Release notes</a> and check it out.<img src="/link/e3c13444947442e5a9de27414567628a.aspx" alt="Image image.png" /></p>2024-09-12T07:14:32.0000000ZBlog postIntroducing Search & Navigation Import/Export functionality<p>We introduce a small but helpful funcionality for customers which allow customers import/export list of <em><strong>Related Queries</strong></em>, <em><strong>Synonyms</strong></em>, <em><strong>Autocomplete </strong></em>and <em><strong>Connectors </strong></em>list on FIND 16.3.0.</p>
<p>This will let you manage your list easier, update them quicker or even save the list as a backup file.</p>
<p>Click "Show Help" on the top-right to see the required importing columns or click "Export ..." to get the template.</p>
<p><strong>Export functionality</strong></p>
<p><img src="/link/29d923da1d3543d08b4c0aca0b7f7690.aspx" /></p>
<p>If you click "Export ...", an .csv file will be downloaded with name = functionality name + timestamp that contains all required and optional columns.</p>
<p>For better performance, we support a maximum of 1000 items on a file.</p>
<p><strong>Import functionality</strong></p>
<p>Please note that to avoid unexpected update the current data we only support adding new data to store in our service, if you want to update an item you should do it manually. The items do not exist in the store but exist in the csv file will be added as new items.</p>
<p>Before importing your list items, few conditions need to be met:</p>
<ul>
<li>Accept .csv file only for importing items.</li>
<li>All required columns should be filled.</li>
</ul>
<p>Otherwise, it will show the error: "A .csv file containing ... is required". See below image:</p>
<p><img src="/link/dd0c014a7d884aa580901dbb36b35135.aspx" /></p>
<ul>
<li>All required columns must be fully filled. An "Incorrect data format" will be raised if any required column is absent.</li>
</ul>
<p><img src="/link/bdf54e4618f74619a3a092a2e8040c21.aspx" /></p>
<p>Click "Import ..." then select your file -> Confirm that you select correct file and want to import -> FIND client will import your list items to our service after your confirmation.</p>
<p>A success message will be displayed when your file meets all conditions.</p>
<p><img src="/link/b9419035c53243a78ae476b17b68fd18.aspx" /></p>
<p>Please contact us if you have any feedback or questions.</p>2024-09-11T03:02:30.0000000ZBlog postDefault caching on search request on Search & Navigation<p>For the better performance, Search & Navigation .Net client has provided <em>StaticallyCacheFor</em> method for caching your search result in a specific of time span. It really useful when you perform a real-time search response to your users without a request.</p>
<p>We now including a default caching duration for your search request in-case <em>StaticallyCacheFor</em> make your code more cumbersome 😃</p>
<p>This can be done by setting <em><strong>DefaultSearchCacheDuration</strong></em> (in seconds) in Find section and it applies to all request that calling to <em>GetResult</em> or <em>GetContentResult</em> (in both asynchronous and synchronous version of API).</p>
<pre class="language-markup"><code> "Find": {
"DefaultIndex": "your_index",
"ServiceUrl": "https://service.find.episerver.net/your_private_key",
"DefaultSearchCacheDuration": 300
}</code></pre>
<p>In the example above you config for default caching in 5 minutes, but you can overide this default value for some specific request by using <em>StaticallyCacheFor</em>, this will replace default value as highest priority.</p>
<p>For example:</p>
<pre class="language-csharp"><code>//this response will cache the search result by 5 minutes as DefaultSearchCacheDuration is set to 300 seconds.
var responseCacheInDefault = await SearchClient.Instance
.Search<IContent>().For("samsung")
.GetResultAsync();
//but this response will be cached in 15 minutes
var responseCacheOverridden = await SearchClient.Instance
.Search<IContent>().For("iphone")
.StaticallyCacheFor(TimeSpan.FromMinutes(15))
.GetResultAsync();</code></pre>
<p>If you don't have <em>DefaultSearchCacheDuration</em> in the Find config and don't also set <em>StaticallyCacheFor</em>, your search response will automatically cache in 10 minutes.</p>
<p>But maybe you ask for "what if I don't need any default search cache?", just set <em>DefaultSearchCacheDuration</em> to zero.</p>
<p>For more details please go to our <a href="https://docs.developers.optimizely.com/digital-experience-platform/v1.1.0-search-and-navigation/docs/caching">documents for developers.</a></p>
<p>Please don't hesitate to contact us if you have any question or feedback.</p>2024-09-04T03:32:19.0000000ZBlog postNon-blocking Search with Optimizely Search & Navigation<p>We are thrilled to announce the integration of asynchronous functions into Optimizely’s Search & Navigation features, which have been supported since version 16.3.0. <span>By using these functions, you can leverage the benefits of asynchronous programming and performance improvements. They are particularly helpful if you are building your app with a microservices architecture or simultaneous searching for better user experiences.</span></p>
<p>The current synchronous functions such as search features, tracking, indexing...can be marked as deprecate in the future.</p>
<p>We've already known the advantages of Asynchronous programming:</p>
<ol>
<li><strong>Enhanced Performance:</strong> Asynchronous operations enable non-blocking processes, reducing wait times and improving overall system responsiveness.</li>
<li><strong>Scalability:</strong> Handle multiple requests simultaneously, ensuring consistent performance even during peak usage.</li>
<li><strong>User Experience:</strong> Faster response times lead to a smoother, more dynamic user experience.</li>
</ol>
<p>How we leverage these advantages in Search & Navigation?</p>
<p>Imagine an user searching for a product on your e-commerce site. With asynchronous search, the request is processed instantly. Simultaneously, tracking and statistics operations run in the background, updating user interactions in real-time without impacting the search performance. Paging through results remains smooth and quick, giving users a better experience.</p>
<pre class="language-csharp"><code>var results = await SearchClient.Instance
.UnifiedSearch()
.For("search navigation")
.WithAndAsDefaultOperator()
.UsingAutoBoost()
.ApplyBestBets()
.Track() // statistical track will run asynchnorously and not affect to the search request
.GetResultAsync();</code></pre>
<p>By integrating asynchronous functions, Optimizely Search & Navigation ensures your platform is future-proof, delivering better performance and a better user experience. Upgrade today to experience the difference!</p>
<p>See <a href="https://docs.developers.optimizely.com/digital-experience-platform/v1.1.0-search-and-navigation/docs/net-client-async-apis">developer's document</a> for more detail and please don't hesitate contact us if you have any question or feedback.</p>2024-09-04T02:54:13.0000000ZBlog postConfigure your own Search & Navigation timeouts<p>The main blog <a href="/link/2ebb1de776364df5b6d717d70c3a17e7.aspx">Configure your own Search & Navigation timeouts</a> was posted for years but you need copy the code to your application.</p>
<p>We now bring those code to FIND 16.3.0 and you just need to call SetTimeout(<em>/*timeout in milliseconds*</em>/) method fo make your request works. Both Search and MultiSearch request will work with SetTimeout from FIND 16.3.0.</p>
<pre class="language-csharp"><code>var searchResults = SearchClient.Instance.Search<IContent>().For("alloy").SetTimeout(10000).GetContentResult();
var multiSearchResults = SearchClient.Instance..MultiSearch<IContent>()
.Search<IContent>(x => x.For("test1").InField(f => f.Name))
.Search<IContent>(x => x.For("test2").InField(f => f.Name))
.SetTimeout(10000)
.GetContentResult());</code></pre>
<p>Please contact us if you have any question or feedback.</p>2024-08-30T03:23:30.0000000ZBlog postTool tips: Optimizely Graph Client Tool and how to leverage CMS data models to build query<p><span>Read my first blog about <a href="/link/7143976e5b8744aabbb9ef52647e747c.aspx">Optimizely Graph Client introduction</a> to know its advantages.<br /></span></p>
<p><span>Beside Optimizely Graph Client, now we're supporting a tool for <a href="https://github.com/episerver/graph-net-sdk?tab=readme-ov-file#install-optimizely-graph-client-tool">generating the schema models into C# model classes</a>. This tool supports for precisely generating models which had indexed to the Optimizely Graph, particularly after Content Delivery has transformed CMS models. You can install then use this simple tool with just a few commands and it's very helpful for query builder and/or deserializing search response.</span></p>
<p><span>Notably, with headless architecture, certain properties within the Graph schema and CMS models may differ in name or type, as outlined in our <a href="https://docs.developers.optimizely.com/content-management-system/v1.5.0-content-delivery-api/docs/serialization">Content Delivery</a> documentation; additionally, our indexing process introduces new properties into the Optimizely Graph's schema models. I suppose that you want to build queries with only existing CMS models (or perhaps your custom models) without relying on the generation tool. We've got you covered with a nifty tip for you.</span></p>
<p><strong>Using extension methods</strong></p>
<p><span>One of the most elegant solutions at your disposal is leveraging extension methods. By creating methods with name and return type same as needed properties in the query builder, you could use the methods as the fields for your object model. With just a few lines of code, you can seamlessly integrate extension methods into your CMS models, enhancing their functionality and flexibility.</span></p>
<p><span>Consider an example from the Alloy site, where we add <em>Url</em>, <em>ContentType</em> to both PageData, and ContentReference type. We then utilize these methods for querying:</span></p>
<pre class="language-csharp"><code> public static class CmsModelsExtension
{
public static string Url(this SitePageData pageData)
{
return string.Empty;
}
public static string Url(this ContentReference content)
{
return string.Empty;
}
public static IEnumerable<string> ContentType(this SitePageData pageData)
{
return Array.Empty<string>();
}
}</code></pre>
<p>And then you can use those methods for field selecting, filtering, and faceting.</p>
<pre class="language-csharp"><code>var query = _client
.OperationName("Alloy_Sample_Query")
.ForType<SitePageData>()
.Skip(0)
.Limit(10)
.Fields(x=> x.Url(), x=> x.ParentLink.Url(), x=> x.ContentLink.Url())
.Filter(x=> x.Url().MatchPrefix("https"))
.Search(q)
.FilterForVisitor()
.Facet(x=>x.ContentType().FacetFilters(t));</code></pre>
<p>This way is also useful when you need to select any property in IEnumerable<Your_Data_Type><span>. Just create an extension method with the same name as your property and return the appropriate type.</span></p>
<p>Example to select <em>DisplayName </em>from proprerty ExistingLanguages (IEnumerable<CultureInfo>) in SitePageData:</p>
<pre class="language-csharp"><code>public static class CmsModelsExtension
{
...
public static string DisplayName(this IEnumerable<CultureInfo> cultures)
{
return string.Empty;
}
}
query.Field(x=> x.ExistingLanguages.DisplayName());
query.Filter(x=> x.ExistingLanguages.DisplayName().Eq("English"));</code></pre>
<p><strong>Updating Properties for ContentApiModel (Not recommend)</strong></p>
<p>Another approach involves tweaking the schema models to closely resemble CMS models by adding or removing properties on the ContentApiModel. While technically feasible, we advise caution with this method. It could potentially introduce redundant properties and complicate debugging processes.</p>
<p>In conclusion, whether you opt for the convenience of the generation tool or the flexibility of extension methods, rest assured that we're committed to providing you with the tools and techniques needed to navigate the intricate landscape of CMS models.</p>2024-04-04T10:15:49.0000000ZBlog postIntroducing Optimizely Graph Client and its advantages<p><strong>Introduction</strong></p>
<p><a href="https://nuget.optimizely.com/package/?id=Optimizely.Graph.Client">Optimizely Graph Client</a> was introduced in mid of March 2024 as a lightweight package that mostly supports generating query to our Optimizely Graph service, but you can use that package for your own GraphQL server.</p>
<p>Optimizely Graph Client plays pivotal roles in facilitating seamless interaction with GraphQL APIs and offers distinct advantages for customers seeking simplicity and efficiency. We'll explore how the Optimizely Graph Client eliminates the need for GraphQL expertise by leveraging LINQ expressions and fluent interfaces, ultimately enhancing the user experience and accelerating development phrase.</p>
<p>You could find the documentation about the package for developers on our <a href="https://docs.developers.optimizely.com/platform-optimizely/v1.4.0-optimizely-graph/docs/introduction">Dev guide</a>.</p>
<p><strong>Simplifying Query Builder</strong></p>
<p>For some kind of other tools that require you first to write a GraphQL query into a file and then generate it into C# code, this approach needs to re-generate the client file every time you update your GraphQL query.</p>
<p>With our Optimizely Graph Client, one of the primary advantages is its ability to simplify query builder for developers with limited GraphQL knowledge. While other tools require developers to craft GraphQL queries manually, the Optimizely Graph Client reduces the complexity by allowing developers to express their query requirements using familiar LINQ (Language Integrated Query) and chainable methods. This intuitive approach empowers developers to focus on defining their data requirements in a familiar programming paradigm, without the need to delve into the intricacies of GraphQL syntax.</p>
<p>If you were using FIND (Search & Navigation) client packages you could see a very similar syntax to build a search query to Graph service by leveraging LINQ Expressions and fluent interfaces.</p>
<p>An example to express how to build a simple search query on Alloy site:</p>
<pre class="language-csharp"><code>public class SearchPageController : PageControllerBase<SearchPage>
{
private GraphQueryBuilder _queryBuilder;
public SearchPageController(GraphQueryBuilder queryBuilder)
{
_queryBuilder = queryBuilder;
}
public ViewResult Index(SearchPage currentPage, string q, string t, string p = "1")
{
var query = _queryBuilder
.OperationName("Alloy_Sample_Query")
.ForType<SitePageData>()
.Skip((0)
.Limit(10)
.Fields(x=>x.Name, x=> x.Url, x=> x.MetaTitle, x=> x.MetaDescription)
.Total()
.Search(q)
.FilterForVisitor()
.UsingSynonyms()
.Facet(x=>x.ContentType.FacetFilters(t));
var content = query.GetResultAsync<SitePageData>().Result.Content;
var model = new SearchContentModel(content);
return View(model);
}
}
</code></pre>
<p>The GraphQL query should looks like:</p>
<pre class="language-csharp"><code>query Alloy_Sample_Query {
SitePageData(
skip: 0
limit: 10
where: { _fulltext: { match: "plan" }, Status: { eq: "Published" } }
) {
items {
Name
Url
MetaDescription
MetaTitle
}
facets {
ContentType(filters: ["PageData"]) {
name
count
}
}
total
}
}
</code></pre>
<p><strong>Dynamic Query Generation</strong></p>
<p>The Optimizely Graph Client excels in dynamically generating GraphQL queries based on user-defined criteria expressed at runtime. This dynamic query generation capability allows for dynamic customization based on user input or changing requirements. Developers can specify filtering, sorting, or other criteria dynamically, leading to more flexible and adaptable queries.</p>
<p><strong>Personalization</strong></p>
<p>By defining query criteria dynamically, developers can fetch targeted data relevant to their requirements. This personalized approach to data retrieval fosters a deeper understanding of user behavior, enabling data-driven decision-making and more effective optimization strategies.</p>
<p><strong>Enhanced Productivity and Efficiency</strong></p>
<p>By eliminating the need for manual GraphQL query scripting, the Optimizely Graph Client significantly enhances productivity and efficiency for developers. You can build your complex query with just a few lines of code. Instead of managing static queries, developers can focus on building flexible query generation mechanisms that can adapt to changing requirements over time and do not need to keep track of all your queries in some script files anymore. Otherwise, with this approach you can make the unit test or integration test easier to use and your code easy to debug.</p>
<p><strong>Conclusion</strong></p>
<p>In conclusion, the Optimizely Graph Client is a compelling choice for customers who are seeking simplicity, efficiency, and seamless integration in their experimentation and optimization endeavors. Optimizely Graph Client empowers developers to interact with Optimizely GraphQL API intuitively, without requiring specialized knowledge of GraphQL syntax. This approach not only enhances productivity and efficiency but also accelerates experimentation workflows, enabling organizations to unlock the full potential of digital optimization with ease.</p>
<p><strong>Looking Ahead</strong></p>
<p>Currently, the source code is publicly available in our <a href="https://www.github.com/episerver/graph-net-sdk" target="_blank" rel="noopener">Github repository</a> for any contributor. We’re continuously refining and enhancing the functionalities for the package. Your feedback and your ideas are invaluable in this ongoing process. Please do not hesitate to raise issues or create pull requests to our repository.</p>2024-04-01T07:39:07.0000000ZBlog post