{"type":"doc","content":[{"type":"paragraph","content":[{"text":"There are 3 main indexing strategies that the connector supports:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Default. ","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#"}}]},{"text":"Variant Attributes Roll-up inside their parent product","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Index variants separately","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#"}}]},{"text":". Separate documents are created for products and variants","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Index Variants as child of parent","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#"}}]},{"text":".","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"To set up indexing inside your project, you should use the ","type":"text"},{"text":"Initialization Modules","type":"text","marks":[{"type":"link","attrs":{"href":"https://world.optimizely.com/documentation/developer-guides/CMS/initialization/Creating-an-initialization-module/"}}]},{"text":" capability (by implementing the ","type":"text"},{"text":"IConfigurableModule","type":"text","marks":[{"type":"code"}]},{"text":" interface) provided by the Optimizely platform and make your module dependent on the ","type":"text"},{"text":"BasicHawksearchInitialization","type":"text","marks":[{"type":"code"}]},{"text":" module which is part of the installed connector.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Configure Indexing Services","type":"text"}]},{"type":"paragraph","content":[{"text":" In the ","type":"text"},{"text":"ConfigureContainer","type":"text","marks":[{"type":"code"}]},{"text":" method, register services needed to index different types of content. Available options are:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":" container.AddHawksearchCategoryIndexing(); \n container.AddHawksearchProductIndexing();\n container.AddHawksearchVariantIndexing();\n container.AddHawksearchBundleIndexing();\n container.AddHawksearchPackageIndexing();\n container.AddHawksearchPageIndexing()","type":"text"}]},{"type":"paragraph","content":[{"text":"AddHawksearchPageIndexing","type":"text","marks":[{"type":"code"}]},{"text":" extension method can be used multiple times with different generics in order to have multiple cms page types indexed in Hawksearch.","type":"text"}]},{"type":"paragraph","content":[{"text":"If you don’t intend to index some of the cms or commerce entity type, there’s no need to register those services (e.g. if you don’t have bundles or packages in your project, you should not call the ","type":"text"},{"text":"AddHawksearchBundleIndexing","type":"text","marks":[{"type":"code"}]},{"text":" or the ","type":"text"},{"text":"AddHawksearchPackageIndexing","type":"text","marks":[{"type":"code"}]},{"text":" methods).","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":" Initialize Indexing Chains","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Initialize","type":"text","marks":[{"type":"code"}]},{"text":" method, register the 2 chains of ","type":"text"},{"text":"Handlers","type":"text","marks":[{"type":"strong"}]},{"text":" needed for the Full & Incremental Indexing jobs as follows:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":" public void Initialize(InitializationEngine context)\n {\n Container.Service.Configure(config =>\n {\n config.For().Add(() => FullIndexingChain(Container.Service))\n .Transient();\n\n config.For().Add(() => IncrementalIndexingChain(Container.Service))\n .Transient();\n });\n }\n\n private IndexingChain FullIndexingChain(IContainer container)\n {\n return new IndexingChain(container)\n .AddHandler()\n .AddHandler()\n .AddHandler>()\n .AddHandler()\n .AddHandler>()\n .AddHandler>()\n .AddHandler>()\n .AddHandler>()\n .AddHandler>()\n ... other PagesIndexingHandler registrations for different types of cms pages\n .AddHandler()\n .AddHandler();\n }\n\n private IndexingChain IncrementalIndexingChain(IContainer container)\n {\n return new IndexingChain(container)\n .AddHandler()\n .AddHandler>()\n .AddHandler()\n .AddHandler()\n .AddHandler()\n .AddHandler>()\n .AddHandler>()\n .AddHandler>()\n .AddHandler>()\n .AddHandler>()\n ... other PagesIncrementalIndexingHandler registrations for different types of cms pages\n .AddHandler()\n .AddHandler()\n .AddHandler();\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"If you don’t intend to index some of the cms or commerce entity type, you should not add that particular handlers to your indexing chains (e.g. if you don’t have bundles, you will skip adding the ","type":"text"},{"text":"BundlesIndexingHandler","type":"text","marks":[{"type":"code"}]},{"text":" and the ","type":"text"},{"text":"BundlesIncrementalIndexingHandler","type":"text","marks":[{"type":"code"}]},{"text":" to the indexing chains).","type":"text"}]},{"type":"paragraph","content":[{"text":"If you don’t intend to index cms pages, ","type":"text"},{"text":"PagesIndexingHandler","type":"text","marks":[{"type":"code"}]},{"text":",","type":"text"},{"text":"PagesIncrementalIndexingHandler","type":"text","marks":[{"type":"code"}]},{"text":",","type":"text"},{"text":"PagesDeletionHandler","type":"text","marks":[{"type":"code"}]},{"text":" should not be added to the indexing chains.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":" [IncludeInHawksearch] Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"[IncludeInHawksearch]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"is an attribute used to decorate properties which we want to index.","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"codeBlock","content":[{"text":" [IncludeInHawksearch]\n [BackingType(typeof(PropertyString))]\n [Display(Name = \"Brand\", GroupName = SystemTabNames.Content, Order = 15)]\n public virtual string Brand { get; set; }\n [IncludeInHawksearch] \n [Display(Name = \"On sale\", GroupName = SystemTabNames.Content, Order = 50)]\n public virtual bool OnSale { get; set; }","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"This attribute is common for all 3 indexing strategies. For the ","type":"text"},{"text":"Variant Attributes Roll-up Strategy","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":", the properties of the variant decorated with this attribute will be rolled-up inside the parent product.","type":"text"}]},{"type":"paragraph","content":[{"text":"Out of the box, only properties with the following types can be decorated with ","type":"text"},{"text":"[IncludeInHawksearch]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"attribute:","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":".NET specific","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"string\nint\ndouble\ndecimal\nbool\nDateTime","type":"text"}]},{"type":"paragraph","content":[{"text":"Optimizely specific","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"ContentReference\nXhtmlString","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Other property types will throw a ","type":"text"},{"text":"NotSupportedException","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"To support more types, please refer to ","type":"text"},{"text":"this","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":".","type":"text"}]}],"version":1}

Browser not supported