Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 4.62 KB

installation.md

File metadata and controls

111 lines (80 loc) · 4.62 KB

Installation

[Up] [Top]

Table of Content

  1. Introduction
  2. Release Download
  3. Git Submodule
  4. Activate the extension
  5. Intellij IDEA Hints

Introduction

Depending on what you are setup and your plans, you can integrate this project in different ways.

  • If you want to use the extension in your project, then it is recommended to fork the repository and integrate it as described in Git Submodule.
  • If you do not want to use GitHub, proceed as described in Release Download.
  • If you just want to contribute a new feature or a bugfix to the extension, you will need to work with the Git Submodule. As an external developer you will still need a fork of the repository to create a Pull Request.

Release Download

Go to Release and download the version that matches you CMCC release version.

From the Blueprint workspace's root folder, extract the ZIP file into modules/extensions.

Continue with Activate the extension.

Git Submodule

From the Blueprint workspace's root folder, clone this repository or your fork as a submodule into the extensions folder. Make sure to use the branch name that matches your workspace version. A fork is required if you plan to customize the extension.

$ mkdir -p modules/extensions
$ cd modules/extensions
$ git submodule add https://github.com/CoreMedia/content-sync-example.git content-sync-example
$ git submodule init
$ cd content-sync-example
$ git checkout -b <your-branch-name>

Continue with Activate the extension.

Activate the Extension

In order to activate the extension, you need to configure the extension tool. The configuration for the tool can be found under workspace-configuration/extensions. Make sure that you use at least version 4.0.1 of the extension tool and that you have adjusted the <groupId> and <version> so that they match your Blueprint workspace.

Here you need to add the following configuration for the extensions-maven-plugin

<configuration>
  <projectRoot>../..</projectRoot>
  <extensionsRoot>modules/extensions</extensionsRoot>
  <extensionPointsPath>modules/extension-config</extensionPointsPath>
</configuration>

After adapting the configuration run the extension tool in workspace-configuration/extensions by executing:

$ mvn extensions:sync
$ mvn extensions:sync -Denable=content-sync-example

This will activate the extension. The extension tool will also set the relative path for the parents of the extension modules.

Provide Studio Settings

TODO

ingest.config.hosts[uat]=https://ingest.uat.myservice.coremedia.cloud/coremedia/api/ingest/v1/
ingest.config.tokens[uat]=<myuattoken>
ingest.config.syncGroups[uat]=Administratoren
ingest.config.hosts[prod]=https://ingest.myservice.coremedia.cloud/coremedia/api/ingest/v1/
ingest.config.tokens[prod]=<myprodtoken>
ingest.config.syncGroups[prod]=Administratoren
ingest.config.sync2wfs[partialSync]=StudioPartialSyncWorkflow

Upload Workflow

The synchronization workflow must be uploaded to use the feature. This can be done in the provided Docker Compose configuration for local development by adjusting file global/management-tools/docker/management-tools/src/docker/import-default-workflows. In this file, add a line for the StudioPartialSyncWofklow to variable DEFAULT_WORKFLOWS. With the very first Docker Compose start, the workflow will be uploaded automatically:

DEFAULT_WORKFLOWS="StudioSimplePublication:studio-simple-publication.xml \
ImmediatePublication:immediate-publication.xml \
StudioTwoStepPublication:studio-two-step-publication.xml \
ThreeStepPublication:three-step-publication.xml \
GlobalSearchAndReplace:global-search-replace.xml \
DeriveSite:/com/coremedia/translate/workflow/derive-site.xml \
Synchronization:/com/coremedia/translate/workflow/synchronization.xml
StudioPartialSyncWorkflow:/com/coremedia/blueprint/contentsync/workflows/studio-partial-sync-workflow.xml"

Alternatively, the workflow can be uploaded to a Workflow Server running locally by executing script modules/extensions/content-sync-example/workflow-server/script/deployWfs.sh.

Intellij IDEA Hints

For the IDEA import:

  • Ignore folder ".remote-package"
  • Disable "Settings > Compiler > Clear output directory on rebuild"