Configurable Fields

Configurable fields in TalentLink (TLK) are categorized either as List of Values (LOVs), Free Form Fields or User Data.

Each type is referenced by a name, a set of labels and a collection of entries. The name represents the question itself (e.g. "Are you married?"), the entry represents the collection of possible options for the question (e.g. "Yes" or "No") and the labels represent the translated values for the entries (e.g. "Oui" or "Non").

The ConfigurableFields web service allows the labels and the values to be inserted, amended or deleted. It is not possible to create, amend or delete a name.

LOVs represent questions where a choice may be selected. For example "Do you have a driving licence ?" where the answer of "Yes" or "No" may be selected.

Free Form Fields store the candidate's answer as a text field.

User data can only have one entry as it represents an input field. For example, the name may be "Phone Number" with only one entry of "Phone Number". The entry could have one label for each language.

 

Typical workflow

 

Use Case

The Configurable Field API is used to synchronise information between an external ERP system and TalentLink:

  • Configurable LOVs
  • Free Form Fields (FFFs)
  • User Data Fields.

 

Pre-condition - A user modifies an LOV entry/value in their external system and wants to have the same reflected in TalentLink.

Scenario

  1. START. When the LOV entry is added/removed/modified in Clients internal system, the new value to be updated in TalentLink via the web service operations.
  2. If the value is added/modified then Client should use the operation setLOVEntry to synchronise
  3. If the value is removed then Client should use the operation removeLOVEntry to synchronise.
  4. The Configurable LOV in TalentLink is added/removed/modified to match the value entries to that of Client Internal system. END.

Response Format

XML

SOAP METHODS

The method removeFreeFormFieldEntry is very similar to setting an entry except this time you just remove the value for example: changing "<fff-data value="Red" name="Colour">" to "Amber".

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
fff-data
FreeFormFieldEntryDto
The same type of input object as the one used in setFreeFormFieldEntry. In this operation only the "name" and "value" attributes are used, all other elements are ignored.
  required
Boolean
Is Free Form Field Entry required. True or False (default value is true.)
  dataFormat
String
Data Format of Free Form Field Entry. Possible values: TextArea, Text, Numeric, Integer, Date
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
operationResultDto
OperationResultDto
An output object with two fields: "success", a boolean indicating whether the given entry was completely removed from TalentLink (true) or if it was only marked as hidden (false), because of other entities / ad hoc reports depending on the entry.
  success
Boolean
Is operation successful
  details
String
Details if operation fails
The method removeLOVEntry is very similar to setting an entry except this time you just remove the value for example: changing "<lov-data value="Red" name="Colour">" to "Amber".

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
lov-data
ConfigurableLovDto
The same type of input object as the one used in setLOVEntry. In this operation only the "name" and "value" attributes are used, all other elements are ignored.
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
result
OperationResultDto
An output object with two fields: "success", a boolean indicating whether the given entry was completely removed from TalentLink (true) or if it was only marked as hidden (false), because of other entities / ad hoc reports depending on the entry.
  success
Boolean
Is operation successful
  details
String
Details if operation fails
The method removeUserDataEntry is very similar to setting an entry except this time you just remove the value for example: changing "<lov-data value="Red" name="Colour">" to "Amber".

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
lov-data
ConfigurableLovDto
The same type of input object as the one used in setUserDataEntry. In this operation only the "name" and "value" attributes are used, all other elements are ignored.
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
result
OperationResultDto
An output object with two fields: "success", a boolean indicating whether the given entry was completely removed from TalentLink (true) or if it was only marked as hidden (false), because of other entities / ad hoc reports depending on the entry.
  success
Boolean
Is operation successful
  details
String
Details if operation fails
The method setFreeFormFieldEntry is very similar to updating an entry. If the setting of the "value" and "names" properties are set to a non-existent values, then a new entry will be added. If it does exist, then it will update provided that a "newvalue" is provided.

Modifies an existing Free Form Field entry (not header!) according to the data contained in the given DTO, or creates a new one using these data if no entry can be found with the same name and value as the provided ones.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
fff-data
FreeFormFieldEntryDto
An input object
  required
Boolean
Is Free Form Field Entry required. True or False (default value is true.)
  dataFormat
String
Data Format of Free Form Field Entry. Possible values: TextArea, Text, Numeric, Integer, Date
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
fff-entry
FreeFormFieldEntryDto
An output object
  required
Boolean
Is Free Form Field Entry required. True or False (default value is true.)
  dataFormat
String
Data Format of Free Form Field Entry. Possible values: TextArea, Text, Numeric, Integer, Date
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”
With the method setFreeFormFieldLabels the "name" and the "value" of the FFF identify the FFF. A collection of entries made up of a language and a value are constructed.

In this example, we will update the language specific version of an entry.

The Free Form Field name is "Colour", which has entries of "Red", "Amber" and "Green". We want to change the French version of Red to Rouge.

The XML passed to the web service is:
<soapenv:Body> <ws:setFreeFormFieldLabels> <lov-labels name="Colour" overwrite="false" value="Red"> <label language="UK">Red</label> <label language="SW" /> <label language="PT" /> <label language="CS" /> <label language="EN" /> <label language="SK" /> <label language="KO" /> <label language="PL" /> <label language="JA" /> <label language="DE" /> <label language="FR">Rouge</label> <label language="SP" /> <label language="DN" /> <label language="NL" /> </lov-labels> </ws:setFreeFormFieldLabels> </soapenv:Body>

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
lov-labels
LovLabelsDto
An input object
  name
String
Name of the LOV entry this list of labels belongs to (optional).
  value
String
Value of the LOV entry this list of labels belongs to (optional).
  type
String
Type of the LOV entry this list of labels belongs to (optional).
  overwrite
Boolean
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false.
  label
LabelDto
Lov label
    language
String
Label language
    value
String
Label translation value

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
lovLabelsDto
LovLabelsDto
  name
String
Name of the LOV entry this list of labels belongs to (optional).
  value
String
Value of the LOV entry this list of labels belongs to (optional).
  type
String
Type of the LOV entry this list of labels belongs to (optional).
  overwrite
Boolean
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false.
  label
LabelDto
Lov label
    language
String
Label language
    value
String
Label translation value

The method setLOVEntry is very similar to updating an entry. If the setting of the "value" and "names" properties are set to a non-existent values, then a new entry will be added. If it does exist, then it will update provided that a "newvalue" is provided.

Modifies an existing configurable LOV entry (not header!) according to the data contained in the given DTO, or creates a new one using these data if no entry can be found with the same name and value as the provided ones.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
lov-data
ConfigurableLovDto
An input object
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
lov-entry
ConfigurableLovDto
An output object
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”
With the method setLOVLabels the "name" and the "value" of the LOV identify the LOV. A collection of entries made up of a language and a value are constructed.

In this example, we will update the language specific version of an entry.

The LOV name is "Colour", which has entries of "Red", "Amber" and "Green". We want to change the French version of Red to Rouge.

The XML passed to the web service is:
<soapenv:Body> <ws:setLOVLabels> <lov-labels name="Colour" overwrite="false" value="Red"> <label language="UK">Red</label> <label language="SW" /> <label language="PT" /> <label language="CS" /> <label language="EN" /> <label language="SK" /> <label language="KO" /> <label language="PL" /> <label language="JA" /> <label language="DE" /> <label language="FR">Rouge</label> <label language="SP" /> <label language="DN" /> <label language="NL" /> </lov-labels> </ws:setLOVLabels> </soapenv:Body>

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
lov-labels
LovLabelsDto
An input object
  name
String
Name of the LOV entry this list of labels belongs to (optional).
  value
String
Value of the LOV entry this list of labels belongs to (optional).
  type
String
Type of the LOV entry this list of labels belongs to (optional).
  overwrite
Boolean
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false.
  label
LabelDto
Lov label
    language
String
Label language
    value
String
Label translation value

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
lovLabelsDto
LovLabelsDto
  name
String
Name of the LOV entry this list of labels belongs to (optional).
  value
String
Value of the LOV entry this list of labels belongs to (optional).
  type
String
Type of the LOV entry this list of labels belongs to (optional).
  overwrite
Boolean
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false.
  label
LabelDto
Lov label
    language
String
Label language
    value
String
Label translation value
The method setUserDataEntry is very similar to updating an entry. If the setting of the "value" and "names" properties are set to a non-existent values, then a new entry will be added. If it does exist, then it will update provided that a "newvalue" is provided.

Modifies an existing User Data LOV entry (not header!) according to the data contained in the given DTO, or creates a new one using these data if no entry can be found with the same name and value as the provided ones.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
lov-data
ConfigurableLovDto
An input object
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
lov-entry
ConfigurableLovDto
An output object
  order
Integer
The order to set in the created/modified entry. Optional; if not provided a suitable value is calculated dynamically.
  hidden
Boolean
Is object hidden. True or False (default value is false.)
  newValue
String
Allows to provide data to update the Value of a LOV entry. For text based values
  newDataValue
BigDecimal
Allows to provide data to update the Value of a LOV entry. For decimal based values
  id
Long
The ID of created configurable object.
  name
String
The name by which the configurable field is known. For example: Colour
  value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”
With the method setUserDataLabels the "name" and the "value" of the LOV identify the LOV. A collection of entries made up of a language and a value are constructed.

In this example, we will update the language specific version of an entry.

The User Data name is "Colour", which has entries of "Red", "Amber" and "Green". We want to change the French version of Red to Rouge.

The XML passed to the web service is:
<soapenv:Body> <ws:setUserDataLabels> <lov-labels name="Colour" overwrite="false" value="Red"> <label language="UK">Red</label> <label language="SW" /> <label language="PT" /> <label language="CS" /> <label language="EN" /> <label language="SK" /> <label language="KO" /> <label language="PL" /> <label language="JA" /> <label language="DE" /> <label language="FR">Rouge</label> <label language="SP" /> <label language="DN" /> <label language="NL" /> </lov-labels> </ws:setUserDataLabels> </soapenv:Body>

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
lov-labels
LovLabelsDto
An input object
  name
String
Name of the LOV entry this list of labels belongs to (optional).
  value
String
Value of the LOV entry this list of labels belongs to (optional).
  type
String
Type of the LOV entry this list of labels belongs to (optional).
  overwrite
Boolean
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false.
  label
LabelDto
Lov label
    language
String
Label language
    value
String
Label translation value

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
lovLabelsDto
LovLabelsDto
  name
String
Name of the LOV entry this list of labels belongs to (optional).
  value
String
Value of the LOV entry this list of labels belongs to (optional).
  type
String
Type of the LOV entry this list of labels belongs to (optional).
  overwrite
Boolean
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false.
  label
LabelDto
Lov label
    language
String
Label language
    value
String
Label translation value