org.mule.modules

mule-module-jobvite

config

Namespacehttp://www.mulesoft.org/schema/mule/jobvite
Schema Locationhttp://www.mulesoft.org/schema/mule/jobvite/current/mule-jobvite.xsd  (View Schema)
Schema Version1.0
Minimum Mule Version3.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.
<jobvite:update-employees>
Changes the status of a group of Employees.

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/current/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 necessary 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
TypeNameDefault ValueDescriptionJava TypeMIME TypeEncoding
xs:string name Optional. Give a name to this configuration so it can be later referenced.
xs:string endpoint The Jobvite endpoint.

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <jobvite:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
apiKey The API key for the user String */* UTF-8
apiSecret Used for sensitive data encryption. Please refer to http://www.handshake-app.com/help/kb/api/api-authentication String */* UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <jobvite:config>
         <reconnect count="5" frequency="1000"/>
    </jobvite:config>
Reconnect Attributes
NameDefault ValueDescription
frequency 2000 Optional. How often (in ms) to reconnect
count 2 Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<jobvite:get-candidates>

Get information about candidates.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
candidateState Optional. CandidateState String */* UTF-8
dateStart Optional. DateStart Date */*
dateEnd Optional. DateEnd Date */*
Connection Parameters
This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey Optional. The API key for the user String */* UTF-8
apiSecret Optional. Used for sensitive data encryption. Please refer to http://www.handshake-app.com/help/kb/api/api-authentication String */* UTF-8
Returns
Return Type Description
Iterable<CandidateType> List of candidates

<jobvite:get-new-hires>

Get information about new hires.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
dateStart Optional. DateStart Date */*
dateEnd Optional. DateEnd Date */*
Connection Parameters
This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey Optional. The API key for the user String */* UTF-8
apiSecret Optional. Used for sensitive data encryption. Please refer to http://www.handshake-app.com/help/kb/api/api-authentication String */* UTF-8
Returns
Return Type Description
Iterable<NewHireType> List of candidates

<jobvite:update-candidates>

Changes the status of a group of candidates.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
Connection Parameters
This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey Optional. The API key for the user String */* UTF-8
apiSecret Optional. Used for sensitive data encryption. Please refer to http://www.handshake-app.com/help/kb/api/api-authentication String */* UTF-8
Child Elements
NameDefault ValueDescriptionJava Type
<jobvite:candidate-updates> 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") Map<String, String>

<jobvite:update-employees>

Changes the status of a group of Employees.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
companyId The id of the company. String */* UTF-8
importerEmail The mail of the importer. String */* UTF-8
reportEmail The report email. String */* UTF-8
doNotSyncOnWarnings false Optional. Do not sync on warnings flag. boolean */*
overwriteEmployeeNamesAndEmail false Optional. Overwrite employee names and email flag. boolean */*
Connection Parameters
This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey Optional. The API key for the user String */* UTF-8
apiSecret Optional. Used for sensitive data encryption. Please refer to http://www.handshake-app.com/help/kb/api/api-authentication String */* UTF-8
Child Elements
NameDefault ValueDescriptionJava Type
<jobvite:employee-updates> A Map for every employee that is going to be updated. List<Map<String, Object>>
Returns
Return Type Description
String the status of the request.

Message Sources

Transformers