Getting started with Sympa HR

This article explains how you integrate and get started with the Sympa HR - Oneflow integration.

In Oneflow

Activate the Sympa HR Integration

1. Log in to Oneflow as an administrator and navigate to Marketplace.
   
    
2. Scroll down to Sympa, click to enter it, and then tap on on Enable.
   
    
3. Copy the API token that is generated and save it securely, then click Close. The token is only shown once and is needed both in the Sympa HR settings and by your Sympa consultant.
   
    
4. Note down the Workspace ID (Admin > Workspaces, open the workspace and find the ID in the left pane) and the Template ID of the published Sympa template. You need both when mapping the templates later.

In Sympa HR

Configure Oneflow Settings

1. Go to Settings > Features > eSign and add a new electronic signature. Enter a Name (for example Oneflow) and select Sympa eSign API as the Type.
2. Fill in the connection details and click Create:
   • Service provider URL: https://integrations.oneflow.com/api/sympa/contracts/create
   • Integration Key: the API token generated in Oneflow
   • Sympa URL: https://www.Sympahr.net/api/esigning/integration/notification
   • Secret Key: leave empty until your Sympa HR consultant provides the value
3. Go to Settings > Pages, expand the Contract formbase and click Content. In Contract - Data field settings > Contracts, click the Edit icon, scroll to Electronic signing settings, select the electronic signature you created and an Identification method, then save.
4. Create a Sympa HR document template under Settings > Pages > Contract > Document templates, and map it to your Oneflow template by inserting workspace_id=<value> and template_id=<value> in the template file.

Create a contract template

To create a Sympa HR contract template:

1. Log in to Sympa HR with the admin credentials.
2. Go to Settings > Pages > Contract > Document templates.
3. Click “+” in the top-right corner of the section.
4. Fill in the Document template fields.

• Template name: descriptive name of your contract template.
• Supported formats: select the Electronic document checkbox and, optionally, printable formats.
• Document template: upload the contract template file created by Sympa HR as per your business needs.

Map Sympa HR templates with Oneflow templates

To map the Sympa HR contract template (uploaded in the step above) with the Oneflow contract template, you will need your Oneflow Workspace ID and the Template ID (created in steps 4 and 5 of the Oneflow setup part).

1. Navigate to the Sympa HR contract template: Settings > Formbase > Contract > Document template report settings and click a file name you want to edit. This will start an automatic download. You will then be able to open it locally.

2. The workspace and the template IDs need to be placed inside the Sympa template for integration to work. 
   The workspace and template IDs should appear as follows:
   workspace_id=<value>   template_id=<value>

   NOTE You might want to hide these IDs in your template if you don't want participants of the contract to see them. To hide these IDs, you can change the font color of the text to match the background of the document. To locate these values, you can highlight the document content by pressing CTRL+A on your keyboard.

3. Insert the correct workspace_id and template_id values.
   Example:
   workspace_id=397997   template_id=1962420
4. Upload the template back to the Document template report settings as explained in the previous step.

The Oneflow integration is now active! Learn how to create a contract here.

Specify contract custom properties

At this stage, you can specify a custom property that will allow you to create contracts in Oneflow as a draft. Once set, Oneflow will create all contracts as drafts for that organization.

To set up custom properties:

1. On the same Contract - Data field settings page, scroll down to the Custom properties section.
2. Under the Property 1 fieldset, in the JSON alias field, type is_draft and set the Value to true. When a contract is sent from Sympa HR to Oneflow, it will be in a draft version. It will allow you to adjust the contract in Oneflow before sending it to the candidate.

is_draft
If this custom property is set to true, when a contract is sent from Sympa HR to Oneflow, it will be saved as a draft version. This allows you to modify the Oneflow contract to suit your needs before sending it to the candidate.
If this property is set to false, the contract will be automatically sent to the candidate when created through Sympa.
If there are internal approvers in the Oneflow Sympa template, and this property is set to true, the contract will first be sent to the internal approvers for the internal approval workflow.

creator_inherit_role_from_template
If this custom property is set to true, then the creator of the contract should inherit the contract roles and permissions from the template settings whenever a contract is sent from Sympa HR to Oneflow.

my_party_signatory
Set this custom property to true to make sure every recruiter is added as a signatory in the contract when a contract is sent from Sympa HR to Oneflow.

send_after_draft_approval
When there are internal approvers in the Sympa Oneflow template, if this custom property is set to true, the contract will automatically be sent to the candidate after the internal approvers have approved it. If set to false, the contract must be manually sent to the candidate through the Oneflow application after internal approval. The default value is true.