Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GraFx Studio] Sitecore Content Hub - Connector #465

Merged
merged 8 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/GraFx-Studio/connectors/connector-sitecore-content-hub/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Media Connector for Sitecore Content Hub

| | Connector Type |
| --- | --- |
| | Built-in |
| :fontawesome-regular-square-check: | Built by CHILI publish |
| | Third party |

[See Connector Types](/GraFx-Studio/concepts/connectors/#types-of-connectors)

## Installation

[See Installation Through Connector Hub](/GraFx-Studio/guides/connector-hub/)

## Configuration

### Base Configuration

Your instance of the Connector needs to know which Sitecore Content Hub instance it should communicate with and how to authenticate.

Once installed, navigate to the Connector overview and select **Sitecore Content Hub**. Start with **Configuration**.

![screenshot-full](sch06.png)

![screenshot-full](sch01.png)

Consult your Sitecore System Admin to obtain the correct values for the fields.

### Authentication

Select your type of authentication. Currently, only OAuth 2.0 is supported.
BramVerniest marked this conversation as resolved.
Show resolved Hide resolved

![screenshot](sch02.png)

You will need specific credentials from your Sitecore Content Hub installation to set up the connector:

- **Client ID** and **Client Secret**: These are customer-specific credentials provided by the Sitecore Admin when creating integrations within Sitecore.
BramVerniest marked this conversation as resolved.
Show resolved Hide resolved
- **Username** and **Password**: User-specific credentials for authentication.
- **Token Endpoint**: Developer-oriented settings available in Sitecore documentation. These settings are generic for all Sitecore clients.
- **Scope**: Consult your Sitecore Admin to determine the appropriate scope.

You can configure separate authentication for machine-to-machine and browser use cases or use the same setup for both.

![screenshot-full](sch04.png)

Consult your Sitecore System Admin for assistance in configuring these fields.

### Server Authentication

The credentials used for machine-to-machine authentication determine the governance on assets in automation workflows.

This means that if the credentials restrict access to specific assets, only those assets will be available during batch processing.

### Browser Authentication or Impersonation

GraFx Studio accesses assets available in the DAM via impersonation, where the credentials configured for the connector determine which assets are visible to the user in the template.

**Impersonation** is the process of granting GraFx Studio users access to the DAM system using pre-configured credentials. This ensures seamless integration while respecting the DAM's security and governance rules.

For example:
- A marketing team uses GraFx Studio to connect to Sitecore Content Hub. The admin configures the connector with specific credentials.
- Based on these credentials, users can only access assets they are authorized to view according to Sitecore's governance policies.

## Using Assets from Your Sitecore Content Hub System

### Place Assets in Your Template

- Select the Sitecore Content Hub Connector.

![screenshot-full](sch07.png)

![screenshot-full](sch08.png)

![screenshot-full](sch09.png)

Depending on the configuration, you may need to authenticate.

![screenshot-full](sch10.png)

- Once authenticated, Sitecore assets behave like any other asset in GraFx Studio.

### Image Variables

When using [image variables](/GraFx-Studio/guides/template-variables/assign/#assign-template-variable-to-image-frame), you will see the same list of assets when selecting an image.

![screenshot-full](var01.png)

### Configuration Options

#### Introduction

To filter the assets suggested to template users, you can use categories, keywords, or other search parameters.

Sitecore Content Hub supports search queries through its query language. Consult the [Sitecore Documentation](https://doc.sitecore.com/ch/en/developers/cloud-dev/linq-queries.html) or your Sitecore Content Hub Administrator for guidance.
BramVerniest marked this conversation as resolved.
Show resolved Hide resolved

#### How To

Queries are set at the variable level.

Set the query value in the connector settings.

![screenshot-full](var02.png)

For more dynamic queries, you can use [variables](/GraFx-Studio/concepts/variables/), [actions](/GraFx-Studio/concepts/actions/), and [GraFx Genie](/GraFx-Studio/concepts/grafx-genie/) to automate and refine your queries.

#### Other Configuration Options

- **Show Only Approved Assets**: Displays only assets that have been approved in Sitecore Content Hub.
- **Locale**: Filters assets by region or language.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,8 @@ nav:
- 'Manage User interfaces': 'GraFx-Studio/guides/manage-user-interfaces/index.md'
- 'Connectors':
- 'GraFx Media': 'GraFx-Studio/connectors/connector-grafx-media/index.md'
- 'Acquia DAM': 'GraFx-Studio/connectors/connector-acquia-dam/index.md'
- 'Acquia DAM': 'GraFx-Studio/connectors/connector-acquia-dam/index.md'
- 'Sitecore Content Hub': 'GraFx-Studio/connectors/connector-sitecore-content-hub/index.md'
- 'Plugins':
- 'Conversion': 'GraFx-Studio/convert/intro/index.md'
- 'for Adobe® InDesign®': 'GraFx-Studio/convert/Adobe-InDesign/index.md'
Expand Down
Loading