Difference between revisions of "Site Integration Services"

From Hornbill
Jump to navigation Jump to search
Line 19: Line 19:
 
* CPU load is minimal
 
* CPU load is minimal
 
* Can be run on virtual as well as physical machines.
 
* Can be run on virtual as well as physical machines.
 
{{infobox|The SIS is capable of deploying ITOM Packages on those 32 and 64 bit Windows operating systems currently supported by Microsoft. Depending on the content of the package, there may be additional OS requirements}}
 
  
 
===Connectivity===
 
===Connectivity===
Line 27: Line 25:
 
* Proxies are not yet supported by the SIS.
 
* Proxies are not yet supported by the SIS.
  
== Site Integration Services List ==
+
===Discovery and Deployment===
{{Bullet1|Name|The name of the Connector, provided when setting up}}
+
The SIS is capable of discovering all Windows machines and deploying ITOM Packages on those 32 and 64 bit Windows operating systems currently supported by Microsoft. Depending on the content of the package, there may be additional OS requirements}}
{{Bullet1|Group|Name of the Group that the Connector is a member of}}
 
{{Bullet1|Description|Provided when creating the Connector, to provide further details about the Connector and the linked SIS}}
 
{{Bullet1|Service Type|Shows the operating system architecture of the Server hosting the SIS installation (64 or 32-bit)}}
 
{{Bullet1|Service State|Lets you enable or disable the SIS}}
 
{{Bullet1|Online Status|Displays the current status.}} 
 
{{Bullet1|Service Build|Displays the SIS Server version.  Any Service showing an older build may highlight that there is an issue with automatic updates for that service}}
 
{{Bullet1|Last Seen On|This will display the last time there was communication between the Hornbill SIS Service and the SIS Server}}
 
  
== SIS Tool Bar ==
+
== Download the Hornbill SIS==
{{Bullet1|Refresh|A refresh of the list may be required to display any new devices discovered while you are viewing the list}}
+
The Hornbill SIS package can be downloaded from Hornbill Administration via '''''Home > ITOM > Site Integration Services''''' and clicking the button labelled "Download Site Integration Server". The SIS package is downloaded as an executible (.exe).
{{Bullet1|Show|Displays Connectors from the selected Group}}
 
{{Bullet2|+ Create Group|Selectable via the drop-dwon, allows for the Creation of Groups'}}
 
{{Bullet1|Paired / Not Paired|Toggle button that allows the display of '''Paired''' or '''Not Paired''' SIS}}
 
{{Bullet1|Download Site Integration Server|Downloads the on premise SIS Installer}}
 
{{Bullet1|Move Selected To...|Moves the selected SIS entries to the selected Group}}
 
{{Bullet1|Create List|Create a new list for managing or grouping devices}}
 
{{Bullet1|[[File:NewPackageButton.png|23x22px]]|Add a new SIS Connecctor ready for pairing}}
 
{{Bullet1|Delete|Deletes the selected SIS entries}}
 
  
== SIS Groups ==
 
Groups enable servers to be logically grouped together, this allows for the provision of failover protection and load balancing.  The number of SIS installations will be dependant on the environment and potential load.  In many cases, it is envisaged that only a maximum of two will be required, for a typical Windows network.
 
  
{{Bullet1|Load Balancing|When more than one server is placed within a group, Jobs sent to the group for processing will be processed by the next available SIS server spreading the load.}}
+
[[File:ITOM_SIS_Toolbar.JPG|centre|1000px]]
{{Bullet1|Failover protection|SIS servers all poll the Job queue for jobs and thus if a server fails one of the other servers its group will pick the next available job. Any job that is currently being processed by the SIS server will fail and the status will be set to accordingly. If the job has already been pushed to a client and executed then it will potentially be orphaned and the status in the Job queue will be set to Timed-Out.}}
+
<br>
 +
<br>
 +
Description of the options found in the SIS Toolbar (beginning from the left):
 +
:{|
 +
|- valign="top"
 +
|style="width:600px"|
 +
:* '''Refresh''' - A refresh of the list may be required to display any new devices discovered while you are viewing the list
 +
:* '''Show''' - Displays Connectors from the selected Group
 +
:* '''+ Create Group''' - (Selectable via the drop-down) allows for the Creation of SIS Groups'
 +
:* '''Paired / Not Paired''' - Toggle button that allows the display of '''Paired''' or '''Not Paired''' SIS
 +
|style="width:600px"|
 +
:* '''Download Site Integration Server''' - Downloads the on premise SIS Installer
 +
:* '''Move Selected To...''' - Moves the selected SIS entries to the selected Group
 +
:* [[File:NewPackageButton.png|23x22px]] - Add a new SIS Connector
 +
:* '''Delete''' - Deletes the selected SIS entries
 +
|}
 +
 
 +
<br>
  
{{infobox|If a standalone SIS server fails then all jobs aimed at that server will be left in the Job queue and will not be processed until the server is up and running again.}}
+
== Install the Hornbill SIS==
=== Creating a Group ===
+
[[File:InstallerPage.png|300px|thumb|right|<div align="center">'''Click "Install" to begin installing the SIS'''</div>]]
[[File:SISCreateGroupOption.png|164×139px|right]]
+
[[File:StartSisMmcService.png|300px|thumb|right|link=https://wiki.hornbill.com/images/c/ca/StartSisMmcService.png|<div align="center">'''The Site Integration Service is installed as a Windows NT Service called "ESPSisService"'''</div>]]
# From the ITOM page select Site Integration Services
+
Once downloaded, the Hornbill SIS is installed as a Windows NT Service. Local administration rights will be required on the computer where the SIS is to be installed.
# Click the '''Show''' dropdown
+
<br>
# Click '''+Create Group''' option
+
<br>
# Enter the '''New Group Name'''
+
<ol style="list-style-type: decimal;">
# Click '''Apply'''
+
<li>Locate the downloaded executable and double click to begin</li>
 +
<li>Click Install</li>
 +
<li>Click Ok to Confirm the Installation</li>
 +
<li>Close the Install dialog</li>
 +
<li>Open the Services MMC Console</li>
 +
<li>Start the '''EspSisService'''</li></ol>
 
<br>
 
<br>
 
<br>
 
<br>
  
== SIS Connector ==
+
== Creating a SIS Connector in your Hornbill Instance==
=== Adding an SIS Connector ===
 
 
<ol style="list-style-type: decimal;">
 
<ol style="list-style-type: decimal;">
<li>From the ITOM page select '''Site Integration Services'''</li>
+
<li>Navigate to '''Hornbill Administration > Home > ITOM > Site Integration Services'''</li>
<li>Click the “'''Add SIS connector'''” [[File:NewPackageButton.png|23x22px]] button</li>
+
<li>Click the [[File:NewPackageButton.png|23x22px]] button to add a new SIS Connector</li>
 
<li>Enter the following details:
 
<li>Enter the following details:
 
<ol style="list-style-type: none;">
 
<ol style="list-style-type: none;">
Line 79: Line 81:
 
<ol start="5" style="list-style-type: decimal;">
 
<ol start="5" style="list-style-type: decimal;">
 
<li>The Authorisation Key is displayed, and should be recorded for later use</li>
 
<li>The Authorisation Key is displayed, and should be recorded for later use</li>
<li>Return to the '''Site Integration Services''' list</li>
+
<li>See the next section for details of how to pair your SIS with your Hornbill instance</li>
<li>Select the '''Not Paired''' filter</li></ol>
+
<li>Should you choose not to complete the pairing at this time, the connector can be found by selecting the '''Not Paired''' filter in your list of SIS Connectors</li></ol>
  
{{infobox|The Authorisation Key is temporary and will expire after 1 hour, and the SIS record is removed.}}
+
{{infobox|The Authorisation Key is valid for 1 hour. Should the SIS connector and SIS installation not be paired during this time, the key will expire and the unpaired SIS connector will be removed}}
 
 
== Download and Install Hornbill SIS==
 
[[File:StartSisMmcService.png|411x141px|right|link=https://wiki.hornbill.com/images/c/ca/StartSisMmcService.png]]
 
 
 
The Hornbill SIS package once downloaded from the Hornbill Instance in the form of Windows executable, will need to be installed. Installation requires local administration rights will be required on the computer to install the SIS as a Windows NT Service.
 
  
 +
== Pairing a SIS with your Hornbill instance ==
 +
Once the ESPSisService is running, you can begin the process of pairing it to your Hornbill instance.
 +
<br>
 +
<br>
 
<ol style="list-style-type: decimal;">
 
<ol style="list-style-type: decimal;">
<li>From the '''Site Integration Services''' list, Click the '''Download Site Integration Server'''</li>
+
<li>Open the Browser and navigate to <nowiki>http://localhost:11117</nowiki>. If you're already there, refresh the page</li>
<li>Locate and Execute the Downloaded executable</li></ol>
+
<li>After several seconds, you will be prompted for your instance id and an authorization code</li>
<blockquote>[[File:InstallerPage.png|328x200px]]</blockquote>
+
<li>If you already have an authorization code, skip to step 10, otherwise continue with the next step.</li>
<ol start="3" style="list-style-type: decimal;">
+
<li>To obtain an Authorization code, a new SIS connector must be added to the SIS list in '''Hornbill Administration > Home > ITOM > Site Integration Services'''</li>
<li>Click Install</li>
+
<li>At the top right of the list in Hornbill Administration, click the "+" button to add a new SIS connector</li>
<li>Click Ok to Confirm the Installation</li>
+
<li>Add an appropriate name and description and click "Add Site Integration Service Connector"</li>
<li>Close the Install dialog</li>
+
<li>Details of the new SIS entry will appear, including an Authorization code.</li>
<li>Open the Services MMC Console</li>
+
<li>Copy the Authorization code</li>
<li>Start the '''EspSisService'''</li></ol>
+
<li>Return to the SIS pairing page page <nowiki>http://localhost:11117</nowiki></li>
 +
<li>Enter the instance ID and authorization code</li></li>
 +
<li>Click the '''Pair with Instance''' button</li></ol>
 +
<gallery class="center">
 +
File:ITOM_Hornbill_Site_Integration_Server_Localhost.JPG|Your Instance ID and a valid authorization code are required to pair a SIS with your Hornbill instance
 +
File:SISHomePage.png|Once paired, the status of the SIS can be viewed at <nowiki>http://localhost:11117</nowiki>
 +
</gallery>
 +
== Managing the List of Site Integration Services==
 +
Any Site Integration Service connectors you have created can be viewed and managed in the SIS list found in '''''Hornbill Administration > Home > ITOM > Site Integration Services'''''. The list displays the following information:
 +
:* '''Name''' - the name of the Connector (provided when first created)
 +
:* '''Group''' - displays the group that the Connector belongs to
 +
:* '''Description''' - displays any further detail you've provided about the connector
 +
:* '''Service Type''' - shows the operating system architecture of the Server hosting the SIS installation (64 or 32-bit)}}
 +
:* '''Service State''' - lets you enable or disable the SIS
 +
:* '''Online Status''' - displays the current status.
 +
:* '''Service Build''' - displays the SIS Server version.  Any Service showing an older build may highlight that there is an issue with automatic updates for that service
 +
:* '''Last Seen On'''- this will display the last time there was communication between the Hornbill SIS Service and the SIS Server
 +
<br>
 +
<br>
 +
== Grouping Site Integration Servers ==
 +
The creation of groups enable SIS connectors, and thus SIS installations, to be logically grouped together. A group can consist of a single SIS. Multiple SIS installations may be necessary depending on the environment and potential load and also allows for the provision of failover protection. The number of SIS installations will be dependant on the environment and your needs.
  
===Server Pairing===
+
{{Bullet1|Load Balancing|When more than one server is placed within a group, Jobs sent to the group for processing will be processed by the next available SIS server spreading the load.}}
[[File:SISHomePage.png|479x297px|right]]
+
{{Bullet1|Failover protection|SIS servers all poll the Job queue for jobs and thus if a server fails one of the other servers its group will pick the next available job.  Any job that is currently being processed by the SIS server will fail and the status will be set to accordingly.  If the job has already been pushed to a client and executed then it will potentially be orphaned and the status in the Job queue will be set to Timed-Out.}}
<ol style="list-style-type: decimal;">
 
<li>Switch back to the Browser and refresh the page (http://localhost:11117)</li></ol>
 
  
<blockquote>[[File:SISPairWithInstance.png|252x162px]]
+
{{infobox|If a standalone SIS server fails then all jobs aimed at that server will be left in the Job queue and will not be processed until the server is up and running again.}}
</blockquote>
+
=== Creating a Group ===
<ol start="2" style="list-style-type: decimal;">
+
[[File:SISCreateGroupOption.png|164×139px|right]]
<li>Enter the instance ID</li>
+
# From the ITOM page select Site Integration Services
<li>Enter the Authorization Code recorded earlier</li>
+
# Click the '''Show''' dropdown
<li>Click the '''Pair with Instance''' button</li></ol>
+
# Click '''+Create Group''' option
 +
# Enter the '''New Group Name'''
 +
# Click '''Apply'''
 +
<br>
  
 
[[Category:ITOM]]
 
[[Category:ITOM]]

Revision as of 19:01, 9 June 2020

Home > Administration > ITOM > Site Integrations Services Index

Introduction

Hornbill's Site Integration Service (SIS) is a package that needs to be installed on a server within your organization. It runs as a standard Windows NT Service and once paired with your Hornbill instance, monitors the ITOM Job Queue for any jobs that it needs to execute. The SIS polls the paired Hornbill instance every 5 seconds, acting as the heartbeat to the cloud.

The SIS is self updating and is accessible via a web page, which allows for the initial pairing and display of the current status of the service.

Should jobs be detected during a polling interval, the SIS pulls all information from the paired instance with regards to the jobs that are required to be undertaken on specified devices on the network. There are currently two types of job that can be initiated; Computer Discovery and IT Automation. Automation jobs are powered via pre-built packages provided by Hornbill or can be custom-built using the ITOM Package Creator.

Related Articles

Technical Considerations

System Requirements

  • OS: Windows Server 2012, 2012 R2, 2016 or 2019
  • RAM: 4GB
  • Free Disk: 10GB
  • CPU load is minimal
  • Can be run on virtual as well as physical machines.

Connectivity

  • The SIS communicates with your Hornbill instance using HTTPS.
  • Your Hornbill instance will only respond to pings from a paired SIS.
  • Proxies are not yet supported by the SIS.

Discovery and Deployment

The SIS is capable of discovering all Windows machines and deploying ITOM Packages on those 32 and 64 bit Windows operating systems currently supported by Microsoft. Depending on the content of the package, there may be additional OS requirements}}

Download the Hornbill SIS

The Hornbill SIS package can be downloaded from Hornbill Administration via Home > ITOM > Site Integration Services and clicking the button labelled "Download Site Integration Server". The SIS package is downloaded as an executible (.exe).


ITOM SIS Toolbar.JPG



Description of the options found in the SIS Toolbar (beginning from the left):

  • Refresh - A refresh of the list may be required to display any new devices discovered while you are viewing the list
  • Show - Displays Connectors from the selected Group
  • + Create Group - (Selectable via the drop-down) allows for the Creation of SIS Groups'
  • Paired / Not Paired - Toggle button that allows the display of Paired or Not Paired SIS
  • Download Site Integration Server - Downloads the on premise SIS Installer
  • Move Selected To... - Moves the selected SIS entries to the selected Group
  • NewPackageButton.png - Add a new SIS Connector
  • Delete - Deletes the selected SIS entries


Install the Hornbill SIS

Click "Install" to begin installing the SIS
The Site Integration Service is installed as a Windows NT Service called "ESPSisService"

Once downloaded, the Hornbill SIS is installed as a Windows NT Service. Local administration rights will be required on the computer where the SIS is to be installed.

  1. Locate the downloaded executable and double click to begin
  2. Click Install
  3. Click Ok to Confirm the Installation
  4. Close the Install dialog
  5. Open the Services MMC Console
  6. Start the EspSisService



Creating a SIS Connector in your Hornbill Instance

  1. Navigate to Hornbill Administration > Home > ITOM > Site Integration Services
  2. Click the NewPackageButton.png button to add a new SIS Connector
  3. Enter the following details:
    1. Name - name used to identify the SIS server to the Hornbill Instance
    2. Group - Should be a least one default group, others can be selected via drop down if created previously
  4. Click the Create Site Integration Service button

Image: 350 pixels

  1. The Authorisation Key is displayed, and should be recorded for later use
  2. See the next section for details of how to pair your SIS with your Hornbill instance
  3. Should you choose not to complete the pairing at this time, the connector can be found by selecting the Not Paired filter in your list of SIS Connectors
Information
The Authorisation Key is valid for 1 hour. Should the SIS connector and SIS installation not be paired during this time, the key will expire and the unpaired SIS connector will be removed

Pairing a SIS with your Hornbill instance

Once the ESPSisService is running, you can begin the process of pairing it to your Hornbill instance.

  1. Open the Browser and navigate to http://localhost:11117. If you're already there, refresh the page
  2. After several seconds, you will be prompted for your instance id and an authorization code
  3. If you already have an authorization code, skip to step 10, otherwise continue with the next step.
  4. To obtain an Authorization code, a new SIS connector must be added to the SIS list in Hornbill Administration > Home > ITOM > Site Integration Services
  5. At the top right of the list in Hornbill Administration, click the "+" button to add a new SIS connector
  6. Add an appropriate name and description and click "Add Site Integration Service Connector"
  7. Details of the new SIS entry will appear, including an Authorization code.
  8. Copy the Authorization code
  9. Return to the SIS pairing page page http://localhost:11117
  10. Enter the instance ID and authorization code
  11. Click the Pair with Instance button

Managing the List of Site Integration Services

Any Site Integration Service connectors you have created can be viewed and managed in the SIS list found in Hornbill Administration > Home > ITOM > Site Integration Services. The list displays the following information:

  • Name - the name of the Connector (provided when first created)
  • Group - displays the group that the Connector belongs to
  • Description - displays any further detail you've provided about the connector
  • Service Type - shows the operating system architecture of the Server hosting the SIS installation (64 or 32-bit)}}
  • Service State - lets you enable or disable the SIS
  • Online Status - displays the current status.
  • Service Build - displays the SIS Server version. Any Service showing an older build may highlight that there is an issue with automatic updates for that service
  • Last Seen On- this will display the last time there was communication between the Hornbill SIS Service and the SIS Server



Grouping Site Integration Servers

The creation of groups enable SIS connectors, and thus SIS installations, to be logically grouped together. A group can consist of a single SIS. Multiple SIS installations may be necessary depending on the environment and potential load and also allows for the provision of failover protection. The number of SIS installations will be dependant on the environment and your needs.

  • Load Balancing
When more than one server is placed within a group, Jobs sent to the group for processing will be processed by the next available SIS server spreading the load.
  • Failover protection
SIS servers all poll the Job queue for jobs and thus if a server fails one of the other servers its group will pick the next available job. Any job that is currently being processed by the SIS server will fail and the status will be set to accordingly. If the job has already been pushed to a client and executed then it will potentially be orphaned and the status in the Job queue will be set to Timed-Out.
Information
If a standalone SIS server fails then all jobs aimed at that server will be left in the Job queue and will not be processed until the server is up and running again.

Creating a Group

164×139px
  1. From the ITOM page select Site Integration Services
  2. Click the Show dropdown
  3. Click +Create Group option
  4. Enter the New Group Name
  5. Click Apply