The wiki is deprecated and due to be decommissioned by the end of September 2022.
The content is being migrated to other supports, new updates will be ignored and lost.
If needed you can get in touch with EGI SDIS team using operations @ egi.eu.
Difference between revisions of "GGUS:GridMessaging Interface FAQ"
Jump to navigation
Jump to search
| (4 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
{{DEFAULTSORT:{{PAGENAME}}}} | {{DEFAULTSORT:{{PAGENAME}}}} | ||
Interface decommissioned | |||
<!-- | |||
[[Category:FAQ Interfaces (GGUS)]] | [[Category:FAQ Interfaces (GGUS)]] | ||
<hr />'''FAQ for the Interface between GGUS and GridMessaging''' | <hr />'''FAQ for the Interface between GGUS and GridMessaging''' | ||
; Updated: 2011-10-12 | ; Updated: 2011-10-12 | ||
==Purpose== | |||
GGUS system is offering various kinds of interfaces to remote systems up to now. The number of interfaces has increased during the last years. For avoiding an ongoing increase of different interface types GGUS wants to offer a generic standard interface for the future. This interface will be Grid Messaging. It will be used for communication between systems/servers only. | GGUS system is offering various kinds of interfaces to remote systems up to now. The number of interfaces has increased during the last years. For avoiding an ongoing increase of different interface types GGUS wants to offer a generic standard interface for the future. This interface will be Grid Messaging. It will be used for communication between systems/servers only. | ||
==Clients needed== | |||
Two different clients are needed: a consumer client which picks up the messages posted to a topic and a publisher client which posts the messages to the topics. | Two different clients are needed: a consumer client which picks up the messages posted to a topic and a publisher client which posts the messages to the topics. | ||
==Topics to be used== | |||
There are different topics in use depending on the workflows. For the communication from a remote system to the GGUS system (Remote -> GGUS) the topics are: | There are different topics in use depending on the workflows. For the communication from a remote system to the GGUS system (Remote -> GGUS) the topics are: | ||
* /topic/Grid.Ticketing.GGUS.Create for creating new GGUS tickets | * /topic/Grid.Ticketing.GGUS.Create for creating new GGUS tickets | ||
| Line 18: | Line 20: | ||
* /topic/Grid.Ticketing.Create for creating new tickets in remote systems | * /topic/Grid.Ticketing.Create for creating new tickets in remote systems | ||
* /topic/Grid.Ticketing.Update for updating existing tickets in remote systems | * /topic/Grid.Ticketing.Update for updating existing tickets in remote systems | ||
==Work flows== | |||
===Creating a new ticket in GGUS (Remote->GGUS)=== | |||
For creating a new ticket in GGUS system send a create message to topic /topic/Grid.Ticketing.GGUS.Create. In the header of the create message specify the topic to which the GGUS ticket ID should be returned to using option “reply-to”. GGUS system returns the ID by posting a message to the specified topic. For getting the possible values for the fields please see item 35407 of this document. | For creating a new ticket in GGUS system send a create message to topic /topic/Grid.Ticketing.GGUS.Create. In the header of the create message specify the topic to which the GGUS ticket ID should be returned to using option “reply-to”. GGUS system returns the ID by posting a message to the specified topic. For getting the possible values for the fields please see item 35407 of this document. | ||
Mandatory fields for creating a new GGUS ticket are “Short Description” and “Last Modifier”. | Mandatory fields for creating a new GGUS ticket are “Short Description” and “Last Modifier”. | ||
| Line 31: | Line 33: | ||
:For assigning a new ticket to a support unit directly please specify the support unit in field “Responsible_Unit” or the site in field “Notify_Site”. If a site name is specified in field “Notify_Site” the related ROC is set in field “Responsible_Unit” automatically. This workflow is described in a twiki page at https://twiki.cern.ch/twiki/bin/view/EGEE/SA1_USAG#Direct_routing_to_sites_faq. | :For assigning a new ticket to a support unit directly please specify the support unit in field “Responsible_Unit” or the site in field “Notify_Site”. If a site name is specified in field “Notify_Site” the related ROC is set in field “Responsible_Unit” automatically. This workflow is described in a twiki page at https://twiki.cern.ch/twiki/bin/view/EGEE/SA1_USAG#Direct_routing_to_sites_faq. | ||
:Information about the support units implemented in GGUS is available at the GGUS [https://ggus.eu/pages/resp_unit_info.php Responsible Unit Info]. | :Information about the support units implemented in GGUS is available at the GGUS [https://ggus.eu/pages/resp_unit_info.php Responsible Unit Info]. | ||
The templates used are available [[#Creating a new ticket in GGUS system (Remote->GGUS)|here]]. | |||
===Updating an existing ticket in GGUS (Remote->GGUS)=== | |||
Ticket updates are sent to topic /topic/Grid.Ticketing.GGUS.Update. They have to contain the GGUS ticket ID as mandatory field. | Ticket updates are sent to topic /topic/Grid.Ticketing.GGUS.Update. They have to contain the GGUS ticket ID as mandatory field. | ||
The templates used are available [[#Updating an existing ticket in GGUS system (Remote->GGUS)|here]]. | |||
===Creating a new ticket in a remote system (GGUS->Remote)=== | |||
:GGUS sends create messages to topic /topic/Grid.Ticketing.Create for creating new tickets in remote systems. In the header of the create message GGUS specifies the topic to which the ticket ID should be returned to using option “reply-to”. Usually the topic for returning the ticket ID is /topic/Grid.Ticketing.GGUS.Reply. | :GGUS sends create messages to topic /topic/Grid.Ticketing.Create for creating new tickets in remote systems. In the header of the create message GGUS specifies the topic to which the ticket ID should be returned to using option “reply-to”. Usually the topic for returning the ticket ID is /topic/Grid.Ticketing.GGUS.Reply. | ||
The templates used are available [[# | The templates used are available [[#Creating a ticket in a remote ticketing system (GGUS->Remote)|here]]. | ||
===Updating an existing ticket in a remote system (GGUS->Remote)=== | |||
:Updates on existing tickets in remote systems are pushed to topic /topic/Grid.Ticketing.Update. | :Updates on existing tickets in remote systems are pushed to topic /topic/Grid.Ticketing.Update. | ||
The templates used are available [[#Updating a ticket in a remote ticketing system (GGUS->Remote)|here]]. | |||
All messages should consist of key-value pairs. They vary depending on the action to be done (create, update). The meaning of each key is described as well as the meanings of the various fields in the [[#Message_templates]] section. | ==Message formats== | ||
All messages should consist of key-value pairs. They vary depending on the action to be done (create, update). The meaning of each key is described as well as the meanings of the various fields in the [[#Message_templates|templates]] section. | |||
All comments are marked with “//”. | All comments are marked with “//”. | ||
==Message templates== | |||
===Creating a new ticket in GGUS system (Remote->GGUS)=== | |||
::Schema:: Grid:HelpDesk20090421 //don't change this | ::Schema:: Grid:HelpDesk20090421 //don't change this | ||
::Action:: Create //don't change this | ::Action:: Create //don't change this | ||
| Line 62: | Line 67: | ||
::Mail:: //submitter mail | ::Mail:: //submitter mail | ||
::END:: //don't change this | ::END:: //don't change this | ||
===Updating an existing ticket in GGUS system (Remote->GGUS)=== | |||
::Schema:: Grid:HelpDesk20090421 //don't change this | ::Schema:: Grid:HelpDesk20090421 //don't change this | ||
::Action:: Modify //don't change this | ::Action:: Modify //don't change this | ||
| Line 80: | Line 85: | ||
::VO_Specific:: Yes|No | ::VO_Specific:: Yes|No | ||
::END:: //don't change this | ::END:: //don't change this | ||
===Returning the ticket ID from a remote system to GGUS system (Remote->GGUS)=== | |||
::Schema:: Grid:HelpDesk20090421 | ::Schema:: Grid:HelpDesk20090421 | ||
::Sender:: //name of sending support unit|system | ::Sender:: //name of sending support unit|system | ||
| Line 88: | Line 93: | ||
::Last_Modifier:: //name of last modifier | ::Last_Modifier:: //name of last modifier | ||
::END:: //don't change this | ::END:: //don't change this | ||
===Returning the GGUS ticket ID to a remote system (GGUS->Remote)=== | |||
::Schema:: Grid:HelpDesk20090421 | ::Schema:: Grid:HelpDesk20090421 | ||
::Sender:: GGUS | ::Sender:: GGUS | ||
| Line 96: | Line 101: | ||
::Last_Modifier:: //name of last modifier | ::Last_Modifier:: //name of last modifier | ||
::END:: //don't change this | ::END:: //don't change this | ||
===Creating a ticket in a remote ticketing system (GGUS->Remote)=== | |||
::Schema:: Grid:HelpDesk20090421 | ::Schema:: Grid:HelpDesk20090421 | ||
::Action:: Create | ::Action:: Create | ||
| Line 116: | Line 121: | ||
::Mail:: //submitter mail | ::Mail:: //submitter mail | ||
::END:: //don't change this | ::END:: //don't change this | ||
===Updating a ticket in a remote ticketing system (GGUS->Remote)=== | |||
::Schema:: Grid:HelpDesk20090421 | ::Schema:: Grid:HelpDesk20090421 | ||
::Action:: Modify | ::Action:: Modify | ||
| Line 134: | Line 139: | ||
::END:: //don't change this | ::END:: //don't change this | ||
==Documentation on GridMessaging== | |||
https://twiki.cern.ch/twiki/bin/view/EGEE/MsgTutorial | https://twiki.cern.ch/twiki/bin/view/EGEE/MsgTutorial | ||
== What if I have questions which are not dealt with by this FAQ? == | == What if I have questions which are not dealt with by this FAQ? == | ||
Open a {{GGUS ticket}} indicating that it should be directed at the | Open a {{GGUS ticket}} indicating that it should be directed at the GGUS team. | ||
{{GGUS search}} | {{GGUS search}} | ||
--> | |||
