Difference between revisions of "Preferences"

Revision as of 11:38, 17 February 2017 (view source) Talves (talk | contribs) ← Older edit		Latest revision as of 16:10, 17 February 2017 (view source) Talves (talk | contribs)
(3 intermediate revisions by the same user not shown)
Line 92:		Line 92:
	* Select the Cytoscape installation folder.		* Select the Cytoscape installation folder.
−	=== Information Retrieval ===	+	===Information Retrieval ===
−	==== Patent Pipeline ====	+	@note2 allows to define some configurations to run the different Information Retrieval tools. In this section, you are able to configure:
		+	* The Patent Pipeline;
		+	* The Springer Search;
		+	* and the Patent Search.
−	===== Configure Custom Search API from Google =====
		+	[[File:Preferences_InformationRetrieval_1.png|center|800px]]
−	====== About ======
−	This is a component from patent ID search module of [[Patent pipeline]]. To be configured, you must register yourself first to get the required credentials and access the service.	+	==== Patent Pipeline ====
−	====== Registration process ======	+	It is able to you configure previously each [[Patent Pipeline]] component relative to the patent IDs search and to the patent metainformation search processes (each one can be accessed clicking on the correspondent tab – evidenced by the red box).
		+	To the '''patent ID search''', you are able to configure three different components with the respective access credentials obtained by the registration process:
		+	*[[Configure Custom Search API from Google|Custom Search API from Google]];
		+	*[[Configure Bing Web Search API from Microsoft|Bing Web Search API from Microsoft]];
		+	*and [[Configure Open Patent Services API from EPO|Open Patent Services API from European Patent Office]].
−	To be identified and use Custom Search API from Google, you must register yourself to get two different credentials: a '''Custom Search ID''' and a '''API key'''. The first identifies your service version while the second identifies you as a service costumer.
−	======= Custom Search ID =======	+	[[File:Preferences_InformationRetrieval_2.png|center|800px]]
−	Through this service, you are able to use the free or paid version. Using the free version, you are restricted to 100 requests per day and then the service stop working.
−	======== Free Version ========	+	Similarly, to the '''patent metainformation retrieval''', you are able to configure two different components using their respective access keys:
−	Open the [https://cse.google.com/cse/ Google Control Panel]. Then, you must login into your Gmail account clicking on the button in the area inside the orange box. If you don’t have an account, you must add one.	+	*[[Configure Open Patent Services API from EPO| Open Patent Services API from European Patent OPffice]];
		+	*and [[Configure PATENTSCOPE API from WIPO|PATENTSCOPE API from World of Intellectual Property Organization]] .
−	[[Image:Google_1.png|1000px|center]]	+	[[File:Preferences_InformationRetrieval_3.png|center|800px]]
−	After that, you must be able to access the configuration page, where you can create a new search engine (clicking on the option marked inside the blue box).	+	===== Add a component =====
		+	To add a new component, firstly, you must select it from the combo box (into the blue box). For each component you select, a new configuration panel appears under the combo box (into the orange box).
−	[[Image:Google_2.png|1000px|center]]
		+	[[File:Preferences_InformationRetrieval_4.png|center|800px]]
−	In the '''Sites to search''' section, add only ''www.google.com/*'' to allow the search on google servers.  In the name of your search engine, you must enter any designation you want. Click '''Create'''.
		+	After fill the respective fields with the requested credentials, click on the '''“+”''' button. The configured component must appear in the table evidenced by the orange box.
−	[[Image:Google_3.png|1000px|center]]
		+	[[File:Preferences_InformationRetrieval_5.png|center|800px]]
−	Now, in the '''“edit search engine”''' section (blue box) you are able to enter the '''“setup”''' of your search engine (button inside the green box) and see the '''“search engine ID”''' (clicking in the button inside the orange box) which is your '''Custom Search ID'''.
		+	===== Remove a component =====
−	[[Image:Google_4.png|1000px|center]]	+	To remove a component, you must click on the correspondent '''“-“''' button on the configured components table (into the area delimited by the orange box).
−	======== Paid Version ========	+	[[File:Preferences_InformationRetrieval_6.png|center|800px]]
−	Open the [https://cse.google.com/cse/all Google Control Panel]. There, you can use your previously generated search engine clicking on the '''“edit search engine”''' or add a new one clicking '''“new search engine”''' button.
		+	After that, the respective component must disappear from table.
−	[[Image:Google_5.png|1000px|center]]
		+	[[File:Preferences_InformationRetrieval_7.png|center|800px]]
−	Then, you must access your search engine options and click on the button '''“Upgrade to Site Search (ads optional)”'''.
		+	==== Springer Search ====
−	[[Image:Google_6.png|1000px|center]]	+	To run the Springer Search, you must define previously the credential to get access to service ('''the access token'''). To that you only have to add your credential into the field designed to that (evidenced into the red box).
−	There you can give your contact information and after fill these fields (in the area delimited by the orange box) you can skip to the next step, clicking on the '''“Next”''' button at the end of the page.	+	[[File:Preferences_InformationRetrieval_8.png|center|800px]]
−	[[Image:Google_7.png|1000px|center]]	+	==== Patent Search ====
		+	To run an OPS Patent Search, you must define previously the credential to get access into the OPS web service.  To that, you must register yourself into the [[Configure Open Patent Services API from EPO| Open Patent Services API from European Patent OPffice]]. Add your '''access token''' into the respective field (represented into the orange box).
−	Here, how many searches that serve your needs and click on '''“Purchase”''' button. You will be directed to a purchase page where you can input your bank card information.
		+	[[File:Preferences_InformationRetrieval_9.png|center|800px]]
−	[[Image:Google_8.png|1000px|center]]
		+	== Import Settings ==
−	======= API key =======	+	You can import default settings from a file by pressing the import button on the Preferences GUI.
		+	A file selection GUI is shown where you must select a conf file previously created by an export operation (see above).
−	To identify yourself by using the Custom Search API, you must create an '''API key'''.
−	To that, you must access [https://console.developers.google.com/].
−
−
−	[[Image:Google_9.png|1000px|center]]
−
−
−	By accessing the Menu '''Project''', you can select the option '''“Create project”'''.
−		+	[[File:Preferences_Import.png|center|800px]]
−	[[Image:Google_10.png|1000px|center]]
−
−
−	Then, you can give a name to your project, defining if you want to be contacted by Google to get special offers and accept the service terms. After fill these settings, click in the '''“Create”''' button.
−
−
−	[[Image:Google_11.png|1000px|center]]
−
−
−	Now, you can go into your credentials panel accessing '''“Credentials“''' on the left Menu (inside the blue box). Then, click the button '''“Create credentials” -> "API key"''' and your key is automatically generated.
−
−
−	[[Image:Google_12.png|1000px|center]]
Line 202:		Line 189:
−	== Import Settings ==	+	== Apply Settings ==
−	You can import default settings from a file by pressing the import button on the Preferences GUI.	+	After fill all the desired sections, to apply the settings, click on “Ok” button. That will save your settings into your database to be read posteriorly.
−	A file selection GUI is shown where you must select a conf file previously created by an export operation (see above).
−	[[File:Preferences_Import.png|center|800px]]	+	[[File:Preferences_InformationRetrieval_10.png|center|800px]]

---

Latest revision as of 16:10, 17 February 2017

Change Settings

To access @Note Preferences, select Preferences in the Settings menu bar

A GUI is opened where at the left you can check the preferences tree. Each node of tree keeps the preference settings for a specific @Note2 process. An example is shown for the NER -> NERlexical Resources with the NER Lexical Resource Wizard default settings. You can navigate in the tree and select which settings are more appropriate. The specific settings appear in the right hand side.

When all changes are done, confirm by pressing the ok button. At any time, you can cancel the changes and exit this Preferences GUI by pressing the cancel button

Database Management

@Note2 allows database management, allowing you to add, remove or define your primary database. These operations are done in the Preferences menu. To access these options, select the General node and within this tree, select the Database node.

Add New Database Connection

You can add a new database by filling the database credentials in the Add New Database Connection section (in blue) and pressing the Add Database to archive button. You can choose the database name, host , port, root-user and its password. If the configurations are correct, the database configuration will be added to the databases archive (in red) and if the check box Use as Primary Database is selected, the new database will also be added as a primary database (in orange).

To apply the new setting changing your primary databas, you must restart @Note2 (see Apply_Settings)

Define a primary Database from Database Archive

You can define a database connection from the databases archive (in red) as a primary database by pressing the rightmost button "+" in the database archive list (blue circle). If the connection is valid, the current database panel settings will be changed.

To apply the setting and change the primary database, you must restart @Note2 (see Apply_Settings)

Remove Database Connection from Archive

You can remove a database from the databases archive by pressing the "-" button on the database that will be removed.

Apply Settings

Database Management is a special option that can not be changed exiting Preferences in the "Ok" Button. When you change the current database, the Save and restart button (In green) will appear and when you click on it, @Note2 restarts with the new database (in orange).

Proxy

@Note2 allows the management of the current Proxy. To access Proxy Settings, select the General node and then the Proxy Node in the Settings tree.

Cytoscape Auto Open

@Note2 provides the possibility to automatically start Cytoscape with a loaded network (XGMML File) generated by the operation of exporting Relations / Events for XGMML File.

To access Cytoscape Settings, select the Corpora Node and then the Cytoscape node in the Settings tree.

To allow Cytoscape to automatically open, you need to:

• Select the Auto Open Cytoscape after XGMML File Creation option
• Select the Cytoscape installation folder.

Information Retrieval

@note2 allows to define some configurations to run the different Information Retrieval tools. In this section, you are able to configure:

• The Patent Pipeline;
• The Springer Search;
• and the Patent Search.

Patent Pipeline

It is able to you configure previously each Patent Pipeline component relative to the patent IDs search and to the patent metainformation search processes (each one can be accessed clicking on the correspondent tab – evidenced by the red box). To the patent ID search, you are able to configure three different components with the respective access credentials obtained by the registration process:

• Custom Search API from Google;
• Bing Web Search API from Microsoft;
• and Open Patent Services API from European Patent Office.

Similarly, to the patent metainformation retrieval, you are able to configure two different components using their respective access keys:

• Open Patent Services API from European Patent OPffice;
• and PATENTSCOPE API from World of Intellectual Property Organization .

Add a component

To add a new component, firstly, you must select it from the combo box (into the blue box). For each component you select, a new configuration panel appears under the combo box (into the orange box).

After fill the respective fields with the requested credentials, click on the “+” button. The configured component must appear in the table evidenced by the orange box.

Remove a component

To remove a component, you must click on the correspondent “-“ button on the configured components table (into the area delimited by the orange box).

After that, the respective component must disappear from table.

Springer Search

To run the Springer Search, you must define previously the credential to get access to service (the access token). To that you only have to add your credential into the field designed to that (evidenced into the red box).

Patent Search

To run an OPS Patent Search, you must define previously the credential to get access into the OPS web service. To that, you must register yourself into the Open Patent Services API from European Patent OPffice. Add your access token into the respective field (represented into the orange box).

Import Settings

You can import default settings from a file by pressing the import button on the Preferences GUI. A file selection GUI is shown where you must select a conf file previously created by an export operation (see above).

Export Settings

The Default Settings in @Note can be exported to a conf file. These files can be imported in another @Note2 installation. After selecting the appropriate default settings, you can export them to a file using the export option in the Preferences GUI. A GUI for file selection is launched where you should select the folder and define the file name. The operation creates a configuration file that can be imported from any @Note2 0.9.7 or later version.

Apply Settings

After fill all the desired sections, to apply the settings, click on “Ok” button. That will save your settings into your database to be read posteriorly.