coveo-1.0.0-alpha1/help_topics/coveo.setup.html.twig

---
label: 'Coveo Setup'
top_level: true
---
{% set actions_link_text %}
  {% trans %}Actions{% endtrans %}
{% endset %}
{% set actions_link = render_var(help_route_link(actions_link_text, 'entity.action.collection')) %}
{#{% set views_topic_link = render_var(help_topic_link('views.overview')) %}#}


<h2>{% trans %}Coveo Setup{% endtrans %}</h2>
<p>{% trans %}Getting started with Coveo.{% endtrans %}</p>
<h2>{% trans %}Steps{% endtrans %}</h2>
<ol>
  <li>{% trans %}Create an organization.{% endtrans %}</li>
  <li>{% trans %}Create a search component.{% endtrans %}</li>
</ol>

{# @todo need to extend this documentation to secured search providers after I figure out how to implement that... #}
<h3 id="coveo-prefixes">{% trans %}Prefixes{% endtrans %}</h3>
<p>{% trans %}For Drupal to synchronize fields with Coveo, there needs to be a way of isolating fields. We do this by prefixing fields with a special value to namespace them.{% endtrans %}</p>
<h4 id="coveo-prefixes">{% trans %}Default{% endtrans %}</h4>
<p>If you don't configure any prefix values the module will use <code>drpl_</code> to prefix its fields. This is needed to isolate fields from built-in fields as well as any custom fields you may setup for other indexing sources. </p>
<h4 id="coveo-prefixes">{% trans %}Organization Prefixes{% endtrans %}</h4>
<p>{% trans %}These prefixes are applied at the organization level. They are probably the most useful prefix, they allow you to customize the prefix but can be used for quite a bit more.{% endtrans %}</p>
<p>{% trans %}The most useful use of the organization prefix is probably to isolate environments. You can replace this value in different environments and have multiple instances of Drupal connected to Coveo. This can be useful if for example you need a local environment and 1 or more QA environments for testers.{% endtrans %}</p>