COYO Connector

Installation and Configuration

Mindbreeze GmbH, A-4020 Linz, 2024.

These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes, or any other protected rights. The dissemination, publication, or reproduction hereof is prohibited.

For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the principle of equal treatment for both sexes.

Introduction

Using the COYO Connector, you can connect your COYO instance to Mindbreeze InSpire. Thus, you can find threads, blogs, wikis, forms, etc. all with Mindbreeze search.

Installation

Before installing the COYO Connector, make sure that Mindbreeze Server is installed.

Configuring COYO

In order for Mindbreeze InSpire to connect to your COYO instance, you must first perform configurations in your COYO instance.

Providing a Crawler User

Create a new user in COYO that can be used in the Mindbreeze COYO Connector to crawl COYO. The user must have read permissions on all content to be indexed. The easiest way to do this is with the help of an admin user or a user with the permissions "Access moderator mode" and "Manage users, groups and roles".
In addition, it must be ensured that the user is in moderator mode before crawling. To do this, you can log in as the user, click on the profile at the top right, and then click "Enable Moderator Mode". If one then logs out without leaving the moderator mode again, it remains active.

Create API Client

An API client is still needed. This can be created in the administration area under "API clients".

When you click on "Create credential pair", you can enter the name of the app. The secret is generated automatically.

Configuring Mindbreeze

Open Mindbreeze Management Center in the browser to start configuration.

Configuring the Index

Add a new index in the “Indices” tab with the “+Add Index” button. Select the desired Index Node and Client Service and enter the data source COYO in the “Data Source” field. Afterwards, confirm your entries by clicking the “Apply” button.

Configuring the data source

Now you can configure the data source.

Legend:

Properties marked with an *: required fields – these must be explicitly configured
Properties not specifically marked: optional fields

Connection Settings

COYO Url*

The URL to the COYO instance, e.g. https://mycompany.gocoyo.com/

COYO OAuth Credentials*

The OAuth 2 credential created in the Network tab.
The following things need to be configured for this:

In Tab Network:
Access Token URL	Usually just COYO Url + /api/oauth/token, so e.g. https://mycompany.gocoyo.com/api/oauth/token
Client ID	The name of the created API client
Username	The login name of the created crawl user
Password	The password of the created crawl user
Client Secret	The generated secret of the created API client

Enable Delta Crawl

If this option is enabled, only new documents/posts/articles etc. and certain modified documents are downloaded in crawl runs. Changes to other existing documents and deleted documents are only processed in full crawls based on the "Full Crawl Schedule".

If this option is enabled, the "Full Crawl Schedule" must also be set.

Full Crawl Schedule

An extended cron expression that specifies when a full crawl should be performed. If the cron job is triggered, a full crawl is performed during the next crawl run, during which all documents are indexed, updated or deleted if necessary.

Documentation and examples for Cron Expressions can be found here.

Page Size
(Advanced Settings)

The maximum number of elements that are fetched per API request. If this is increased, fewer requests may need to be made to the API, but it may result in increased memory usage.
The maximum value is 2000.

Log All Requests
(Advanced Settings)

If enabled, all requests to the COYO API are logged to a "coyo-request-log.csv" file.

Crawling Constraints (Advanced Settings)

Index Unpublished Articles

If activated, articles that have not yet been published, i.e. that are still in draft status, will be indexed.

Index User Timelines

When enabled, timelines are indexed on users' profiles.

Max File Size

The maximum file size at which the file will still be downloaded, in MB.

If a file exceeds this size, it is indexed without content.

Constraints

Constraints can be used to exclude files, apps or pages/communities via their metadata.

Metadata Key	The name of the metadata to compare the patterns against. This refers to the name of the metadata in the index.
Include Pattern (regex)	Regex patterns with which the value of the metadata is compared in order to include the document.
Exclude Pattern (regex)	Regex patterns with which the value of the metadata is compared to exclude the document.

The following things should be noted:

A constraint is only checked if the object has the corresponding metadatum set. Otherwise, the constraint is ignored.
Excludes are stronger than includes. If an object is excluded by at least one exclude pattern, it will not be indexed, regardless of whether it matches other include patterns.
If an include pattern is configured for a metadatum, any object that has the metadatum must match the pattern if it is to be indexed. If only exclude patterns are set for the metadatum, the object will be indexed as long as it does not match any exclude pattern.
If an object with any child objects is excluded (e.g. Pages, Communities, Apps, etc.), the child objects will not be indexed either.

Some examples of metadata commonly used for exclude/include can be found here.

Performance Settings

Concurrent Filter and Index Dispatch Threads
(Advanced Settings)

The number of threads with which documents are sent from the crawler to the index.

Configuring the Principal Resolution Service

In the new or existing service, select the COYO Principal Resolution Service option in the Service setting. For more information about additional configuration options and how to create a cache and how to do the basic configuration of a cache for a Principal Resolution Service, see Installation & Configuration - Caching Principal Resolution Service.

The following tables describe the settings you can make for the Principal Resolution Service.

Legend:

Properties marked with an *: required fields – these must be explicitly configured
Properties not specifically marked: optional fields

Connection Settings

COYO Url*

The URL to the COYO instance, e.g. https://mycompany.gocoyo.com/

COYO OAuth Credentials*

The OAuth 2 credential created in the Network tab.
The following things need to be configured for this:

In Tab Network:
Access Token URL	Usually just COYO Url + /api/oauth/token, so e.g. https://mycompany.gocoyo.com/api/oauth/token
Client ID	The name of the created API client
Username	The login name of the created crawl user
Password	The password of the created crawl user
Client Secret	The generated secret of the created API client

Page Size
(Advanced Settings)

Log All Requests
(Advanced Settings)

If enabled, all requests to the COYO API are logged to a "coyo-request-log.csv" file.

Resolve Anonymous Users to Public Groups
(Advanced Settings)

If this option is enabled, all users and also non-logged-in users can find public content in COYO. Public content is all content in public pages, communities and events. By default, users must be at least logged in and need the respective permissions (Access to pages, Access to communities, Access to events) in COYO.

Warning: This could allow users who would not have access to certain content in COYO to see it in Mindbreeze. It is not recommended to enable this option unless it is absolutely necessary.

Appendix

Commonly used Metadata

coyo_senderType	Type of sender For example: page, workspace (communities are called workspaces in the background), event, user
categoryclass	Type of the object For example: File, Folder, Wiki Article, Blog Article, Timeline, Timeline Post, Form, Form Entry etc.
extension	File extension of files For example: txt, png, html, pdf, mp4
title	The title of the object
coyo_author	Author of the document/post
coyo_active	Indicates whether the user is activated in COYO Value is "false" if the user is not activated and "true" if the user is activated
coyo_department	Department of the user For example: Marketing, Qualitiy Assurance, Management etc.

COYO Connector

Installation and Configuration

Introduction

Installation

Configuring COYO

Providing a Crawler User

Create API Client

Configuring Mindbreeze

Configuring the Index

Configuring the data source

Connection Settings

Crawling Constraints (Advanced Settings)

Performance Settings

Configuring the Principal Resolution Service

Connection Settings

Appendix

Commonly used Metadata

Download PDF

Download PDF

{{{i18n.refineSearch}}}

COYO Connector

Installation and Configuration

Introduction

Installation

Configuring COYO

Providing a Crawler User

Create API Client

Configuring Mindbreeze

Configuring the Index

Configuring the data source

Connection Settings

Crawling Constraints (Advanced Settings)

Performance Settings

Configuring the Principal Resolution Service

Connection Settings

Appendix

Commonly used Metadata

Download PDF

Download PDF