Overview
The Lyftron Provider for Humanity offers the most natural way to access Humanity data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Humanity data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Humanity data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to Humanity.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Humanity, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your Humanity connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click Humanity for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Humanity connection with Lyftron.
Profile=C:\profiles\Humanity.apip;ProfileSettings='InitiateOAuth=GetAndRefresh;OAuthClientId=[your_clientID];OAuthClientSecret=[your_client_secret];User=[your_Email_ID];Password=[your_password]';Key | Value | Field |
Connection Name | Enter your connection details | Required |
Profile | C:\profiles\Humanity.apip | Required |
InitiateOAuth | Your Humanity GetAndRefresh | Required |
OAuthClientId | Your Humanity Client Id | Required |
OAuthClientSecret | Your Humanity Client Secret | Required |
User | Your Humanity email_address | Required |
Password | Your Humanity password | Required |
Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron Humanity connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.
Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns.
Name | Type | Description |
Budget | Tables | Returns all budget settings for a given time period |
Business | Tables | Retrieves business details |
Companies | Tables | Get Companies |
CompanySettings | Tables | Returns company settings |
CustomFields | Tables | Retrieves all custom field (id, name, type, access and values) and Retrieves custom fields for one employee (custom field id, name, type, access, values and is_set). |
CustomReports | Tables | Retrieves a list of custom reports. |
DashboardOnNow | Tables | Returns a list of currently clocked employees and employees who are late for work. |
DatapointByDatatypeUniqueId | Tables | Returns datapoints for the given datatype |
Datapoints | Tables | Returns a specific datapoint as well as Returns a list of all datapoints for the given forecast |
EmployeeAvailabilityApprove | Tables | Request employee availability approval. |
EmployeeFutureAvailability | Tables | Get notices also get notice |
EmployeePositions | Tables | Return positions assigned to employee and Return information about specified position which is assigned to specified employee id |
EmployeeReport | Tables | Retrieves a list of employee's reports. |
Employees | Tables | Returns employee info. |
EmployeesPreclockin | Tables | Get employees preclockins (Default: Authenticated User) |
EmployeeWeeklyAvailability | Tables | Returns Weekly Availability for a user. |
ForecastByUniqueId | Tables | Returns a list of specific datatype by unique ID |
ForecastDatatypes | Tables | Returns a list of all forecast datatypes |
GroupPermissions | Tables | Retrieves group permissions for authenticated user. |
GroupReports | Tables | Retrieves a specific reports for all accounts that belong to the same group |
Leaves | Tables | Retrieves a list of vacations as well as Retrieves an individual vacation. |
LeaveTypeForEmployee | Tables | Retrieves a list of all leave types that are assigned to the specific employee |
LeaveTypes | Tables | Retrieves a list of all leave types |
Locations | Tables | Returns a list of all and individual Locations. |
Me | Tables | Returns information about requester. |
Message | Tables | Get single message |
Messages | Tables | Gets all messages for authenticated user |
Note | Tables | Returns schedule note |
Notes | Tables | Returns schedule notes |
Notices | Tables | Get notices also get notice |
NumberOfRequests | Tables | Returns a count of all requests |
PayrollRatecards | Tables | Get information about ratecards |
PayrollReport | Tables | Retrives a list of payroll reports by type |
PositionBreakRules | Tables | Returns a list of all Positions. |
Positions | Tables | Returns a list of all and individual Positions. |
Preclockins | Tables | Get all preclockins. |
ScheduleReport | Tables | Retrives a list of schedule reports betwen selected dates. |
ShiftApprove | Tables | Retrieves an individual shift that needs approval. |
ShiftBreaks | Tables | Gets breaks for all employees assigned to a given shift specified by the query parameter shift_id. |
Shifts | Tables | Returns a list of shifts. |
ShiftsClear | Tables | Clears the schedule. |
ShiftsFill | Tables | Fill Shifts using the Schedule wizard. |
ShiftsPublish | Tables | Publish Shifts |
Skills | Tables | Returns an array of all skills as well as Returns skill specified by id. |
TimeclockEvent | Tables | Returns a list of all timeclock events for a timeclock which ID is provided as a value of the {timeclock} parameter (70111593 in this example) |
TimeclockLocations | Tables | Returns all timeclock locations. |
TimeClocks | Tables | Retrieves an individual Clock Time and Returns a list of all timeclocks (filtered by given params). |
TimeClockStatus | Tables | Get Clock Status of Employee. Returns 'in' or 'out' if details param is 0. |
TimeclockTerminal | Tables | Clockin terminal management as well as Get a timeclock terminal. |
TimesheetsReport | Tables | Retrives a list of schedule reports betwen selected dates. |
Trade | Tables | Returns a single trade request |
Trades | Tables | Returns a list of trades. |
TrainingModuleComments | Tables | Retrieves an training module comments. |
TrainingModules | Tables | Returns a list of all training sections (parent group categories) as well as Returns an individual training section (parent group category) |
TrainingModuleSignature | Tables | Get employees digital signature. |
TrainingProgress | Tables | If user level perm is 2 or 3, retrieves training progress of all employees, otherwise retriever training progress of currently logged users (with perms 4 or 5). |
TrainingSections | Tables | Returns a list of all training sections (parent group categories) as well as Returns an individual training section (parent group category) |
WallMessages | Tables | Get wall mesages |
WeeklyTimeframeAvailability | Tables | Returns Weekly Timeframe Availability for a user |
WorkunitsDailyReport | Tables | Returns a list of worked units |
Advanced Settings
To view a detailed advanced settings options, go to Humanity Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.