Add or Edit an SAP Source
Add or Edit an SAP Source
An SAP source allows you to crawl content from SAP Commerce Cloud.
When creating your source, you must provide a JSON REST configuration instructing Coveo to retrieve items from the repository REST services and their respective resource endpoints (see Reference and Concepts (the SAP source concepts are inherited from the REST API source)).
This configuration indicates which API calls to execute to fetch the desired items, how to parse the responses to extract relevant metadata, and which content type these items represent.
|
Leading practice
The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About crawling speed for information on what can impact crawling speed, as well as possible solutions. |
Source Key Characteristics
Features | Supported | Additional information | |||
---|---|---|---|---|---|
For each endpoint you define in your source configuration, you can provide a refresh endpoint to override the initial endpoint. When you do so, the connector can add, update, or delete specific items in the index instead of refreshing the entire repository. However, the following limitations currently apply:
|
|||||
Content security options |
If your source configuration includes the |
||||
Add or Edit an SAP Source
When adding a source, in the Add a source of content panel, click the Cloud () or Crawling Module (
) tab, depending on your content retrieval context.
With the latter, you must install the Coveo On-Premises Crawling Module to retrieve your content.
To add a source, in the Add a source of content panel, click the SAP source.
To edit a source, on the Sources (platform-ca | platform-eu | platform-au) page, click the desired source, and then click Edit in the Action bar.
The completion steps are especially important when creating or editing a source of this type.
|
Leading practice
It’s best to create or edit your source in your sandbox organization first. Once you’ve confirmed that it indexes the desired content, you can copy your source configuration to your production organization, either with a snapshot or manually. See About non-production organizations for more information and best practices regarding sandbox organizations. |
"Configuration" Tab
On the Edit an SAP Source subpage, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.
General Information
Source Name
Enter a name for your source.
|
Leading practice
A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens ( |
Optical Character Recognition (OCR)
If you want Coveo to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable optical character recognition for details on this feature.
|
Note
Contact Coveo Sales to add this feature to your organization license. |
"Authentication" Section
In the Authentication section, all parameters are optional. Fill the appropriate boxes depending on the authentication type used by the SAP Commerce Cloud instance.
-
If your SAP Commerce uses a HTTP, Basic, Kerberos, or NTLM authentication protocol, enter the Username and Password of the account with which you want to crawl the source. This fills the
username
andpassword
fields in your source JSON configuration. The account of which you enter the credentials must have access to all the content that you want to make searchable. See Source Credentials Leading Practices. -
If your source uses the OAuth 2.0 authentication protocol, enter your content source Client ID, Client secret and Refresh token in the corresponding boxes.
-
If your source uses an API key to authenticate, enter it in the API key box.
-
If your source doesn’t require authentication, leave all boxes empty.
"Content Security" Tab
Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content security.
|
Note
If, while writing your source JSON configuration, you chose to index content access
permissions and used the |
"Access" Tab
In the Access tab, set whether each group (and API key, if applicable) in your Coveo organization can view or edit the current source.
For example, when creating a new source, you could decide that members of Group A can edit its configuration while Group B can only view it.
See Custom access level for more information.
Completion
-
Click Add Source/Save to add/save your source configuration.
-
While writing your JSON configuration, you may have decided to populate fields that aren’t default fields. If you have not already created these fields for another source, you must create them in the Fields (platform-ca | platform-eu | platform-au) page before building your source.
Examples-
You decided to retrieve picture URIs and to have Coveo populate the
pictureuri
field with this data. Your item metadata therefore contains:"pictureuri": "%[picture.uri]"
However, since the
pictureuri
field isn’t a default field likeauthor
ordate
, you must create it. -
You have another source populating the custom field
facebookaccountid
. When creating your new source, you therefore don’t need to create this field, as it’s already in the Fields (platform-ca | platform-eu | platform-au) page.
-
-
Ensure that your source correctly maps all the fields to populate. If a field doesn’t have a mapping, you must create one.
ExampleYou map the
pictureuri
field with the following rule:%[pictureuri]
. -
On the Sources (platform-ca | platform-eu | platform-au) page, you must click Launch build or Launch rebuild in the source Status column to add the source content or to make your changes effective, respectively.
Required privileges
You can assign privileges to allow access to specific tools in the Coveo Administration Console. The following table indicates the privileges required to view or edit elements of the Sources (platform-ca | platform-eu | platform-au) page and associated panels. See Manage privileges and Privilege reference for more information.
|
Note
The Edit all privilege isn’t required to create sources. When granting privileges for the Sources domain, you can grant a group or API key the View all or Custom access level, instead of Edit all, and then select the Can Create checkbox to allow users to create sources. See Can Create ability dependence for more information. |
Actions | Service | Domain | Required access level |
---|---|---|---|
View sources, view source update schedules, and subscribe to source notifications |
Content |
Fields |
View |
Sources |
|||
Organization |
Organization |
||
Edit sources, edit source update schedules, and view the View Metadata page |
Content |
Fields |
Edit |
Sources |
|||
Content |
Source metadata |
View |
|
Organization |
Organization |