Support for additional connectors (ConfigItemConnector, FAQConnector) about python-otrs HOT 10 CLOSED

To clarify, there are three levels of objects
the client (an instance of GenericInterfaceClient), which contains one or more instances of the WebService object (normally just one, the ticketconnector, tc). The WebService object contains one or more Operation objects (TicketGet, TicketCreate, etc.). It is therefore structured just like OTRS itself (you have a webservice, and have operations inside that webservice).

After writing a configitem interface, one could use the same client to access both interfaces, example:

server_uri = r'https://otrs.example.net'
ticket_webservice_name = 'GenericTicketConnectorSOAP'
configitem_webservice_name = 'GenericConfigItemConnectorSOAP'
client = GenericInterfaceClient(server_uri, tc=GenericTicketConnectorSOAP(ticket_webservice_name), cic=GenericConfigItemConnectorSOAP(configitem_webservice_name))

After this can call both
client.tc.TicketGet(13)
to get a ticket 13 or
client.cic.ConfigItemGet(1000022)
to get otrs itsm config item # 1000022

It is also structured so that the user can make their own custom web service object and add whatever operations they want to it, rather than the generic ones, so the same customization options available in OTRS to make this more in line with the OTRS web service design.

from python-otrs.

here are the new yml files from otrs:

https://github.com/OTRS/otrs/blob/master/development/webservices/GenericTicketConnectorSOAP.yml
(older versions were called GenericTicketConnector.yml)

http://blog.otrs.org/wp-content/uploads/2014/11/GenericConfigItemConnectorSOAP.yml_.txt

from python-otrs.

I've started work on the ConfigItemConnector interface; I would have ConfigItemGet working already, unfortunately there seems to be a bug in OTRS where it is pulling the correct ConfigItem but fails to properly format it as SOAP output, so I've opened a bug report.

from python-otrs.

I've added support for GenericFAQConnectorSOAP and submitted a pull request as a result. Still need to add support for GenericConfigItemConnectorSOAP, after OTRS fixes their bug.

from python-otrs.

Thanks for the hard work and the updates. I'll look into it soon (probably later this week).

Erwin

from python-otrs.

@mjducharme
Thanks again :).
I merged your pull-request into a separate branch and made some additional changes (mostly linting, removed some unused imports and added some imports that were missing).

I will do some more testing/refinement in the near future before merging this into the master branch and create a new release. If you also do some changes meanwhile, you can make a pull request to this branch.

Backward compatibility is not that big of an issue for me, yet you seem to have handled it nicely so I'll keep it like this, maybe will add an extra section to the README.

Kind regards,
Erwin

from python-otrs.

Excellent, this is great, lots of useful comments. There were a few comments that you added that are slightly inaccurate:

• In otrs/client.py, lines 131 and 136 comments should be "of the clientobject of the WebService object", not just "of WebService object".
• The soap_envelope comment is wrong on line 141, I think you copied and pasted and forgot to change. It should say """Return soap envelope for WebService object"""

I might look into the OTRS bug myself regarding the ConfigItem connector, because they don't seem to be in a hurry to fix it.

from python-otrs.

Updated the comments with your remarks and added the ssl_context in the same way as the loginname and password.

from python-otrs.

Good catch on the ssl_context, my server doesn't have SSL so I couldn't test that bit when I was coding.

from python-otrs.

To do in near future:

• create a new release before these changes
• merge this into the master branch
• create a new release including these changes

To do beforehand:

• Manually test the FAQ connector
• Clear up Issue 22
• Try to remember how to publish to pypi ;)

from python-otrs.