Customers can write the code required for the third party integration in the class specified. ( TFSActionInterface in this example ). The details of the request in the form of JSON would be passed to this class so that the informations can be used to perform the operation in the other application.
In the Request details page, it would be available as a menu under the Action's dropdown.
On clicking the menu item, the customer's class would be invoked with the request information. If customers want to update any field in the specific request after performing the operation or add a note, then it can be done by returning a JSON in the format specified below
- {
- "message" : "TFS request created with reference ID 45678",
- "operation" :[
- {
- "INPUT_DATA":[
- {
- "TFS Reference ID":"45678",
- }],
- "OPERATIONNAME":"EDIT_REQUEST"
- }]
- }
The above is a sample to update a request field "TFS Reference ID" once the external operation is performed. Similar to this, notes too can be added as follows
- {
- "message":"TFS ticket created successfully",
- "operation":[
- {
- "INPUT_DATA":[
- {
- "notes":{
- "notesText":"Ticket has been created in TFS and informtaion has been updated in ServiceDesk"
- }
- }],
- "OPERATIONNAME":"ADD_NOTE"
- }]
- }
With this integration in place, now the technician just needs to click the menu to perform the operation instead of doing it manually all the time.
We are also working on providing a default sample integration with JIRA. We are coming up with detailed documents for the base framework and the JIRA integration which will be ready in a couple of days.
In the meantime, we would like to know what such kind of integrations would be needed in customer environments based on which we can enhance this feature further.
Thanks
Shanmugam PL