Design and implementation of the platform supporting translation of business applications written in .NET technology

Problemem, przed którym stanęliśmy przed napisaniem tej pracy było stworzenie narzędzia ułatwiającego kooperacje programistów, tłumaczy oraz użytkowników w internacjonalizacji aplikacji WEBCON BPS. Praca ta jest wynikiem współpracy między studentami Wydziału Matematyki i Informatyki Uniwersytetu Jagiellońskiego z krakowską firmą WEBCON, dla której właśnie został stworzony BPS Translator. Przedstawiamy w niej zarówno teoretyczną wiedzę na temat lokalizacji oprogramowania jak i praktyczny projekt i implementację naszej aplikacji. Cześć opisanych oraz wykorzystanych przez nas rozwiązań ma charakter uniwersalny i można je wykorzystać przy pracy nad oprogramowaniem wspomagającym tłumaczenie dowolnej aplikacji w technologii .NET. W pracy tej na początku krótko przedstawimy technologie oraz wzorce projektowe wykorzystywane podczas pracy nad projektem oraz tą pracą. Omówimy między innymi uniwersalny język modelowania, schemat architektury serwisów REST oraz jeden z najbardziej popularnych wzorców architektonicznych jakim jest MVC (model-widok-kontroler). Następnie opisane zostaną zasady działania oraz sposób implementacji lokalizacji oprogramowania w aplikacjach .NET. Tu opiszemy takie pojęcia jak pliki „resource”, „satellite assemblies”, GAC. Po tej teoretycznej części przejdziemy do praktycznego projektu systemu BPS Translator. W pierwszej kolejności wymienione zostaną wymagania funkcjonalne. Mamy tu na myśli takie rzeczy jak: możliwość tłumaczenia fraz, możliwość eksportu i importu fraz do i z plików Excel, podgląd historii zmian danej frazy, możliwość synchronizacji bazy danych z systemem TFS, ustawianie tłumaczeń użytkowników jako domyślne dla danego języka, logowanie za pomocą kont Google. Następnie opisana zostanie wysokopoziomowa architektura systemu. Podział aplikacji na część WWW, serwis REST, moduł do synchronizacji z TFS. W kolejnych rozdziałach przejdziemy do opisów implementacji wybranych funkcjonalności systemu. Sprecyzujemy ich wymagania, wykorzystując diagramy UML, przedstawimy projekty oraz opiszemy napotkane problemy wraz z ich rozwiązaniami. Dalej umieściliśmy projekty interfejsu oraz podręcznik użytkownika opisujący posługiwanie się stworzonym przez nas narzędziem. Zawiera on zrzuty ekranu oraz szczegółowy opis czynności potrzebnych do osiągniecia konkretnego celu. Na samym końcu zaś umieściliśmy krótki rozdział o organizacji pracy naszego zespołu. Opiszemy jak wykorzystywaliśmy i co to jest tzw. Kanban czyli popularna zwinna metodyka wytwarzania oprogramowania.

The problem we had to face before writing this publication was to create a tool that would help cooperate programmers, translators and users in internationalization of WEBCON BPS software. We describe both theoretical knowledge about software localization and practical design and implementation of our aplication. Some of the described solutions are universal and they can be used in any project with similar goals and written in .NET technology. At the beginning we will shortly introduce the ideas of architecture patterns, and technologies we used during our work. To name a few: UML (Universal Modeling Language), REST services, and one of the most popular patterns – MVC (Model-View-Controller). Then we describe how does the software localization in .NET works. We will familiarize the reader with terms such as: „resources files”, „satellite assemblies” and „Global assembly cache” shortly GAC. After this theoretical introduction its time to describe our design and implementation of such application, we called ours BPS Translator. Firstly, we will specify the functional requirements, for example: translating phrases, synchronization between database and TFS server, exporting and importing phrases to Excel files, showing the history of phrase changes during time, using ones translations as default for other users in specified language, ability to log in using Google accounts. Secondly we further specify and describe those requirements using UML diagrams, we will describe problems that occurred during implementation. After that there is a user guide which we made after finishing BPS Translator. It contains details about how to use our application, including print screens and step-by-step tutorials. Finally, we describe famous agile methodology Kanban and how we use it during working on BPS Translator.