SaaShr
You will need the following to authenticate the SaaShr connector in an account:
The
username
for your SaaShr account.The
password
for your SaaShr account. For the first time setup, this will be set as your account password.The short
company name
for your SaaShr account.The URL of your SaaShr installation. For example, if you access SaaShr using
https://secure.saashr.com
then enterhttps://secure.saashr.com
.The
API key
of your SaaShr account.
If you do not have any of this information, please contact your SaaShr account manager.
First time setup
When installing the SaaShr connector for the first time you need to enter an additional setup password
. This will be provided by SaaShr as an auto-generated password that will be changed to the password
value on first installation. Further authentications of the same SaaShr account will then only require the password
that was entered on the first installation to be provided.
Cyclr setup
Account setup
You will be asked for the following values when installing the SaaShr connector within an account:
Value | Description |
---|---|
Base URL | The URL of your SaaShr installation. For example, if you access SaaShr using |
Company Name | The short company name for your SaaShr account. All methods will make calls using this company name. |
Username | The username for your SaaShr account. |
Password | The password for your SaaShr account. For the first time setup, this will be set as your account password for subsequent installations. |
Setup Password | Only required if this is your first time integrating with the API. This is an auto-generated password provided by SaaShr. |
API Key | The API key of your SaaShr account. |
Map custom fields
For methods that accept key and value pairs in an array, you might need to map custom fields. Some methods that require custom fields are Update Cost Center and Update Employee Pay Information. You can map these fields through the Cyclr console:
Go to the Edit Connector page for the SaaShr connector.
Under the Methods & Fields heading, find the method you want to map custom fields on.
Next to the Request Fields heading, select the red plus button.
In the Field Location box, enter the required custom field name and the field's index (as an integer) that you want to create in the format
{FieldName}.{FieldIndex}
. For example:gl_codes.123
.Enter a suitable Display Name for this field.
Optional: Provide a Description for this field.
Set the Date Type to Text for the field.
Select Create.
When you map a custom field for a method, the field is available in any steps that use the method. The value assigned to the field is stored in the custom field's array with the specified index. You can repeat the process for any key and value pair you want to add to the custom field's array.
Available fields
The Update Cost Center method allows this mapping for the following fields:
gl_codes
,custom_fields
andcontacts
.The Update Employee Pay Information only allows this mapping for
gl_codes
.