CV-partner library for Enonic XP

This library is an integration to Enonic XP application code for persons, referred to as employees, registered in CV-partner. This enables the ability to import employees and their profiles in CV-partner into Enonic XP node library and create content for these respectively. This library create and send events which operate on new and modified data from CV-partners user APIs.

Installation

To install this library you need to add a new dependency to your app's build.gradle file.

Gradle

repositories {
  maven { url "https://repo.itemtest.no/releases" }
}

dependencies {
  include "com.enonic.xp:lib-common:${xpVersion}"
  include "com.enonic.xp:lib-event:${xpVersion}"
  include "com.enonic.xp:lib-node:${xpVersion}"
  include "com.enonic.xp:lib-repo:${xpVersion}"
  include "com.enonic.xp:lib-task:${xpVersion}"
  
  include "no.item:lib-xp-cvpartner:0.0.4"
}

TypeScript

To update the version of enonic-types in package.json using npm, run the following command:

npm install --save-dev @item-enonic-types/lib-cvpartner

Usage

This library contains a task ("cvpartner-import") that can be run in the main.ts of another application:

run(
  {
    user: {
      idProvider: "system",
      login: "su",
    },
  },
  () => {
    submitTask({ descriptor: `${app.name}:cvpartner-import` });
  }
);

You can select an employee in your Enonic XP application code with a CustomSelector:

<input name="cvPartnerEmployeeId" type="CustomSelector">
  <label i18n="employee.cvPartnerEmployeeId">Profile from CV-Partner</label>
  <occurrences minimum="0" maximum="1"/>
  <config>
    <service>cv-partner-employee</service>
  </config>
</input>

*In Enonic XP you may listen to the events emitted from this library by defining a `listener: *

listener<CVPartnerEmployeeNode & Node>({
  type: "custom.cvpartner.*",
  callback: (event) => {
    // Handle event
  },
});

Events

Events that can be emitted from this library:

• custom.cvpartner.create
• custom.cvpartner.modify
• custom.cvpartner.image

Configuration

Add the following configuration to you XP_HOME/config/com.mycompany.cfg-file:

cvPartnerBaseUrl=https://<mycompany>.cvpartner.com
cvPartnerApiKey=<api key>

• cvPartnerBaseUrl, Base url to fetch data about cv-partner employee profiles. referenced app.config.cvPartnerBaseUrl
• cvPartnerApiKey key identifier used to authenticate request for endpoints such as cvPartnerBaseUrl/{path} + . referenced app.config.cvPartnerApiKey

Building

To build the project, run the following command

enonic project build

You will find the jar-file at ./build/libs/lib-xp-cvpartner-x.x.x.jar

Deploy locally

Deploy locally for testing purposes:

./gradlew publishToMavenLocal

Deploy to Maven

./gradlew publish -P com.enonic.xp.app.production=true