LOV

LOV in TalentLink (TLK) represent fields which are drop downs with list of values. They are further categorized into three types SYSTEMFIXED, SYSTEMCONFIGURABLE and CONFIGURABLE.

  • SYSTEMFIXED: System LOVs, non-editable, non-configurable. Administrators can only deactivate (or reactivated internally) values from these LOVs. These are available in Standard Field Activation page from Configuration (in TLK)
  • SYSTEMCONFIGURABLE: System LOVs, editable, non-configurable. Administrators can only deactivate (or reactivated internally) values from these LOVs. These are available in Configurable Fields Management page from Configuration (in TLK)
  • CONFIGURABLE: User defined LOVs, configurable. The definition of these LOVs are entirely done in TLK application by the end-users / LSA / GSA users. Values can be added/amended/deleted.

    Configurable fields are further categorized into below two:

    1. Configurable LOV: List of drop down values having key value pair.
    2. Configurable Free form field: List of free form field values which could have a mix of data formats that each accepts i.e. Text, Integer, Numeric, Date, and Text Area.

    Note:
    Data format becomes very relevant when providing values back into TLK in any of the web service where the LOV are referenced.
    This service does not include LOV's that are created in Forms & Questionnaires.

Use Case

The LOV WS is used to retrieve list of LOV name(s) and it's values with respective Id's which could be used in lookup's and synchronisation of list of values between an external ERP system and TalentLink.

 

Pre-condition - LOV fields with list of values already configured in TalentLink to be retrievable by end user.

Scenario

  1. START. Use LOV WS operation getLovNames to retreieve LOV name(s), store locally, the names that are to be used for lookups and synchronised.
  2. Use LOV WS operation getLovsWithValues to retreieve list of values for a given list of name(s) or use operation getLovWithValuesByName to retreieve list of values for a single LOV name.
  3. If the LOV is of type CONFIGURABLE in TLK and value is added in Customer system, Customer should use Configurable Fields web service and operation setLOVEntry to extend.
  4. If the value to be modified, Customer to lookup locally against TLK LOV name and value, use respective TLK name and value to update using Configurable Fields web service and operation setLOVEntry to amend.
  5. Repeat step 1 once a day(best practice) or as per requirement to ensure synchronisation is seamless and up-to-date. END.

Response Format

XML

SOAP METHODS

https://api3.lumesse-talenthub.com/HRIS/SOAP/LOV?wsdl
https://apiapac.lumesse-talenthub.com/HRIS/SOAP/LOV?wsdl

The method getLovNames allows to retrieve all LOV name(s) that are configured for Customer application.

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
lovTypeCategory
LovTypeCategory
 [mandatory] List of LOV category types allowed to be passed. SYSTEMFIXED SYSTEMCONFIGURABLE CONFIGURABLE

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
lovNames
List
 List of LOV's
  lovName
String
 The name by which the LOV field is known. For example: Job Function
  order
Integer
 The order by which the LOV fields are sorted.
  lovChildren
LovDescendantDto
 Group containing collection of Lov values that are configured by the system administrator.
    lovId
Long
 Internal TLK Id of the LOV value.
    lovName
String
 Name of the LOV.
    translation
String
 Translated name of the LOV value for the language specified.
    dataValue
BigDecimal
 This is only applicable when LOV is of type 'Configurable LOV' and is the value part of the KeyValuePair.
    dataType
DataType
 DataType of LOV Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN
    lovValue
String
 Default name of the LOV value in english.
    dataFormat
String
 This is only applicable when LOV is of type 'Configurable Free Form Field'. this specifies what kind of format is accepted for each value. Possible values: TextArea, Date, Integer, Numeric, Text
  lovId
Long
 TalentLink internal Id set for the LOV field.
The method getLovWithValuesByName is used to retrieve list of values for a specific LOV name. Unlike the method getLovsWithValues, which can be used to retrieve values for list of LOV name(s). Structure of the response from this method is simple in format when compared to response of method getLovsWithValues.

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
lovName
String
 Lov name for which children list will be obtained
langCode
LangCode
 Possible values: Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
lovWithValues
List
 Collection of Lov values that are configured by the system admninistrator.
  lovId
Long
 Internal TLK Id of the LOV value.
  lovName
String
 Name of the LOV.
  translation
String
 Translated name of the LOV value for the language specified.
  dataValue
BigDecimal
 This is only applicable when LOV is of type 'Configurable LOV' and is the value part of the KeyValuePair.
  dataType
DataType
 DataType of LOV Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN
  lovValue
String
 Default name of the LOV value in english.
  dataFormat
String
 This is only applicable when LOV is of type 'Configurable Free Form Field'. this specifies what kind of format is accepted for each value. Possible values: TextArea, Date, Integer, Numeric, Text
The method getLovsWithValues is used to retrieve list of values for provided list of LOV name(s).

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
lovNames
List
 [mandatory] Can specify a list of LOV Name(s)
langCode
LangCode
 Possible values: Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
lovWithValues
List
 A collection of LOV names and thier values defined by the system administrator.
  lovName
String
 The name by which the LOV field is known. For example: Job Function
  order
Integer
 The order by which the LOV fields are sorted.
  lovChildren
LovDescendantDto
 Group containing collection of Lov values that are configured by the system administrator.
    lovId
Long
 Internal TLK Id of the LOV value.
    lovName
String
 Name of the LOV.
    translation
String
 Translated name of the LOV value for the language specified.
    dataValue
BigDecimal
 This is only applicable when LOV is of type 'Configurable LOV' and is the value part of the KeyValuePair.
    dataType
DataType
 DataType of LOV Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN
    lovValue
String
 Default name of the LOV value in english.
    dataFormat
String
 This is only applicable when LOV is of type 'Configurable Free Form Field'. this specifies what kind of format is accepted for each value. Possible values: TextArea, Date, Integer, Numeric, Text
  lovId
Long
 TalentLink internal Id set for the LOV field.

version 67 as of 2 years ago by Lukasz Krzywicki