User Tools

Site Tools


msp_remedy_endpoint

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
msp_remedy_endpoint [2018/07/10 13:59]
robyn.lin
msp_remedy_endpoint [2018/09/17 14:26] (current)
robyn.lin
Line 1: Line 1:
 +==== Installation ====
 +
 +Please refer to the MSP Gateway home page for installation/​setup instructions.
 +
 +[[http://​wiki.perspectium.com/​doku.php?​id=msp_manage_customers|MSP Gateway]]
 +
 ==== Creating a New Customer Endpoint (Remedy) ==== ==== Creating a New Customer Endpoint (Remedy) ====
  
-Click on the blue New button on MSP Customer Endpoints. This will open the following form: +Click on the blue New button on MSP Customer Endpoints, or navigate to the Add Customer tab under the Perspectium MSP application menu. This will open the following form: 
-{{:msp_create_new_endpt.png?600|}}+{{:msp_new_remedy_endpt.png|}}
  
-The Advanced section can be expanded/​collapsed. 
  
-**Customer**: will be pre-populated with the current customer name.+**Company**: will be pre-populated with the current customer name.
  
-**Endpoint Type**: select BMC Remedy in the dropdown menu. +**(EndpointType**: select BMC Remedy in the dropdown menu. 
  
 **ITSM Module**: a dropdown with one choice of Incident Management. **ITSM Module**: a dropdown with one choice of Incident Management.
Line 14: Line 19:
 Currently Incident Management will be the only supported module in MSP Version 1. Currently Incident Management will be the only supported module in MSP Version 1.
 </​WRAP>​ </​WRAP>​
 +
 +**Replication Group**: represents the assignment group for triggering replication of incidents. ​
 +
 +**Integration User**: this field is automatically populated with a generated user based on company name. You can also use the dropdown menu to change the integration user.
  
 **Active**: a checkbox indicating if the endpoint is active or not. **Active**: a checkbox indicating if the endpoint is active or not.
  
 **Endpoint URL**: the customer/​target endpoint URL (if an Endpoint Alias is not specified, this field will be used as the Source/​Target System display name when generating the MSP Mappings table). **Endpoint URL**: the customer/​target endpoint URL (if an Endpoint Alias is not specified, this field will be used as the Source/​Target System display name when generating the MSP Mappings table).
 +
 +**Endpoint Alias**: this field is optional; if you choose to give this endpoint an alias it  will be used as the Source/​Target System display name when generating the MSP Mappings table (instead of the Endpoint URL).
  
 **User/​Password**:​ populate with your Remedy account credentials. **User/​Password**:​ populate with your Remedy account credentials.
  
-**Replication Group**: represents the assignment group for triggering replication of incidents+**Requires Repeater Agent**: defaults to unchecked; if this box is checked, queue request will be true.
  
-**Endpoint Alias**: this field is optional; if you choose to give this endpoint ​an alias it  will be used as the Source/Target System display name when generating the MSP Mappings table (instead ​of the Endpoint URL).+<WRAP round info> 
 +Each customer should have unique Remedy ​endpoint ​URL; save/insert ​of a new endpoint should be blocked in this case. 
 +</​WRAP>​
  
-**Requires Repeater Agent**: defaults to unchecked; if this box is checkedqueue request ​will be true.+====Advanced tab==== 
 +This tab has fields Max RetriesRetry Wait Time, Connection Timeout (these 3 fields ​will be populated with default values), Proxy URL, Proxy User, and Proxy Password.
  
-====MSP Remedy ​Endpoint ​Settings (Scheduled Job)====+====MSP Remedy Settings ​tab (Scheduled Job)====
  
-The Remedy Polling Scheduled Job will query Remedy'​s database for any updated incidentsand will send all updates ​back to ServiceNow. If Endpoint Type is Remedy, an additional section called MSP Remedy Endpoint Settings will appear below (this section can be expanded/​collapsed). This section contains the following field settings for the Remedy Polling Scheduled Job.+The Remedy Polling Scheduled Job will query Remedy'​s database for any updated incidents ​within a time range (the query will check for all records after the specified start date/​time ​and before the current time - 1 minute); it will send all updated incidents (including attachments) ​back to ServiceNow. If the Scheduled Job is able to successfully query Remedy, it will update the last update timestamp value. If it receives a failure response from Remedy, there will be an alert generated in your ServiceNow instance. If Endpoint Type is Remedy, an additional section called MSP Remedy Endpoint Settings will appear below (this section can be expanded/​collapsed). This section contains the following field settings for the Remedy Polling Scheduled Job.
  
-{{:​remedy_endpt_settings.png?​600|}}+{{:​remedy_endpt_settings.png?​|}}
  
 **Remedy Query**: string field with default value of '​Incident Number'​ LIKE \"​INC%"​\. This demonstrates an example of how to structure a query string to search for specific incidents starting with "​INC"​. **Remedy Query**: string field with default value of '​Incident Number'​ LIKE \"​INC%"​\. This demonstrates an example of how to structure a query string to search for specific incidents starting with "​INC"​.
Line 39: Line 53:
 **RemedyAPI Form**: string field with default value of HPD:​IncidentInterface;​ this specifies the Remedy form to query from (similar to a ServiceNow table). **RemedyAPI Form**: string field with default value of HPD:​IncidentInterface;​ this specifies the Remedy form to query from (similar to a ServiceNow table).
  
 +**Remedy Query Timestamp**:​ this field shows the last time Remedy was queried; there is date picker to edit the date/time to start querying from. 
  
-Once you click Save (or Save and Exit), the MSP Endpoint Table with the newly added endpoint will be generated. In addition, the Table Map, Transform Map, Dynamic Share, Shared Queue, and Scheduled Job will automatically be generated for this newly created endpoint configuration. Similarly, if you click on the "Edit Dynamic Share" link, it will direct you to the generated dynamic share. If you click on the "View Import Set Table" link, it will direct you to a list view of the dedicated import set table for this customer endpoint. ​ 
  
-{{:​remedy_cust_endpt.png?​600|}}+Once you click Save (or Save and Exit), the MSP Endpoint Table with the newly added endpoint will be generated. In addition, the Table Map, Transform Map, Dynamic Share, and Shared Queue will automatically be generated for this newly created endpoint configuration. Similarly, if you click on the "Edit Dynamic Share" link, it will direct you to the generated dynamic share. If you click on the "View Import Set Table" link, it will direct you to a list view of the dedicated import set table for this customer endpoint.  
 + 
 +{{:​remedy_cust_endpt.png?​|}}
  
 In addition, the MSP Mappings table will automatically be generated below the endpoint table (see screenshot below). ​ In addition, the MSP Mappings table will automatically be generated below the endpoint table (see screenshot below). ​
  
-{{:​remedy_mappings.png?​600|}}+{{:​remedy_mappings.png?​|}}
  
  
 ===MSP Mappings table=== ===MSP Mappings table===
  
-Describes the bidirectional flow of messages from the Source to Target system. There should be 3 Mapping rows (1 additional row for the source message type of common_incident.comment; this row will link to the Common Comment Incident transform map.) *The rows on the Mappings table cannot be edited.+Describes the bidirectional flow of messages from the Source to Target system. There should be 3 Mapping rows (1 additional row for the source message type of getComments; this row will link to the Common Comment Incident transform map.) *The rows on the Mappings table cannot be edited.
  
-**Source system**: indicates where the message originated from. As mentioned before, if an Endpoint Alias was provided in the endpoint configuration it will be used as the Source ​System ​value.+**Source system**: indicates where the message originated from. As mentioned before, if an Endpoint Alias was provided in the endpoint configuration it will be used as the Source ​system ​value.
  
-**Message**: type of the source message. Remedy has an additional source message type for comments, which is linked to a separate transform map.+**Source format**: type of the source message. Remedy has an additional source message type for comments, which is linked to a separate transform map.
  
-**Maps to**: the "maps to" link will direct you to either the (previously generated) table map or transform map, depending on the direction of the message. ​+**Maps to**: the "maps to" link will direct you to either the (previously generated) table maptransform map, or corresponding SIAM Mapping ​depending on the direction of the message. The "SIAM Mapping (maps to)" link will direct you SIAM Mapping Page where you can view/edit mappings.
  
-If there is no "maps to" and only an arrow, this indicates there is no transformation occurring.+**Target format**: type of the target message.
  
-**Message**: type of the target ​message.+**Target system**: indicates ​the message's target destination. If an Endpoint Alias was specified in the endpoint configuration it will be used as the Target system value, otherwise it will default to the Endpoint URL.
  
-**Target System**: indicates ​the message'​s ​target destinationIf an Endpoint Alias was specified in the endpoint configuration ​it will be used as the Target System valueotherwise it will default to the Endpoint ​URL.+==== Viewing a Customer ==== 
 +To drill into and view endpoint and mapping details for an existing customer from the MSP Customers home page, click on the row with the customer'​s name. This will display all the endpoints for this customer. 
 + 
 +<WRAP round info> 
 +***Note**: if you click the Active checkbox on the top of this customer page, the Dynamic Share(s), Transform Map(s), and Scheduled Job for all the customer'​s ​corresponding endpoints will be activated/​deactivated accordingly to prevent data from flowing in/out 
 +</​WRAP>​ 
 + 
 +To drill into an endpoint configuration ​record, click on a row in the MSP Customer Endpoints table. This will display the endpoint record ​as well as its corresponding mappings. 
 + 
 +{{:​remedy_existing_cust.png|800}} 
 + 
 +<WRAP round info> 
 +***Note**: If you click the Active checkbox to activate or deactivate an endpoint the Dynamic ShareTransform Map, and Scheduled Job for that specific endpoint ​will be activated/​deactivated accordingly.  
 +</​WRAP>​ 
 + 
 +==== Deleting a Customer Endpoint ==== 
 + 
 +Once you click Delete on the MSP Customer ​Endpoint ​record, that specific endpoint and its associated Mappings will be deleted, along with the associated Table Map(s), Transform Map(s), Dynamic Share, and Shared Queue artifacts.  
 + 
 +<WRAP round info> 
 +***Note**: Customers cannot be deleted. 
 +</​WRAP>​
  
  
msp_remedy_endpoint.1531256355.txt.gz · Last modified: 2018/07/10 13:59 by robyn.lin