Skip to main content
CCH Software User Documentation

CCH iFirm Console

 

CCH iFirm Console 

The CCH iFirm console allows firms to authenticate and monitor the syncing of edited Contact and Client records from CCH Central to CCH iFirm, and saving transferred documents from CCH iFirm to CCH Document Management (when CCH Document Management is licenced).

Opening the Console

From CCH iFirm  Mainenance > Service Settings, click on the CCH iFirm Console 

iFirm_GetStarted_iFirmConsole_1.png

You need to be Signed In and the Central Service Status is: Running

iFirm_GetStarted_iFirmConsole_2.png

CCH iFirm Console

The CCH iFirm console allows firms to authenticate and monitor the syncing of edited Contact and Client records from CCH Central to CCH iFirm, and saving transferred documents from CCH iFirm to CCH Document Management (when CCH Document Management is licenced).

Task Permission

A new task permission has been created to allow firms to select which employees can access the CCH iFirm Console.
iFirm_Get-Started_Console-Window_1.png

CCH iFirm Console Window

Navigate to File > Maintenance >  Service Settings > CCH iFirm Console
iFirm_Get-Started_Console-Window_2.png

CCH iFirm Authentication

This sign-in option allows for the syncronisation of contacts/client records, edited records, and for the saving of documents from CCH iFirm cloud products into CCH Document Management (where licenced).

Click the Sign In button, a modal is displayed. The modal (below) only appears if the configuration 'iFirm_EnableUpdateContact' has a key value = 0.
iFirm_Get-Started_Console-Window_3.png

Yes - This automatically updates the above-mentioned configuration key setting the value to 1 and redirects to the CCH iFirm login page.
No - This cancels the sign in and returns you to the console window.

This indicates a warning or caution! Only one employee's credentials are required to log in.
BUT, that one employee must be set as an Admin within CCH iFirm. ( They require full access rights to all Contacts/Clients to action the change requests).

Once the CCH iFirm login has been authenticated, the following message is shown:

iFirm_Get-Started_Console-Window_5.png

Note: A CCH Central Service restart is required on the Main Server.

Validations

The following message is shown where an employee is already signed in and the button is re-selected.
iFirm_Get-Started_Console-Window_6.png

CCH Central Service

This box shows the status of the CCH Central Service.  It will show either a Status of Running or Stopped:
Where the status is reflected as Stopped, please inform your IT administrator to restart the CCH Central Service on the Main Server.
iFirm_Get-Started_Console-Window_8.png

CCH iFirm Polling Settings

This option allows firms to set the interval for checking for any changes made within CCH Central and pushing the relevant changes up to CCH iFirm.  
iFirm_Get-Started_Console-Window_9.png

Note: A restart of the CCH Central Service is required if the Polling interval value is changed.
 

CCH iFirm Identification

This displays the CCH iFirm name and id after using the Sign in button to authenticate.  The right-click option allows firms to copy both Name and Id if required to be provided to the CCH Customer Support.

iFirm_Get-Started_Console-Window_10.png
 
Sync Messages

The sync errors incurred during the syncing of edited records into CCH iFirm, are displayed within the Sync Messages tab.
iFirm_Get-Started_Console-Window_11.png

  1.  A more detailed description is displayed when the user hovers over the reason.iFirm_Get-Started_Console-Window_12.png
  2. Use the search option to narrow down the filter process.  
    iFirm_Get-Started_Console-Window_13.png 
  3. Click the Refresh icon on the ribbon to refresh the results.
  4. The 'Days to keep sync messages' is definable.  
  5. Change the value to alter the days the messages are kept for.

Audit Trail

This shows the audit trail for Contacts/Clients and their associations for clients who have been pushed or are about to be pushed up into CCH iFirm.
iFirm_Get-Started_Console-Window_13.png
 

  1. Use the search option to narrow down the filter process.  
     iFirm_Get-Started_Console-Window_14.png
  2. Click the Refresh icon on the ribbon to refresh the results.
  3. Last Audit Trail Id, this displays the latest audit trailId.

Useful Information!

The Audit trail entries are cleared after XX days.  

The value displayed is determined by what has been entered as the KeyValue for the 'DaysToKeepAuditTrailData' Configuration Key.  

Navigate to File > Maintenance > User Defined > Configuration to change the specified days.

 

  • Was this article helpful?