Equus Software

Equus Ecosystem

The Cost Estimates API is an API subscription that enables Cost Estimate and What-If Cost Estimate to be created, calculated, and exchanged between AssignmentPro and other systems.



Note - Cost…

Cost Estimates API - Overview

The Equus Platform supports integrating with other systems by leveraging a new industry standard API.  The API accepts requests and sends responses in JSON and leverages JWT (JSON Web Tokens)…

Equus Platform API - Overview

The API Subscription Manager screen at the system level allows for API Subscribers to be created. It will default to show the API Subscribes tab. In order for users to access…

AssignmentPro API - Creating API Subscriber and generating authentication credentials

The security role(s) that should have the ability to configure the API functionality must have access to the &lt;API Subscription Manager&gt; screen.   On the Security Role Maintenance screen, grant a

AssignmentPro API - How to configure security role to access API Subscribers page

It is possible to regenerate both the GUID and Secret Key if the Secret Key is lost or compromised. Regeneration should only be done with the involvement of a technical resource (more…

AssignmentPro API - How to regenerate authentication credentials

Calls to the API are secured using JSON Web Tokens, which utilize the GUID and Secret Key configured in the API Subscription Manager screen. JWTs are constructed programmatically by external…

AssignmentPro API - How to access API technical documentation

While the Standard API is designed to enable getting information in and out of the Equus Platform in a consistent, structured manner, the systems that are making requests against it…

Equus Platform API - Webhook Overview

API Requests support using query string parameters in order to specify the type of value being provided in POST or PATCH requests, or the desired type of value to be…

AssignmentPro API - Lookup Fields

Special logic has been built in for country fields, so that the Display Name, 2 character, or 3 character ISO code can be provided in create or update requests without…

AssignmentPro API - Country Fields

Custom Fields are supported in the API. When enabled in AssignmentPro, Custom Fields will be available as attributes on their parent objects, like Assignment or Employee, for GET, POST and…

AssignmentPro API - Custom Fields

The API Subscription Manager screen allows for the configuration of System Profiles for Webhooks so that the parameters required by target systems to authenticate messages can be input on the screen.

AssignmentPro API - How to create a Webhook System Profile

Boolean fields will always return a non-string “true” or “false” in responses, and the API can accept different variations of true or false for create or update requests without needing…

AssignmentPro API - Boolean Fields

AssignmentPro API enables the exchange of information between AssignmentPro and other systems using API. The API Event History screen can be used to view log of each API event in…

AssignmentPro API - Viewing API Event History

API Overview

For clients using AIRINC data, a new Equus delivered API has been created that enables streamlined receipt and management of that data. This capability is built into the Equus Platform…

AIRINC API - Overview

Equus offers a feature that simplifies the receipt and management of Mercer data for existing clients. Use of this feature requires the following:

Client to have a subscription with Mercer…

Mercer API - Overview

Data API

GET, POST, DELETE and PATCH requests to the Document endpoints are supported. Requests made to the Document endpoints require a Document ID so that Assignment Documents can be retrieved on…

Documents API - Assignment Documents

External systems can now interact with Documents that are stored in AssignmentPro, or create new Documents, via API requests. Regardless of which Document endpoint is being used, there are certain…

Documents API - Overview

Only GET requests to these endpoints are supported. Requests made to the Document endpoints require a Document ID so that Compensation Documents can be retrieved on an individual basis.
Support…

Documents API - Compensation Documents

Documents API

The People API is an API Subscription that enables Employee and Assignment information to be exchanged between AssignmentPro and other systems. In addition to Employee and Assignment, Dependents, Spou

People API - Overview

Initiations can be created via API requests using the People API Subscription. 
To use this functionality, tick the Allow Authorization Create from Existing Assignment checkbox on Authorization Config

People API - Initiations

There are four new endpoints available in the People API Subscription that enable searching for Employees or Assignments based on alternate identifiers. Previously, the only ID available to use in…

People API - How to search for Assignments and Employees based on  alternate identifiers

Assignment package batches in AssignmentPro can be created through a POST request. If there are assignment packages processed through the POST request that have failed, it is recommended to configure

People API - QWF Configuration for Assignment Package Batch Status

People API

AssignmentPro supports identity synchronization using a user API service called SCIM2. Existing user accounts can now be synchronized with client's corporate identity provider (IdP) to ensure access t

SCIM API User Synchronization - Overview

AssignmentPro supports identity synchronization using a user API service called SCIM2.  Internal users can now be directly created in AssignmentPro through the SCIM API.  This means that users will no

SCIM API User Synchronization - Creating a new internal user

SCIM Overview - updates to user information and deprovisioning

SCIM Overview - changes in roles

 
What updates are covered?

user First Name and user Last Name

user email

user…

SCIM API User Synchronization - Updating and deprovisioning internal users

To configure the SCIM2 API to be used, integration must be established on the client-side Identity Provider (IDP). This can be done by using built-in integration such as on AzureAD…

SCIM API - How to create a User Profile template

To configure the SCIM2 API to be used, integration must be established on the client-side Identity Provider (IDP). This can be completed by using built-in integration such as on AzureAD…

SCIM API - How to view a created Group template

SCIM API

You can create error notification rules for integration events that will be triggered on a configured monitoring frequency. Notifications will be sent via email.
To set up an integration error…

Creating an Integration Error Notification and Rules

📹 Video: //player.vimeo.com/video/493330747
This video gives an introduction to the different standard integration methods that Equus can provide with AssignmentPro which include: 


Single Sign On o

AssignmentPro Integrations Overview

The user manual addresses how to configure AssignmentPro™ to launch Questionnaires from the Mobile Employee Experience (MEE), and how to manage the status of those Questionnaires for an assignment.
Th

AssignmentPro Integration with Questionnaires - Overview

Use the following process to configure AssignmentPro to launch and receive data back from the Questionnaire application. Prerequisites: • The MEE is licensed and configured for use by employees. The…

AssignmentPro Integration with Questionnaires Process

This assumes the process for assigning Questionnaires to employees is automatic based on an update to the assignment Questionnaire’s Status. The checklist must be specific to the Questionnaire Screen

AssignmentPro Integration with Questionnaires Sample Checklist #2 – Update Questionnaire

Navigation: Assignments Tab
Assignment Management Menu Group
Questionnaires Menu
The Questionnaires screen allows questionnaire reviewers maintain the Status of Questionnaires that have been filled by

Manage Questionnaire Statuses

This assumes the process for assigning Questionnaires to employees is a manual one. In other words: an internal user determines when the employee needs to fill a Questionnaire.
The checklist…

AssignmentPro Integration with Questionnaires Sample Checklist #1 – Complete Questionnaire

AssignmentPro Integration with Questionnaires

This user manual addresses how to configure AssignmentPro™ to launch Questionnaires or Tax Organizers from the Mobile Employee Experience (MEE) or the Internal - Resource Tasks and Notifications widge

Connecting AssignmentPro to Equus Applications - Overview

Use the following process to configure AssignmentPro to launch and receive data back from the Questionnaire or Tax Organizer applications.
Prerequisites:

If configuring questionnaires for employee us

Connecting AssignmentPro to Equus Applications - Process

Connecting AssignmentPro to Equus Applications

Service types are used to join services within policies, service orders, vendors and integration data sets together.  
Equus standard service types are provided with AssignmentPro.  Additional custom

What is a service type?

To connect AssignmentPro to a vendor on the Ecosystem, a Vendor Hub ID should be added in the vendor's record (system level configuration), on the security tab:

The Vendor's hub…

Vendor's Hub ID and Instance ID - Ecosystem configuration

There are two ways that vendors can connect to the Ecosystem:

API
Hub Connector

 




API









This is the best type of connection.  Why?

Data transfer is automated

Data transfer is instant,…

API versus Hub Connector Methods - what's the best way for vendors to connect to the Ecosystem?

How to setup and Ecosystem connection

Storing vendors in AssignmentPro allows for quick and easy ways to allocate payments and vouchers for assignments. This user manual addresses how to manage vendors in AssignmentPro.

Managing Vendors - Overview

Overview
General




Payments


Addresses




Services Provided


Bank Accounts




Service Orders


Documents on File




Referral Agreements


Contracts




Service Areas Coverage


Data Feed Availa

How to create and maintain vendors

Allocate where the vendor performs services. This allows for you to save the vendor to a specific region in order to perform specific searches by location. You can be as…

Service Area

There are two sections, one to maintain Contacts, the other is to maintain Service Agents.
  
Contacts: The contacts are the vendor contacts which is the main source of contact you…

Vendor Contacts & Agents

Portal Security Roles Allowed for this Vendor
Maintain Security Roles available to assign to vendor users that need to access the system via the vendor portal. Roles identified in this…

Managing Vendors - Security

Managing Vendors

The Employee Expense Entry is a simple way for assignees to submit expense reports using the ASSIGNMENTPRO™ Portal. Assignees on either Domestic or International assignments can login to the ASSIGNMEN

Portal Employee Expense Entry - Overview

The following configuration must be set-up to utilize the employee expense entry system.Portal Menu Configuration
The following pages need to be added with “External Employee” menu item user type acce

Employee Expense Entry Configuration

An internal user to AssignmentPro can view an employee expense report as the employee views the report online.  By selecting the Employee View link for a particular voucher on the…

Processing Employee Expense Entry Reports

The voucher approval process is configured through the system-level Workflow Templates screen.  Voucher approvals are not available without the use of workflow.  The workflow needs to be published bef

Portal Employee Expense Entry - Approval Process

Portal Employee Expense Entry

The Integration module of AssignmentPro allows an entity using AssignmentPro to share data with another entity. A primary use case for integration is when a client managing an assignment sends…

Vendor Integration - Overview

AssignmentPro Integration with Non-AssignmentPro is a type of vendor integration available when a client uses AssignmentPro, and a vendor uses a system other than AssignmentPro.
One key difference bet

AssignmentPro Integration with Non-AssignmentPro

AssignmentPro sends instructions to vendors to initiate services for assignments such as tax, immigration and relocation services. These instructions are called "Service Orders". 
Service Orders are m

How to problem solve Ecosystem Vendor Service Orders

The Integration Event History Screen can be used to view the log of each integration event in the system. All integration event logs will appear under the Integration Event Log…

AssignmentPro Integrations - Viewing Integration Event History

Preference Name = EQVINMRTEX
Full Name - Number of Retries when the Equus Hub is Unreachable
The AssignmentPro retry logic for outbound vendor integration requests can be configured to better…

Number of Retries when the Equus Hub is Unreachable (EQVINMRTEX) System Preference

The first step in configuring AssignmentPro to share data with a vendor is selecting which set of fields can be accessed for data integration. You can check how to create…

AssignmentPro Integrations - Integration Permission Set

The first time an Integration Permission Set is applied to a vendor, a Security Role called “Vendor Integration” is created. This will serve as the security role of the Vendor…

AssignmentPro Integrations - Security Role

When ordering services from vendors that are configured for integration, the vendor may simply query the Equus Platform as needed looking for new service orders (a.k.a. “pull data”), or conversely…

Equus Platform Integration - Order Services

AssignmentPro ships with several predefined sets of integration events and push scripts that will be sent to vendors when services are ordered. These events and scripts can be customized to…

AssignmentPro Integration - Integration Events and Push Scripts

Disclaimer: Client users should not modify any integration event definition configuration except at the direction of Equus. Doing so may break connections and result in data corruption.Integration Eve

Customizing Integration Event Definitions

Disclaimer: Client users should not modify any push script configuration except at the direction of Equus. Doing so may break connections and result in data corruption.
Integration Push Scripts identi

How to customize Integration Push Scripts (Part 1 of 2)

 
Edit
An existing Integration Push Script can be edited by clickingon the grid. Equus standard Integration Push Scripts can only be inactivated. 
 
Delete
Click  to delete the Integration…

How to customize Integration Push Scripts (Part 2 of 2)

Vendor Integration

The Case Details screen (Figure 4) is used to manage and track information about the immigration case that is created by the service provider. The service provider can be an…

Visas and Work Permits Service - Case Details

The Visa and Work Permit Details screen  is used to manage and track information about the individual document(s) that are procured for a given case. One record tracks information about…

Visa and Work Permits Details

The suite of Visas and Work Permits screens in AssignmentPro allow mobility users to request and track information about the immigration services that are provided to their employees. This user…

Visas and Work Permits Service - Overview

Visa and Work Permits Summary
The Visa and Work Permits Summary screen provides a high-level overview of the set of Visa and Work Permit screens used to track requests for…

Visa and Work Permits

Views
AssignmentPro ships with the “Visa/Work Permits User Report (view)” view to support the user report described in the “User Reports” section. This view combines data from the following tables:

Visa & Work Permit Views, User Reports and Imports

In order to standardize immigration vendor integrations and encourage document sharing, the following standard immigration document types are available as standard Equus delivered document types.  The

What are the standard immigration document types available on the Visa/Work Permit screen?

Visas and Work Permits Service

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

Try using different keywords or checking for typos.

No conversations found

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Home

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.