How to use IBM App Connect with Factorial HR

Factorial HR is a Human Resources (HR) software that helps small and medium-sized businesses streamline HR administration. With Factorial HR, you can track each employee's work day and productivity, log working hours, keep track of remaining time off, and schedule employee shifts.

Availability:

App Connect Enterprise as a Service connector
Local connector in containers (Continuous Delivery release) 12.0.12.2-r1 or later
Local connector in containers (Long Term Support Cycle-2 release)

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Factorial HR

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) or flow editor. If necessary, work with your Factorial HR administrator to obtain these values.

Factorial HR connection fields:

OAUTH 2.0 AUTH CODE: Tip: Authorize connection to Factorial HR by signing in to your account.

BASIC OAUTH: Server URL: Select the URL for the API server that makes runtime calls.
Note: https://api.factorialhr.com is the default server URL.; Application client ID: Specify the unique client identifier to use for authentication.; Application client secret: Specify the unique client secret to use for authentication.; Refresh token: The refresh token that is generated from the application client ID and client secret.; Access token: The access token that is generated from the application client ID and client secret.; Allow self-signed certificates: Set to true or false. Set to true if you want to be able to accept self-signed certificates that are trusted and used only in a nonproduction environment. The default is false.; Override server URL: Required if you want to connect to an endpoint in a private network by using the private network client, or if you want to override the server URL. Specify an override value for the host and port for the connector in the format <http or https>://<host_name>:<port>. If you are not using the private network client or do not require an override, leave this field blank.

To obtain the connection values for Factorial HR, see Obtaining connection values for Factorial HR.

To connect to a Factorial HR endpoint from the App Connect Designer Applications and APIs page for the first time, expand Factorial HR, then click Connect. For more information, see Managing accounts.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

General Considerations

Before you use App Connect Designer with Factorial HR, take note of the following considerations:

You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and Actions

Factorial HR events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Factorial HR actions

Your flow completes these actions on this application.

Object	Action	Description
Absences	Create absence	Creates an absence record
Absences	Retrieve absence details	Retrieves the details of absences
Absence types	Retrieve absence type details	Retrieves the details of the absence types
Attendances	Create employee clock in	Creates a shift (time registry) for the current user with the clock in time of the request
	Create employee clock out	Updates a shift (time registry) for the current user with the clock out time of the request
	Retrieve shifts	Retrieves the shifts (time registries) from a company
Employees	Create employee	Retrieves a collection of contacts
	Retrieve employees	Retrieves a list of employees (only admins can see all the employees' information)
	Retrieve employee by ID	Retrieves employee details using employee ID
	Update employee	Updates employee information
Tasks	Create task	Creates a task
Tasks	Retrieve tasks	Retrieves a list of tasks

Examples

Dashboard tile for a template that uses Factorial HR

Use templates to quickly create flows for Factorial HR

Learn how to use App Connect templates to quickly create flows that complete actions on Factorial HR. For example, open the Templates gallery, and then search for Factorial HR.

Learn more

Use IBM® App Connect to build flows that integrate with Factorial HR.

Read the blog in the IBM Community to learn how to create time entries in Toggl Track for each time registry added in Factorial HR. The blog also explains how to create an event in Google Calendar for each applied absence in Factorial HR. Click Read the blog to go to the blog.

Read the blog