tm e-filing admin tool user manual - lrpv.gov.lv€¦ · web view31. pielikums. atklāta konkursa...

31. pielikumsAtklāta konkursa “Iekšējā tirgus saskaņošanas biroja Sadarbības fonda ietvaros izstrādātās sistēmas pielāgošana

patentu informācijas sistēmas funkcionalitātei, ieviešana, un savietošana ar eksistējošām sistēmām” NolikumaID Nr. PV 2016/3 Tehniskai specifikācijai

SP Admin-tools User Manual

CF 2.15-19 – Software Package

Version Draft 27/08/2013

Programme/Service COOPERATION FUND (ICLAD)

CF 2.15-19 – Software Package TM e-Filing Admin Tool User Manual

Version historyVersion Date Author Contributors Change Summary

Draft 29/08/2013 DM, AB Document creation

LV Version

28/08/2015 JS Added comments about Latvian version

ReferencesThe documents listed can be found in the relevant application directory.

Ref. Version Date Title

Table 0-1 – References

Applicable DocumentsThe documents listed are applicable throughout the present FAD.

Ref. Version

Date Title

Table 0-2 – Applicable Documents

Table of contents

Introduction................................................................................................................................................4Purpose..................................................................................................................................................4Intended audience..................................................................................................................................4Scope 4How to use the document......................................................................................................................4

Description of e-Filing Admin-tools............................................................................................................5Expected benefits of SP e-Filing Admin-tools.........................................................................................5

Form configuration.....................................................................................................................................6Section and fields................................................................................................................................6External service invocation.................................................................................................................8Fee amounts.....................................................................................................................................10File upload parameters.....................................................................................................................11List management..............................................................................................................................13Colours 13Countries 14First/Second language......................................................................................................................15First/Second language......................................................................................................................17Nationalities.....................................................................................................................................18Exhibitions........................................................................................................................................20

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Filings management.................................................................................................................................22Display list of applications................................................................................................................22

Tools 24Monitor integration status...............................................................................................................24I18n label management....................................................................................................................24Clear all cache...................................................................................................................................25

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Introduction

PurposeThe Admin tool user manual provides a detailed view of all the available options TM-eFiling Admin-tools system and how an user can update it.

Intended audienceAdmin-tools user, which implies: system admin for config files, application manager for application management and labels manager for labels management.

ScopeThis document will cover a detailed description of all available options.

How to use the documentEvery option contains:

Purpose: Description and explanation of the functionality. File managed: Which file is affected/changed after the modifications. Location: Of the file. Actions: available actions for each option are explained in detail. Action to be executed to make changes visible in tm-eFiling.

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Description of e-Filing Admin-tools SP e-Filing Admin-tools will allow users change the most part of e-Filing configuration and features

Expected benefits of SP e-Filing Admin-toolsOne of many expected benefits from the implementation of e-Filing Admin-tools is that users shall be able to easily adapt e-Filing to their necessities every time it’s necessary.

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Form configuration

Section and fieldsPurposeManage and change sections/fields from one form or wizard.

File manageWizard-conf.xml/oneform-conf.xml

LocationJboss file. Located in {PATH}/ services/conf

Actions : For this, first of all one form or wizard must be selected; a list with available screens for the selected option is shown.

Clicking on any link, a list with available sections for the selected screen is shown.

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


After this, clicking on any link, a table with all available fields is shown.

For changing any field, click on edit button. A popup is open and text fields and checkbox options are available. To save changes, click on Save section button. To cancel, click on cancel button. After this table appears updated with changes in case of these exist.

Action after changes: Tomcat must be restarted to make changes visible

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


External service invocationPurpose

Change Enable/Disable available services in form. - TmEfiling form includes several services which import information from external services like TMView,

TMClass, etc.. Depending on the office, these services can be enabled/disabled according to their necessities. If a service is disabled, this will not appear in the form.

- GET_USER_PERSON -> Get information related to registered user in case of existing a login system.- IMPORT_PREVIOUS -> Import option to get a CTM from TMView using ST13 Id- IMPORT_PREVIOUS_AUTOCOMPLETE -> Autocomplete option in CTM field to search into TMView by

id/name - PRIORITY_IMPORT -> Import option to get priority a CTM from TMView using ST13 Id- PRIORITY_MANUAL -> Option to enter a new priority through a form- PRIORITY_AUTOCOMPLETE -> Get a priority list from an external search service through an

autocomplete system - SENIORITY_IMPORT -> Import seniority information from an external service- SENIORITY_MANUAL-> Option to enter a new seniority through a form- SENIORITY_AUTOCOMPLETE -> Get a seniority list from an external search service through an

autocomplete system- TRANSFORMATION_IMPORT -> Import transformation information from an external service- TRANSFORMATION_MANUAL -> Option to enter a new transformation through a form- TRANSFORMATION_AUTOCOMPLETE -> Get a transformation list from an external search service

through an autocomplete system- APPLICANT_IMPORT -> Import applicant information from an external service- APPLICANT_AUTOCOMPLETE -> Get an applicant list from an external search service through an

autocomplete system- APPLICANT_MATCH- APPLICANT_SAVE -> Save applicant changes in an external service- REPRESENTATIVE_IMPORT-> Import representative information from an external service- REPRESENTATIVE_AUTOCOMPLETE-> Get representative list from an external search service through

an autocomplete system- REPRESENTATIVE_MATCH- PERSON_SEARCH- CLAIM_SEARCH- REPRESENTATIVE_SAVE -> Save representative changes in an external service- REPRESENTATIVE_ASSOCIATION_AUTOCOMPLETE- VALIDATE_TERM -> Validates entered goods and services term using an external service- SEARCH_TERM -> Search entered word into tmclass system to get results related to the criteria- IMPORT_NICE_CLASS_HEADING -> Import nice class from an external service- SEARCH_TAXOMY -> Enables taxonomy system- SAVE_LOAD_SERVICE- SIMILAR_TM_SERVICE- SIMILAR_TM_FIND_MORE_DETAILS_SERVICE- FEED_BACK- COMMUNICATION_INBOX- MISLEADING_INFORMATION- HELP_MESSAGE_SERVICE- HELP_MESSAGE_SERVICE_USES_FILES- PAYMENT_POPUP -> Used to open payment system in a pop-up (YES) or new window (NO).

File manageService-enabled.xml

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016



Actions : Click on Edit . Check/uncheck the corresponding checkbox to enable/disable service. After this, Save button must be clicked to save changes or cancel button to not save them.

.......................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Action after changes: Clear cache is necessary to make visible changes. Available option from this screen, through a link in the top of the page.

Fee amountsPurpose

Change fee values used by Business Rules to calculate the total fee for a registration. It’s possible to change as well the maximum number of classes used in the calculation of the fees. If this cypher is passed, and extra-charge can be added to the final amount.

File managefees-configuration.xml


Actions : Click on Edit . Change the values of the corresponding value (amount or number of classes). After this, Save button must be clicked to save changes or cancel button to not save them.

Action after changes: Jboss restart is necessary to make changes visible

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


File upload parametersPurposeManage configurations related to file upload. In different sections on the form, fileUpload fields are available in order to add attached files to the application.

Depending on the section and the kind of files allowed some fields are available with some constraints. All these features are managed from this sections.

File managefileUploadConfiguration.xml


Actions :

All available file upload configurations are shown in a list. User can select any of them clicking on the corresponding name.

Once fileUpload is chosen, general details are shown as well as a list with related allowed types. Both of them can be edited clicking on the corresponding button.

A popup is open, and all the fields can be updated. To save changes Save button must be clicked and cancel/close to cancel them.

Depending of the category, some fields contain other fields inside. The way of procedure is the same.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Action after changes: Tomcat server must be restarted to ensure the changes on this list are recognized.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


List management

ColoursPurposeUpdate colour list management is available. It’s used by figurative/3d trademarks, where a colour must be entered in case of colour format “description” is selected. An autocomplete colour list in the chosen language is available from Colour value field.

File managecolour-configuration.xml


Actions : Update/Add/RemoveFirst of all, a language in Countries column must be selected. Colour list is reloaded with the corresponding values.

- Add -> Click on add a colour button . Pop up is open with empty fields which can be populated. After this, Add colour button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

- Edit -> Click on Edit . Pop up is open with the current value which can be updated. After this, Edit colour button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


- Delete -> Click on Remove. Colour is removed from the list, which is reloaded with the changes.

Action after changes: Changes are visible immediately after saving.

CountriesPurposeCountries and states are entered in different part of the form like in representative or application sections. Available countries/states can be managed from this Admin-tool option.

File managecountries.xml/states.xmlLocationJboss file. Located in {PATH}/ services/conf

Actions :

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


- Manage country -> Click on + . New screen is loaded with the current values for the selected country, which can be updated through edit option.

Pop up is open with the current values which can be updated. After changes, Edit country button must be clicked to save changes or close button to not save them. Screen is reloaded with the changes. From this screen, state list associated to the selected country can be managed in same way.

- Delete -> Click on Remove. Country is removed from the list, which is reloaded with the changes.- Add -> Click on add a country button. Pop up is open with empty fields which can be populated. After

this, Add country button must be clicked to save changes or close button to not save them. Screen is loaded with the new country with the possibility of adding states.

Country/State i18n Key must be filled with a label which must exist in label file in case user wants internationalization of this.

Action after changes: Clear cache is necessary to make visible changes. Available option on this screen, through two links in the top of the page.

First/Second languagePurposeManage language list available for the application. It’s possible manage secondary language in case of this option exists

File managefirst-lang-conf.xml / second-lang-conf.xml

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016



Actions : Update/Add/Remove

- Add -> Click on add a language button . Pop up is open with empty fields which can be populated. After this, Add language button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

- Edit -> Click on Edit . Pop up is open with current values which can be updated. After this, Edit language button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


- Delete -> Click on Remove. Language is removed from the list, which is reloaded with the changes.

If language value is filled with an existing label from the label file, this value can be properly internationalized.

Action after changes: Clear cache is necessary to make visible changes. Option available from this screen, through a link in the top of the page

First/Second languagePurposeManage language list available for the application. It’s possible manage secondary language in case of this option exists

File managefirst-lang-conf.xml / second-lang-conf.xmlLocationJboss file. Located in {PATH}/ services/conf


- Add -> Click on add a language button . Pop up is open with empty fields which can be populated. After this, Add language button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


- Edit -> Click on Edit . Pop up is open with current values which can be updated. After this, Edit language button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

- Delete -> Click on Remove. Language is removed from the list, which is reloaded with the changes.

If language value is filled with an existing label from the label file, this value can be properly internationalized.


NationalitiesPurposeManage nationality list available in the application

File managenationalities.xml



....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


- Add -> Click on add a nationality button . Pop up is open with empty fields which can be populated. After this, Add nationality button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

- Edit -> Click on Edit . Pop up is open with current values which can be updated. After this, Edit nationality button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

- Delete -> Click on Remove. Nationality is removed from the list, which is reloaded with the changes.

If nationality i18n Key value is filled with an existing label from the label file, this value can be properly internationalized.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016



ExhibitionsPurposeManage exhibition list available for the application

File manageexhibition.xml



- Add -> Click on add an exhibition button . Pop up is open with empty fields which can be populated. After this, Add nationality button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

- Edit -> Click on Edit . Pop up is open with current values which can be updated. After this, Edit exhibition button must be clicked to save changes or close button to not save them. List is reloaded with the changes.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


- Delete -> Click on Remove. Exhibition is removed from the list, which is reloaded with the changes.

If exhibition i18n Key value is filled with an existing label from the label file, this value can be properly internationalized.


....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Filings management

Display list of applicationsAll applications included in database are shown in list. The fields are

- Id : autogenerated internal id- Username: user name of the user who created the application- applicationId: application number. Final ID- provisionlalId: provisional application number following pattern settled in conf files and BR- office: corresponding to application- paymentId: payment id generated by payment platform, if it exists- current status: application status- date created: date corresponding of application creation- type : TM or another one.

Application details are available clicking on corresponding button.

For every application, options are:- Information shown in previous screen.

o Username o Application ID o Provisional IDo Officeo PaymentId

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


o Current statuso Date createdo Type of application

- Optionso Change status: current status can be changed. For this, click on Change status link. Pop up is

open and new status can be selected between status list. An additional message can be added. To save modifications, click on Change status button. To cancel, click on Close button. Current status is shown updated in case of changes.

o Resubmit: this option sent to the JMS queue the selected application independently of its status.

o Delete: Removes application from the database -> DISABLED- Statuses

o A history with all status that application has had, since it was created, until the current status. For every status, id, status code, modified date and message in case of this exists are list.

- Attachments: In case of an application is in STATUS_SUBMITTED status, the following files are shown and can be downloaded:

o Receipt.pdf : autogenerated pdf with a resume of the application info.o ePub.zip with application+attachments.

- XML Data: In case of an application is in STATUS_SUBMITTED status, the corresponding xml is shown.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Tools

Monitor integration status External services are list in order to know connection status. 200 status means service is running, 400 doesn’t. Every service can be called independently, for this, just click on corresponding refresh button.

I18n label managementPurposeUser can change text related to all the labels appeared in the form

File managetm-efiling-messages_**.properties

Location/configuration/modules/tmefiling/message-resources

Actions : When a label is selected, a list with translation for each available language is shown.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


To change one, just click on edit button; a pop up is open and text can be changed after click on “Save label” button or cancel click on “Close button”.

In case of save changes, label list is reloaded.

Action after changes: Tomcat server must be restarted after changes

Clear all cacheThis option allows clear all caches.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016


Changes in LV Version and comments

CommentsMost of above descripted functions are not implemented or doesn’t not work. That is reason why most of countries didn’t not implement this tool. Also Latvia implemented this tool to use only couple of function. Mostly admin tool is used to fallow applications and to get filled application data. Admin can see all application information except design application pictures. For this we created special user “dsviewer” who has access to design application pictures. It is made like this because design pictures are confidential information.

Upload attorney file sectionLatvian office implemented new section for option to upload attorney file. This option is used to create list of attorneys in DB which is used to make drop down for end user. Attorney file must have special structure. You can see necessary structure in example file “PATENTPILNVAROTIE.XLSX”. Uploading this file you can add new information and updated existing one. If you want to delete attorney you don’t need to remove line but you need to add date in column “Prakse pārtraukta”.

....................................................................................................................................................................................................................................................................................................................................... / 26document.docx - 02/08/2016