|
|
| (65 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| < under construction for version 5.6 release!!>
| | #REDIRECT [[Continuum Link]] |
| | |
| | |
| =Introduction=
| |
| The CommitCRM-Zenith Integration automatically creates tickets in CommitCRM from alerts and service tickets generated by Zenith Infotech system, or from tickets created manually by the Zenith NOC. Users can then close the Ticket in CommitCRM, and it will be closed in Zenith.
| |
| | |
| The CommitCRM integration with Zenith includes:
| |
| | |
| * Two-ways Ticket Integration.
| |
| * The ability to link Account to Site in Zenith or create Account from Site.
| |
| * The ability to link Asset to Device in Zenith or create Asset from Device.
| |
| | |
| Once the CommitCRM-Zenith Integration has been configured Zenith
| |
| Ticketing System is disabled and Ticket management is performed solely in CommitCRM.
| |
| | |
| Ticket can still be viewed in Zenith (read-only); however, the master Ticket is managed in CommitCRM. When closing a Ticket in CommitCRM it is closed in Zenith. When closing a Ticket in Zenith it adds a History Note to the Ticket in CommitCRM, however, the Ticket stays open.
| |
| | |
| | |
| '''''Technical Note'''''<br>
| |
| ''The integration is based on a new Service running on your CommitCRM server (called CommitRMMServer Service), which accepts all alerts and Tickets from Zenith and creates the Ticket in CommitCRM.''
| |
| | |
| | |
| =Zenith Settings=
| |
| To setup Zenith to work with CommitCRM Link, login to the Zenith Portal with Admin account and go to ''Configuration > Edit Member Details''.
| |
| | |
| The Account Details window is displayed. Under PSA Details, click ''PSA Settings''.
| |
| | |
| Select CommitCRM and click ''Generate PSG''.
| |
| Copy the PSG and click on ''Save''.
| |
| | |
| Use this PSG to complete the configuration in CommitCRM. See [[Zenith_Link#CommitCRM_Setup|CommitCRM Setup]].
| |
| | |
| =CommitCRM Setup=
| |
| To work with Zenith the following steps are required:
| |
| | |
| # Initialize Zenith PSG.
| |
| # Install CommitRMMServer.
| |
| # Validate CommitRMMServer downloads Zenith Sites and Devices to the CommitCRM server.
| |
| # Link Accounts and Assets in CommitCRM(*) to Sites in and Devices Zenith.
| |
| # Enable Zenith Integration.
| |
| <br>
| |
| ''*Note to users upgrading to version 5.6:<br>
| |
| ''When upgrading from an older version, the Zenith Integration system will be disabled by default until activated explicitly. This is to make sure users first link Zenith Sites to CommitCRM Accounts to avoid many duplicate Accounts which will require merge. Once all Accounts are linked, users should enable the integration, see Enabling Zenith Integration''.
| |
| | |
| ==Initialize Zenith PSG==
| |
| | |
| To allow CommitRMM service to connect with Zenith and sync with it, a Zenith Partner Security code (also known as PSG) is required.
| |
| | |
| In order to connect to Zenith when activating the service, the following setup should be completed:
| |
| | |
| # Open <Installation_DIR>\RMM\ CMTZenithLink.ini
| |
| # Copy the Security Code value from Zenith PSA Settings window, and paste your Zenith Partner Security code as the value for token PSG:<br>PSG =Your-Zenith-Security-Code
| |
| # Save your changes. | |
| <br><br>
| |
| | |
| ==Install CommitRMMServer Service==
| |
| After you finish setting up all of the required settings (see [[Zenith_Link#Initialize_Zenith_PSG|Initialize Zenith PSG]]), you can move on to the next step and install the CommitRMMServer service.
| |
| | |
| The CommitRMMServer runs as a Windows Service on your server.
| |
| | |
| '''Before you install the CommitRMMServer'''
| |
| #Make sure to complete the Setup steps prior to installing the Windows Service.
| |
| #Make sure to allow the CommitRMMServer Service in your DEP settings.
| |
| | |
| This part of the installation should be performed on the server itself.
| |
| When logged in to the server with a Window's Administrator account, open a command prompt window and enter the following command:
| |
| <Installation_DIR>\RMM\CommitRMMServer.exe -install
| |
| | |
| ''Note: The <Insallation_Dir> must refer to a LOCAL server path (e.g. c:\ or D:\Software, etc.) and NOT to a shared network name/path.''
| |
| | |
| A Window's service called CommitRMMServer is now displayed in the system services management window (Control Panel > Administration Tools > Services). If the service is not displayed, make sure you are running the command prompt "As Administrator".
| |
| <br><br>
| |
| '''Start Service''':<br>
| |
| Using the Window's Services Management window start the service (right-click > Start). Make sure that it is set to start automatically (Startup type > Automatic) each time the server is restarted.
| |
| | |
| <br>
| |
| | |
| ==Download Sites and Devices Files==
| |
| In order for the Tickets arriving from Zenith to be created for the correct Account and Asset, all Zenith Sites should first be linked to the parallel CommitCRM Accounts, and Devices must be linked to Assets.
| |
| | |
| Managing the links requires downloading the list of Sites and Devices from Zenith. This is done automatically by CommitRMMServer once it is activated. Note that the Zenith Integration must NOT be enabled yet at this point; only the server should be activated in order for it to download the Sites and Devices details.
| |
| | |
| Once the CommitRMMServer is activated, it immediately connects to Zenith and downloads the following files:
| |
| | |
| * <server>\Commit\Dbsys\ZenithSites_RMAZENITHINFOTECHID1.cmt
| |
| * <server>\Commit\Dbsys\ZenithDevices_RMAZENITHINFOTECHID1.cmt
| |
| | |
| Both files are XML formatted files which are used by the Zenith Links manager via the application to link Sites and Devices to equivalent Accounts and Assets.
| |
| | |
| Make sure both files exist before moving on to the next step which is Linking Accounts and Assets.
| |
| | |
| '''Handling Errors'''<br>
| |
| In case CommitRMMServer fails to download Sites and Devices details, the system will alert the user with a message when attempting to use the Zenith Links Manager (e.g. from Accounts > Tools > Open Zenith Links Manager). In such case, refer to the [[#Troubleshooting]] section.
| |
| | |
| ==Link Accounts and Assets==
| |
| When a Ticket arrives from Zenith it is created in CommitCRM and automatically linked to the Account which is associated with the Site specified for the Ticket. In case the Site is not associated to any CommitCRM Account, a temporary Account is created and the Ticket is linked to it. See more details in Ticket from Unknown Site.<br>
| |
| To avoid redundant temporary Accounts from being created, all Zenith Sites should first be linked to the equivalent CommitCRM Accounts. Only when all Accounts are associated to Sites, a System Administrator should enable the integration. See [[Zenith_Link#Enable_Zenith_Integration|Enable Zenith Integration]].
| |
| | |
| '''Link Accounts to Sites'''<br>
| |
| Before starting to work with the Zenith Integration, an Administrator must first link all Accounts to the equivalent Sites in Zenith. This step is required in order for Tickets arriving from Zenith to be opened under the correct Account.
| |
| | |
| To Link Accounts to Sites in Zenith see [[Zenith_Link#Link_Account_to_Site|Link Account to Site]].
| |
| | |
| '''Link Assets to Devices'''<br>
| |
| Before starting to work with the Zenith Integration, an Administrator must first link all and Assets to the equivalent Devices in Zenith. This step is required in order for Tickets arriving from Zenith to be opened under the correct Asset.
| |
| | |
| To Link Assets to Devices in Zenith see [[Zenith_Link#Link_Asset_to_Device|Link Asset to Device]].
| |
| | |
| ==Enable Zenith Integration==
| |
| Enabling Zenith Integration will immediately start importing Tickets from Zenith into CommitCRM. Make sure to [[Zenith_Link#Link_Accounts_and_Assets|link your Zenith Sites with CommitCRM Accounts]] prior to enabling the integration, to avoid duplicate Account creation. See more details in [[Zenith_Link#Link_Accounts_and_Assets|Link Accounts and Assets]].
| |
| <br>
| |
| To enable Zenith Integration and start Tickets transfer from Zenith:
| |
| | |
| # Open <Installation_DIR>\RMM\ CMTZenithLink.ini
| |
| # Change the value for ''ProcessZenithUpdatesQueue'' to Y (by default it's set to N in order to allow user first to perform links between Zenith sites/devices to CommitCRM).
| |
| # Restart CommitRMMServer Service.
| |
| <br>
| |
| | |
| =Two-Ways Ticket Integration=
| |
| Only after installing the CommitRMMServer, linking between Accounts and Sites and enabling the Integration, will the Ticket integration come into action.
| |
| | |
| Once enabled, Tickets arriving from Zenith automatically create a Ticket in CommitCRM.
| |
| | |
| A standard(*) automatic Ticket creation process includes:
| |
| | |
| # Ticket arrives at the Commit RMM Server.
| |
| # Ticket is created in CommitCRM.
| |
| # Ticket is linked to Asset.
| |
| # Ticket appears in CommitCRM Tickets Inbox.
| |
| | |
| ''(*) See how the system handles non-standard scenarios in [[Zenith_Link#Ticket_Creation_Special_Cases|Ticket Creation Special Cases]].''
| |
| | |
| Once the Ticket is created in CommitCRM it should be managed only in CommitCRM:
| |
| | |
| * Any updates to the Ticket details will not update the Ticket in Zenith.
| |
| * Closing a Ticket in CommitCRM will close the Ticket in Zenith.
| |
| * Closing a Ticket in Zenith will not change the Status in CommitCRM.
| |
| | |
| | |
| See more details on Ticket updates in the sections below.
| |
| | |
| ==New Ticket==
| |
| New Tickets are automatically created by Commit RMM server from Tickets arriving from Zenith.
| |
| | |
| When a new Ticket is created in Zenith (by a user or from an Alerts), CommitRMMServer pulls the new ticket details and creates the Ticket in CommitCRM.
| |
| | |
| The new Ticket in CommitCRM includes:
| |
| | |
| # Ticket description taken from the Zenith Ticket description.
| |
| # Ticket is assigned to the Account manager for this Account (if defined). Otherwise the Ticket Manager is taken from ''Default Ticket Manager'' defined in ''Tools > Options > Tickets (Admin) > Default Manager''.
| |
| # History Note is automatically added to the Ticket with the creation date and time from Zenith.
| |
| # Ticket is linked to the relevant Asset. If the system cannot determine the Asset, the Zenith Device details are added as a note to the Ticket. See more details in [[Zenith_Link#Device_Not_Linked_to_Asset|Device Not Linked to Asset]].
| |
| | |
| | |
| After the Ticket is created it is automatically added to the [[Ticket_Management#Inbox|Tickets Inbox]].
| |
| | |
| ==Ticket Updates==
| |
| When working with the Commit-Zenith Integration, Tickets are managed only in CommitCRM. However, Tickets which are created from Zenith do exist in Zenith and can be updated (Status only) and closed.
| |
| | |
| When a Ticket is updated in Zenith, the following takes place:
| |
| | |
| # Ticket update in Zenith adds the Ticket to the Tickets Inbox in CommitCRM
| |
| # A History Notes is automatically added to the Ticket with the update details.
| |
| # The Ticket Status in CommitCRM is never changed automatically.
| |
| | |
| | |
| ==Closing Tickets==
| |
| | |
| '''In CommitCRM'''<br>
| |
| Closing or canceling a ticket in CommitCRM will close the Ticket in Zenith.
| |
| | |
| '''In Zenith'''<br>
| |
| Closing a Ticket in Zenith does not close the Ticket in CommitCRM.
| |
| | |
| When closing a Ticket in Zenith the following takes place:
| |
| | |
| # Ticket in CommitCRM is added to the [[Ticket_Management#Inbox|Tickets Inbox]].
| |
| # A History Note is automatically added to the Ticket with the text: Ticket closed in Zenith + update date-time
| |
| # Ticket Status in CommiCRM is never changed automatically.
| |
| <br>
| |
| | |
| =Managing Zenith Links=
| |
| In order for Tickets arriving from Zenith to be opened under the correct Account and Asset, you must create an association between Sites and Devices in Zenith to Accounts and Assets in CommitCRM.
| |
| | |
| Creating the links is done using the ''Zenith Links Manager'' Window via CommitCRM.
| |
| | |
| ''Note: CommitRMMServer service must first be installed in order for the Zenith Sites and Devices to be downloaded to the CommitCRM server. See more details in [[Zenith_Link#Download_Sites_and_Devices_Files|Download Sites and Devices Files]].''
| |
| | |
| ==Link Account to Site==
| |
| In order for Tickets arriving from Zenith to be opened under the correct Account, you must create an association between sites in Zenith to Accounts in CommitCRM, or create an Account in CommitCRM for this Site.
| |
| | |
| Note that multiple Sites in Zenith can be linked to the same Account in CommitCRM, since the Sites may represent several physical sites for the same client, thus represented in the same CommitCRM Account.
| |
| | |
| Use the Zenith Links Manager Window to create the association:
| |
| | |
| # In the Accounts Window, go to Accounts > Tools > Zenith Links Manager. The following window opens: <SCREENSHOT>
| |
| # In the Wizard which opens you can find a list of available un-linked sites from Zenith. This list gets updated every hour.
| |
| # Select the Site you want to link, and click Next.
| |
| # Link to CommitCRM Account:<SCREENSHOT>
| |
| ## Find the parallel Account(**) using the search pane using one of these options:
| |
| ###Search for Account by keyword/s.
| |
| ###See Account list recommended by the system based on the Site name.
| |
| ###Once you have chosen the Account, click Link to Account.
| |
| ##OR create a new Account based on the selected Site details(*).
| |
| | |
| ''(*) Note: When creating a new Account in CommitCRM based on the Site from Zenith, only the Site name is copied to CommitCRM. No other details are transferred.
| |
| (**) Note: that multiple Sites in Zenith can be linked to the same Account in CommitCRM, since the Sites may represent several physical sites for the same client, thus represented in the same CommitCRM Account.
| |
| ''
| |
| | |
| At this point the Account and Site are linked.
| |
| | |
| To cancel this link between the Account and Site, hit the Linked Accounts tab to find the Account and remove the link. See [[Zenith_Link#Unlinking_Accounts|Unlinking Accounts]].
| |