Equus Software

Learning & Reference Materials

Help Center Guide

There are two ways to disable legacy Help Center. The legacy Help Center can be disabled together with Page Help or without affecting Page Help/Inline Manual which will be covered…

How to disable legacy Help Center only

The legacy Help Center can be disabled together with Page Help or it can be disabled without affecting Page Help/Inline Manual.  
Using the System Value of &lt;Combined&gt; all 3 Help…

How to disable legacy Help Center and Page Help

Internal users who have not opted in to share their name and email address with the Help Center provider will be presented with a pop-up message when clicking on the…

How to activate the Help Center

The full Help Center can be accessed in several ways.
The simplest way is to click on the Community / Help Center icon in the upper right-hand corner of any…

How to access the full Help Center

The following Help Resources are available once the Help Center and Equus Community are activated:

Help widget

Full Help Center 

Since AssignmentPro Release 19.2, the contents of legacy Help Center

What type of Help resources are available?

When the Help Center is activated, the Help floating widget appears in the bottom right-hand corner of the screen including internal Landing Experience dashboards. If the Help widget does not…

How to access the Help Widget

Accessing the Help Center page in AssignmentPro from the Help Center menu item will display the error message: "An error occurred trying to load Help Center content".
Help Center material…

Why do I get a Help Center error?

Accessing Help Center from the Equus Mobile Workforce Platform

Click on  to view the article in full screen mode. This icon is available in AssignmentPro Release 19.3 and above and clicking on the icon is the first step in…

How to view an article in full screen mode

To enable the best help center experience we recommend that all clients using Equus Platform Release 19.5 and above set their Help Center Preference to "Enabled". Your Equus Contact Representative

Your Help Center is Activated!

Since AssignmentPro Release 19.2, all existing material (Assignment Pro user manuals, release notes, help videos and webinars) found in the legacy Help Center have been moved across to the new…

What is the full Help Center?

Within the Help Center, searches can be performed on the main Help Center page, Search Results page or from an article page. When text is typed in the Search Box…

How to use the Help Center search feature

When viewing an article, the section can be found using the breadcrumbs
Click on the [Follow] button.
When the button is pressed, the button turns green. Chose to either follow…

How to follow all articles in a section

Using Help Center

Frequently Asked Questions /  Troubleshooting

Things to check

User Report must be a system level user report (a user cannot choose company level user reports for Advanced Automation)
Does the User Report have an Export…

Why is a user report not available / does not appear for Advanced Automation?

Advanced Automation

The table below highlights the differences between Assignment Package Batch versus Compensation Batch / Cost Estimate Batch.
 



 
Assignment Package Batch
Compensation / Cost Estimate Batch


Batch

Assignment Package Batch vs Compensation Batch / Cost Estimate Batch

Assignment Package, Compensation, Cost Estimate Batches

The business logic definition of Business Rules always uses the structure of "IF-THEN-ELSE". For rules that are straightforward such as Salary multiplied by 20%, where there are no conditions to…

Can the structure of Business Rules be changed?

Business Rules
A Business Rule record can be deleted by clicking on the [Delete] button on the Business Rule Calculation screen.  If a Business Rule is used by a feature…

Can a Business Rule or a component (Table Lookup, Function, Math, Multi-Context) be deleted or made inactive?

The uses of Business Rules are currently limited to the following areas within AssignmentPro:

to calculate a Cost Estimate line (CE) item

to calculate a Compensation Calculation (CC) line item…

Where are Business Rules used?

Currently, running a Business Rule will only return a single row/value.  The screenshot shows the final outcome when testing the rule using the [Save &amp; Run] button on the calculations…

Can a Business Rule return more than a single row or value?

System level user tables are now supported in Business Rules in addition to Company, Assignment and other lower-level user tables.   
 
User Tables are referenced when using the Table…

Can System-Level User Tables be used with Business Rules?

A data mismatch between the data type of a data source and the Business Rule's output type is highlighted with a red icon.  To know what the data type of…

How to resolve a data type mismatch in a business rule / convert a number type to a money type

The Convert Money Function is one of the 44 functions available in the business rules calculation. It is a useful function to use especially when creating business rules for Cost…

How and when to use the Convert Money function in a Business Rule

There are a total of 44 functions available to select from the Functions drop down list when choosing to use Functions to create Business Rule logic.  
Once a function is…

What SQL and Equus functions are supported in Business Rules?

The introduction of business rules allows both new business rules calculations and existing custom calculations to co-exist and be used in Cost Estimate (CE) and Compensation Calculation (CC) template

Is it possible to convert existing Custom Calculations to use Business Rules?

When running a Business Rule it will only return a single row/value.  Currently it is not possible to take the result and write it to another field in AssignmentPro.  
However,…

Can the Business Rule outcome update another field?

There is no requirement to transition from previously configured custom calculations to the new business rule calculations.  
All legacy custom calculations remain unaffected with the introduction of

Can a mixture of Custom Calculations and new Business Rules be used?

It is possible to create a copy of a Business Rule using the [Copy] button.  Any active Business Rules can be then be reused in other Business Rules when selecting…

What copy and reuse functions are available in Business Rules?

Business Rules cannot be copied between companies. It is possible to copy company level Business Rules within a company or system level Business Rules within the system using the [Copy…

Can Business Rules be copied between companies and different sites?

Enter Business Rules using the Configuration Search tool to navigate to either the Business Rules screen at a System or Company level.  Press the [+ New] button to add a…

How can I start creating Business Rules

Depending on the way you want to use your Table Lookups, you may design your business rules in a few ways.
Scenario 1 - Table Lookup outcome compared against different…

How can Table Lookups be used within Business Rules

Here are some things to consider when building complex business rules to make them run faster:
Use 'Jump to Step'
Multi-step calculations will perform faster if the "Jump to Step"…

How do I ensure  Business Rules are performing efficiently?

Labels can be added to Business Rules for easier categorization and reporting.  Labels can be added and edited when editing Business Rules from Business Rules calculations screen.  
Click on the Detai

How to add / remove business rule labels

Custom fields at both the system and company level are available to be used in the business rules logic criteria. 
If a company level custom field is created a for…

Are custom fields supported in Business Rules?

Here are some best practices to consider when creating Business Rules:
 
Documentation 📄

Try to ensure that all Business Rules are documented consistently and that this documentation is accessible…

What are some of the Business Rules best practices?

Business Rules

The drop down list for the Compensation Calculation Line Item parameter may appear empty before running the Compensation Calculation Details report from the Review &amp; Reports tab. This may indicate

Why is the Compensation Calculation Line Item drop down blank?

Compensation Calculation

When the [Delete Transaction] button is enabled and pressed to delete the transaction, the following message appears: "Compensation Transaction Processing Cannot be Undone. Transactions have associate

Why can't a transaction be deleted using the Delete Transaction button?

When a compensation worksheet (CW) report is sent to the employee, you cannot recalculate without undoing/unsending the communication to the employee.  There is an option available not to send an…

Why is the Calculate & Save button not available on effective compensation worksheet after deleting the transaction?

When a Global Statement of Earnings (GSOE) report is run, AssignmentPro uses the value selected from Currency to Display on Report parameter and looks for the applicable GSOE template in…

What determines the Global Statement of Earnings Template to use for the GSOE Report?

Compensation Module

This error message appears when the [Enter] key is pressed and the system cannot locate a record matching the contents of the configuration search box.
To find a record using…

Why do I get an "Invalid or unknown Assignment number" error?

This error message appears when the configuration search feature is used on an AssignmentPro site that has timed out.  
To use the search feature without encountering the error, log back…

Why do I get a "Forbidden" error?

Configuration Search

The same tax authorities that are supported for Cost Estimates are also supported for What-If Cost Estimates (WICE). 
You can find a the complete list of supported authorities in Appendix…

Where can I find a list of countries supported by WICE?

Cost Estimate

Election Sets appear in the Benefits &amp; Services card and page. 
If no Election Sets exist for an employee’s Assignment, the Election Set icon is automatically hidden.

MEE view

Where do Election Sets appear on the MEE (Mobile Employee Experience)?

If no Election Sets exist for an employee’s Assignment, the Election Set icon is automatically hidden.
 

Do election sets appear if there are none to be completed?

No, unfortunately not - speak to your Equus client solutions representative about upgrading to the new Mobile Employee Experience.

Can employee elections be used with the old employee portal?

Yes - you can issue employees multiple election sets at once and over the course of their assignment/move.

Can an employee have multiple elections open at once?

Notifications can be setup via checklists or quick workflows.

Are there any automatic notifications to the mobility team once the employee has submitted their elections?

Is the employee automatically reminded that they have elections to make?

When the employee logs in to the mobile employee experience, they will be told they have elections to make.  They can be prompted via checklist or quick workflow notifications.

How does the employee know they have elections to make?

When viewing the situational rules on the Election Details screen, you may encounter conditions appearing in the Situational Rules section that do not apply to that election set.  This is…

Why are situational rules being applied to another election set to which they don't apply?

When election set budgeting is enabled and a user submits the election set, the leftover money or points budget will always save a value to the ELECTION_SET!LEFTOVER_BUDGET_AMOUNT field. 
This can…

Can the remaining money or point budget be reported on?

Election Sets

The system preference APRLNKWNDW sets the limit (in days) that links would work for Approver Emails using the Generic Approval routing system which initiated from the following screens:

Core Flex…

How to set an expiration duration limit for Approval Links

Emails

Sent pulse checks appears in the Task Area on the assignment home page of the Mobile Employee Experience.  If the Pulse Check has announcement enabled, employees will see the pulse…

How are employees notified when a pulse check is sent to them?

Employee Feedback and Pulse Check templates do not support dynamic questions i.e. questions that changes based on the respondent and/or the answers they provide while providing their responses.

Can questions be dynamically derived based on an answer to a previous question?

Employee Feedback
When the employee feedback template is activated, all employees with at least one active assignment will see the "Give Feedback" menu item  towards the bottom of the navigation…

Can I control who receives a pulse check / employee feedback?

There are two tables : “Pulse Check Question” table to report on Pulse Check responses and “Employee Feedback Question” table to report on submitted feedback.
For Pulse Checks, the “Question…

Are the results of pulse checks and employee feedback reportable?

Employee Feedback and Pulse Checks

Below is a list of file types / forms that are supported in AssignmentPro.  Uploading files that are not included in this list will result in an Error message on screen.
.3G2.3GP.AIFF.AMR.ART.AU.AVI.B

What file types / formats are supported in AssignmentPro?

Generic 

When Request Types are configured to appear on an External Client portal, they will appear in the Take Action widget on the Landing Experience. 
Things to check

No company overrides on…

Why does a request type not appear in the Landing Experience?

When the Data Dictionary Manual Override feature is set to a desired behavior e.g. Force Read Only or is Required for a specific field that appears in an External Client…

Why is the data dictionary manual override not applied in the Landing Experience?

Landing Experience

The Mobile Employee Experience mobile app can only be configured to be turned on or turned off.
There are currently no customizations that can be done to the mobile app…

Can the Mobile Employee Experience App be customized?

Only active assignments/moves (ASSIGNMENT!INACTIVE = FALSE) are displayed in the Mobile Employee Experience and these appear under the heading of MY ASSIGNMENTS or MY MOVES in the navigation bar.
An…

What is the display order when there are multiple assignments in the Mobile Employee Experience?

Navigation Menu in the Mobile Employee Experience (MEE)
 
Things to check


Check that the Advanced Settings section on the Employee Experience tab on the Employee Experience Configuration screen is

Why is the "My Info" and its menu items not appearing in the Mobile Employee Experience?

Mobile Employee Experience

There are four System Request Types that are configured in the system (Generic, End of Employment, Employee Repatriation, Assignment Extension).  It is not possible to add or remove fields from…

Can fields be added or removed for System Request Types?

Request Types

A warning message is displayed at the top of the screen if any of the records contained within the batch is processed with errors. 
When a checklist task is assigned…

Why can't tasks be assigned to a resource using the Resource Change Batch?

It is possible to assign all tasks from one resource (Current Resource) to another resource (New Resource), using the Resource Change Batch screen.  Currently it is not possible to reassign…

Can all tasks be assigned to different resources?

When a batch is created after pressing [Fill Batch] on the Resource Change Batch screen, the options available to a user is to process all the Checklist Task records in the…

Can a user select which tasks to be included in the batch?

It is not possible to undo a processed resource change batch or any records that were successfully processed as part of a batch.  Only records that were processed with errors…

Can a processed resource change be undone?

It is only possible to assign all tasks from one resource (Current Resource) to another resource (New Resource).  Currently, there is no option to customize the batch or to assign…

Can selected tasks be assigned to a resource or resources?

Currently only checklist tasks within the assignments that a user has rights to edit are included in the batch processed by the user. Checklist tasks that are complete and cancelled will…

What tasks are included in a Resource Change Batch?

Resource Change Batch

In preparation for each new tax year, a new Questionnaire Screen Definition has to be created.  This Questionnaire Screen Definition will be tied to both the Tax Organizer in the…

How to create a Questionnaire Screen Definition for a new country's tax year

The easiest way to create a checklist for a country's new tax year is by copying the existing year's checklist.  Prior to doing this, a Questionnaire Screen Definition must be first…

How to create checklist for a country's new tax year

Prior to uploading a fully populated Tax Import Details Import template saved as a .csv file, the checklist for the new tax year must be created and active.  Once the…

How to upload the Tax Details Import template to start the checklist for a new tax year

When Tax Return Details for the new tax year are created for the assignee, the newly created checklist (copied from the previous year) will automatically start and will create a…

How to create Tax Return Details for assignees to start the checklist for the new tax year

Below are the steps involved to notify employees that they have to complete the Tax Organizer via a link in the Mobile Employee Experience for a new tax year.  Note…

Yearly Tax Organizer Process

Importing data is useful in updating large volumes of data when it would be inefficient to manually input the values directly into the system.  The use of this customized generic…

How to populate the Tax Return Details Import template for a new tax year

Tax Organizer

The error "Each GROUP BY expression must contain at least one column that is not an outer reference." is generated when running a user report where the aggregate function has…

Why does my user report have a GROUP BY expression error?

The "You are currently missing a single quote.  Please revise your formula and try again" error is generated when running a user report that contains at least a Custom SQL…

Why does my user report show a missing single quote error?

User Reports

Reference Library

What to use in Custom SQL field:
<table style="height: 188px;
width: 686.665px;">


Static Value
'XXX'


Field Name and Static Value
[Table: Field Text]+'XXX'


Field name and Static Value inc. Space

Custom SQL fields - Command to a static value to a column

What to use in Custom SQL field:
DATENAME(d,[Table: Field Date]) +CASEWHEN DATENAME(d,[Table: Field Date]) IN ('1', '21', '31') THEN 'st'WHEN DATENAME(d,[Table: Field Date]) IN ('2', '22') THEN 'nd'WH

Custom SQL fields - Command to add st, nd, rd or th after a day

What to use in Custom SQL field:
DATENAME(MONTH,[Table: Field Date])
  
Example:
where [Table: Field Date] = [ASSIGNMENT!START_DATE]

 
 
 

Custom SQL fields - Command to show full name of the month

What to use in Custom SQL field (see RH column):



DD MMM YY
CONVERT(VARCHAR(11),[Table: Field Date],6)


DD MMM YYYY
CONVERT(VARCHAR(11),[Table: Field Date],106)


DD MMM YYYY hh:mi:ss:mmm
CONVERT(V

Custom SQL fields - Command to display different date formats beginning with day

See also useful SQL functions 
 
Format
NOTE: for a list of styles for date formats, see http://sqlserverplanet.com/oracleequivalents/trunc-date-sql-server/

Day first
Month first
Year first

Add st,

Custom SQL fields - List of commands for date types

What to use in Custom SQL field (see RH column):
<table style="height: 139px;
width: 653px;">


MMM DD YYYY (Time)
CONVERT(VARCHAR(19),[Table: Field Date])


MMM DD, YYYY
CONVERT(VARCHAR(12),[Table: F

Custom SQL fields - Command to display different date formats beginning with month

What to use in Custom SQL field:
ROUND(DATEDIFF(DD,[Table: Field Date1],[Table: Field Date2])/30,0)
  
Example:
where
[Table: Field Date1] = [Assignment: Start Date]
[Table: Field Date2] = [Assignment

Custom SQL fields - Command to calculate duration in months between two dates

What to use in Custom SQL field:
DATEDIFF(DD,[Table: Field Date1],[Table: Field Date2])
  
Example:
where
[Table: Field Date1] = [Assignment: Start Date]
[Table: Field Date2] = [Assignment: Actual End

Custom SQL fields - Command to calculate duration in days between two dates

What to use in Custom SQL field:
DAY(DATEADD(mm,DATEDIFF(mm, -1, [Table: Field Date]),0) -1)
 
Example:
where [Table: Field Date] = [Assignment: Start Date]

Custom SQL fields - Command to display the number of days in the month of a certain date

What to use in Custom SQL field:
DATEADD(day,X,[Table: Field Date])
DATEADD(week,X,[Table: Field Date])
DATEADD(year,X,[Table: Field Date])
 
Example:
where
X = integer (1) e.g DATEADD(day,1,[Table: F

Custom SQL fields - Command to extend date by X number (day, week, year)

What to use in Custom SQL field (see RH column):
<table style="height: 54px;
width: 648px;">


YYYY/MM/DD
CONVERT(VARCHAR(11),[Table: Field Date],111)


YYYYMMDD
CONVERT(VARCHAR(11),[Table: Field Date

Custom SQL fields - Command to display different date formats beginning with year

DBO.EQ_STD_EXCHANGE_RATE_GET(PARAMETER 1, PARAMETER 2, PARAMETER 3, PARAMETER 4)
This function will return the Company or System level exchange rate based on what has been configured on the specified

DBO function to return Exchange rate for date

DBO.EQ_STD_USER_FIRST_LAST_GET(Parameter1)
This function will return the first and last name of a user where the user_ID is contained.
 
Parameter(s)
Parameter1: Any field in the system where the user

DBO function to return first and last name from user id

DBO.EQ_STD_HOST_COUNTRY_ISO2_FROM_ASSIGNMENT_ID(Parameter1)This  function will accept the assignment id and return the 2 character ISO code for the From Country. This same information can also be adde

Learning & Reference Materials

Help Center Guide

Frequently Asked Questions / Troubleshooting

Reference Library

Community Guide

Glossary of Terms

Conference Materials

Courses

Equus Mobile Workforce Platform Quick Learning Videos

Tutorials

Webinars