When you create a knowledge graph, you can modify the default configuration. To begin the process and set general properties, see Create an investigation in a project.
You can configure a knowledge graph to allow users to edit the underlying data, configure how the knowledge graph data will be managed, and define how Document entities and HasDocument relationships will be supported. Some service level parameters can also be configured. The configurable properties depend on your software version and whether the knowledge graph uses a hosted graph store or a NoSQL data store.
Configure knowledge graph
Follow these steps to configure operations and properties for the knowledge graph. These settings are stored as part of the definition of the ArcGIS Knowledge Server service that is created.
- On the Define Knowledge Graph page of the Create Investigation wizard, provide information on the General tab as described for creating a knowledge graph using the default configuration.
Take note of the choice made under Data Stores as this affects how you can configure the knowledge graph.
- Click the Configuration tab. If necessary, click the Configure service tab
below it. - Under Operations, check the Enable editing check box to enable editing knowledge graph data.
The owner of the knowledge graph and portal administrators can always edit its data. By default, other users cannot modify this knowledge graph's data unless editing is enabled.
- Choose the type of editing operations that are permitted for other users with sufficient privileges.
Editing operations are described in the following table:
Add Editors can add entities and relationships to the knowledge graph. They can define new entity types and relationship types and add properties. They can define the geometry of a new entity by creating the entity on a map. This option is enabled by default. Once entities and relationships are created, the Update option must be enabled for editors to modify entities and relationships, their properties, and their geometries.
Delete Editors can delete features. This option is enabled by default.
Update When this option is enabled, the Properties and geometry option is enabled by default, allowing editors to update properties of entities and relationships and the geometry of an entity. Choose Properties only to allow editors to update properties for existing entities and relationships only. They cannot modify the geometry of an existing entity.
This option is not available if a NoSQL data store was selected on the General tab, and the User managed data option is selected.
Note:
After the knowledge graph is created, you can change its editing options in the Enterprise portal.
- Under Data store, choose how the data in the knowledge graph's NoSQL data store will be managed.
ArcGIS managed ArcGIS Knowledge will create, manage, and delete the entities and relationships and define the data model of the graph items stored in the Neo4j database. The database must not be edited directly in Neo4j. This option is enabled by default. A knowledge graph will only be created successfully with this setting if your Neo4j database is empty.
User managed You must create, manage, and delete the entities and relationships and define the data model of the graph items using Neo4j. The knowledge graph is read-only when the Neo4j database is accessed by ArcGIS Knowledge. The Neo4j database is not required to be empty, but the database name and the names of data model types and properties must satisfy all naming restrictions.
This option is not available if the Hosted graph store option was selected on the General tab.
Note:
The default setting for this option is ArcGIS managed and the knowledge graphs created with that setting support other people editing data in the knowledge graph as determined by the settings specified in the previous steps. However, if you choose to create a User managed knowledge graph, its data will be read-only. If you previously checked the Enable editing option, the option is automatically unchecked and all of the options related to editing will become unavailable on this tab.
- If the User managed option is selected, configure the knowledge graph to access data in the Neo4j database.
Options are described in the following table:
Unique identifier All entities and relationships in the knowledge graph must have a unique string value that can be used to identify the graph item. Specify the property in the NoSQL data store that stores this value. For example, if the database uses a property named id, type the name for this property, id, in the Unique identifier text box. In this case, all entity types and relationship types in the knowledge graph must have a property named id.
Enable search All knowledge graph data can be accessed with an openCypher query. However, you can only find graph items using a full-text search against their property values if this option is checked. This option is checked by default.
If you uncheck this option and try to search for an item, an openCypher query is used to find graph items whose properties contain the specified value. However, you will not be able to use Lucene syntax in the search string including operators such as OR and LIKE. Also, you can't add an asterisk with a partial keyword such as plan* to leverage stemming or other full-text-based search capabilities to match all related words.
Enable documents This option indicates if documents can be added to the knowledge graph, and it is not editable. Documents cannot be added to knowledge graphs that use a NoSQL data store containing user-managed data.
If the ArcGIS managed option is selected, these options are not editable but will indicate how the NoSQL data store will be configured. A property with the name globalid will be created to store unique identifiers. Search is enabled and documents are supported.
Configure parameters
Complete the following steps to configure parameters for the knowledge graph. These settings are stored as part of the definition of the ArcGIS Knowledge Server service that is created.
- At the top of the Create Investigation wizard, under the Configuration tab, click Configure parameters
. - Under Properties, specify a value for Maximum records returned by server.
This property specifies the number of graph items that can be returned by an openCypher query or when displaying data in an investigation, a map, or a link chart. A large number may result in slower performance. The default value is 10,000.
- Specify a value for Maximum records returned by server during search operation.
This property specifies the number of graph items that can be returned by a search against the indexed properties of entities and relationships. A large number may result in slower performance. The default value is 2,000.
Configure documents
Complete the following steps to configure how documents are represented in the knowledge graph. These settings are stored as part of the definition of the ArcGIS Knowledge Server service that is created.
Note:
Documents cannot be added to knowledge graphs that use a NoSQL data store containing user-managed data.
- At the top of the Create Investigation wizard, under the Configuration tab, click Configure documents
. - In the Document Entity Type Name text box, type a name for the entity type in the data model representing documents that are referenced by the knowledge graph.
The default value is Document. For example, when you add a document to a knowledge graph, a new entity is created for the Document entity type.
- In the HasDocument Relationship Type Name text box, type a name for the relationship type in the data model that represents a relationship between an entity in the knowledge graph and a document associated with that entity.
The default value is HasDocument. For example, when you add a document to a specific entity in the knowledge graph such as a Person entity, a new relationship of the HasDocument entity type is created between the Person entity and the Document entity.
- Record the required essential information for each document referenced by the knowledge graph. Configure the properties of the document entity type that will be used to store this information.
text Any text in a document is extracted and stored in this property. The default property name is text.
url The location of the document is stored in this property. The value can be a URL to a website or a document that is available on the internet or the file path that can be used to access a document on the network. The default property name is url.
keywords This property allows you to specify a keywords that can help you search for the document. The default property name is keywords.
name The file name of the document. For example, if you add file named notes.txt to the knowledge graph, that file name is stored. The default property name is name.
contentType The type of data contained by the referenced document is stored in this property as a Multipurpose Internet Mail Extensions (MIME) type. For example, if you add a simple text file to the knowledge graph, the value text/plain would be recorded. The default property name is contentType.
title This property allows you to specify a title for the document. The default property name is title.
metadata This property allows you to specify metadata describing the document. The default property name is metadata.
fileExtension The file extension is recorded when the referenced document is a file. For websites, the file extension .htm is stored. The default property name is fileExtension.