Hyperlinks configurator

Included in Professional product from 3.1.0

Allow to jump on other applications or execute actions on iTop object. The below actions are out of the box:

• From a person, you can search them in LinkedIn
• From a Location, you can search it in Google Maps
• From a Ticket, you can add (or remove) yourself to the Ticket's contacts in one click
• From a Audit Domain, Category and Rule, you can run the audit to test / check the results.

Those actions can be modified or removed and more actions can be configured without writing a single line of code:

• Specify a label, tooltip and icon (one single language)
• The action can be proposed on an subset of objects (production only for eg.)
• The action can be proposed in the console and/or on the portal(s)
• The action can be limited to users having a particular profile

• Button labels cannot be localized (they are not dictionary entries)

iTop 2.3.0 or newer

Use the Standard installation process for this extension.

For each “link” to be displayed, the following configuration parameters are available:

Configuration file

'combodo-custom-hyperlinks' => array (
   'hyperlinks' => array (
      'Person' => array (
         'linkedin_me' => array (
            'label' => 'Linkedin Me!',
            'url' => 'https://www.linkedin.com/search/results/all/?keywords=$this->friendlyname$',
            'scope' => 'SELECT Person',
            'icon' => 'fab fa-linkedin',
            'contexts' => 'backoffice',
         ),
      ),
      'Location' => array (
         'maps_me' => array (
            'label' => 'GoogleMaps Me!',
            'url' => 'https://www.google.com/maps/search/$this->address$+$this->postal_code$+$this->city$+$this->country$',
            'scope' => 'SELECT Location WHERE org_id_friendlyname=\'demo\'',
            'icon' => 'fas fa-globe',
            'contexts' => 'backoffice',
         ),
      ),
      'AuditDomain' => array(
         'UI:Menu:RunAudit' => array(
            'label' => 'Run the audit',
            'url' => 'audit.php?operation=audit&domain=$this->id$',
            'scope' => 'SELECT AuditDomain',
            'target' => '_top',
            'tooltip' => 'Run audit for this Domain',
            'icon' => 'fas fa-play-circle fa-lg',
            'contexts' => 'backoffice',
         ),
      ),
      'AuditCategory' => array(
          'UI:Menu:RunAudit' => array(
              'label' => 'Run the audit',
              'url' => 'audit.php?operation=audit&categories=$this->id$',
              'scope' => 'SELECT AuditCategory',
              'target' => '_top',
              'tooltip' => 'Run audit for this Category',
               'icon' => 'fas fa-play-circle fa-lg',
              'contexts' => 'backoffice',
           ),
       ),
      'AuditRule' => array(
          'UI:Menu:RunAudit' => array(
              'label' => 'Run the audit',
              'url' => 'audit.php?operation=audit&categories=$this->category_id$&rule=$this->id$',
              'scope' => 'SELECT AuditRule',
              'target' => '_top',
              'tooltip' => 'Run audit for this Rule',
              'icon' => 'fas fa-play-circle fa-lg',
              'contexts' => 'backoffice',
           ),
       ),
       'Ticket' => array (
          'UI:Menu:AddMeToContact' => array (
              'label' => 'Add me to contacts',
              'url' => 'method://AddCurrentUserToContacts()',
              'scope' => 'SELECT Ticket WHERE id NOT IN (SELECT Ticket AS U JOIN lnkContactToTicket AS L ON L.ticket_id=U.id WHERE L.contact_id=:current_contact_id)',
              'icon' => 'fas fa-user-plus',
              'contexts' => 'backoffice',
          ),
          'UI:Menu:RemoveMeFromContact' => array (
              'label' => 'Remove me from contacts',
              'url' => 'method://RemoveCurrentUserFromContacts()',
              'scope' => 'SELECT Ticket AS U JOIN lnkContactToTicket AS L ON L.ticket_id=U.id WHERE L.contact_id=:current_contact_id',
              'icon' => 'fas fa-user-minus',
              'contexts' => 'backoffice',
          ),
       ),
   ),
),

Just click on the button(s) !

Q: When I try to Add me to contacts on a ticket I get this error message:
The method 'AddCurrentUserToContacts' does not exist on the class 'UserRequest'. Check the configuration of the menu with UID = 'UI:Menu:AddMeToContacts'

Answer: You have 3 options:

1. Upgrade your iTop to version 3.1
2. Remove those hyperlinks configuration entries
3. Customize your iTop, by adding those 2 methods on Tickets AddCurrentUserToContacts() and RemoveCurrentUserFromContacts()

Ticket

   public function AddCurrentUserToContacts()
   {
        $iPersonId = UserRights::GetContactId();
        if ($iPersonId > 0) {
            $oContactsSet = $this->Get('contacts_list');
            if (!in_array($iPersonId, $oContactsSet->GetColumnAsArray('contact_id'))) {
                $oLnk = MetaModel::NewObject('lnkContactToTicket');
                $oLnk->Set('contact_id', $iPersonId);
                $oLnk->Set('ticket_id', $this->GetKey());
                $oContactsSet->AddItem($oLnk);
                $this->Set('contacts_list', $oContactsSet);
                $this->DBUpdate();
            }
        }
        return true;
   }
   public function RemoveCurrentUserFromContacts()
   {
        $iPersonId = UserRights::GetContactId();
        if ($iPersonId > 0) {
            $oContactsSet = $this->Get('contacts_list');
            foreach ($oContactsSet as $oLnk) {
                if ($oLnk->Get('contact_id') == $iPersonId) {
                    $oContactsSet->RemoveItem($oLnk->GetKey());
                    $this->Set('contacts_list', $oContactsSet);
                    $this->DBUpdate();
                    return true;
                }
            }
        }
        return true;
   }

Q: Can I use this extension to propose a user action which would create or update objects on multiple classes at once?
A: Yes, this extension can be one part of the solution. In addition you will need to write you own extension to provide that complex action as a PHP method on the class on which the user will trigger the action.

An exemple a customer to whom you deliver services, is terminating its contract, as a result, you would like to close all the tickets open by its users, set all its contact status to inactive, disable all its user account, set all its CDMB owned CIs to obsolete and so on… For this you will need to write a PHP method for eg on the Organization class. That method will called by an action on the details of the Organization. So the User will trigger that Terminate customer action on the organization he wants to terminate.

class:Organization

public function TerminateCustomer()
{
   $iOrgID = $this->GetKey();
   // Desactivate Contacts
   $oSet = new CMDBObjectSet(DBObjectSearch::FromOQL("SELECT Contact WHERE org_id =$iOrgID"));
   while ($oContact = $oSet->Fetch())
   {
       $oContact->Set('status','inactive');
       $oContact->DBUpdate();
   }
   // Disable Users
   $oSet = new CMDBObjectSet(DBObjectSearch::FromOQL("SELECT User WHERE org_id =$iOrgID"));
   while ($oUser = $oSet->Fetch())
   {
       $oUser->Set('status','disabled');
       $oUser->DBUpdate(); 
   }
   // Auto-resolve UserRequests
   $oSet = new CMDBObjectSet(DBObjectSearch::FromOQL(
     "SELECT UserRequest WHERE org_id =$iOrgID AND status IN ('new','assigned','pending','approved')"
   ));
   while ($oUserRequest = $oSet->Fetch())
   {
       $oUserRequest->ApplyStimulus('ev_autoresolve');
       // No need to call DBUpdate(), it's done within ApplyStimulus 
   }
   // Other automations...
}

Then add an entry in the Configuration File, to display that action to the users with enough rights to do it

config-itop.php

'combodo-custom-hyperlinks' => array (
    'hyperlinks' => array (  
        'Organization' => array (
                'terminate_customer' => array (
                      'label' => 'Terminate Customer',
                      'url' => 'method://TerminateCustomer()',
                      'scope' => 'SELECT Organization',
                      'allowed_profiles' => 'Administrator',
                      'icon' => 'fas fa-skull-crossbones',
                      'contexts' => 'backoffice',
                ),
        ),
    ),
),