mule-module-jobvite

1.1

Namespace	http://www.mulesoft.org/schema/mule/jobvite
Schema Location	http://www.mulesoft.org/schema/mule/jobvite/1.0/mule-jobvite.xsd
Version	1.0
Minimum Mule Version	3.2

Module Overview

Jobvite can be used to get information about candidates and new hires for your company jobs.

Summary

Configuration
<jobvite:config> Configure an instance of this module

Message Processors
<jobvite:get-candidates> Get information about candidates.
<jobvite:get-new-hires> Get information about new hires.
<jobvite:update-candidates> Changes the status of a group of candidates.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:jobvite="http://www.mulesoft.org/schema/mule/jobvite"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/jobvite
               http://www.mulesoft.org/schema/mule/jobvite/1.0/mule-jobvite.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	apiKey		The API key issued by Jobvite.
xs:string	apiSecret		The secret for this service, issued by Jobvite.
xs:string	endpoint		The Jobvite endpoint.

Message Processors

<jobvite:get-candidates>

Get information about candidates.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
candidateState		Optional. CandidateState
dateStart		Optional. DateStart
dateEnd		Optional. DateEnd

Child Elements

Return Payload

List of candidates

<jobvite:get-new-hires>

Get information about new hires.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
dateStart		Optional. DateStart
dateEnd		Optional. DateEnd

Child Elements

Return Payload

List of candidates

<jobvite:update-candidates>

Changes the status of a group of candidates.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<jobvite:candidateUpdates> Map that for every entry, has for key the applicationId of the candidate (`RecordInfoType` -> id), and for value the new status for it (`RecordInfoType` -> status). Each entry it is a candidate update. Example of an entry: CandidateType candidate = some candidate; map.put(candidate.getCandidateRecordInfo().getId().get(0).getIdValue().get(0).getValue(), "Offer Accepted")