Add documents to a knowledge graph

You can reference documents from a knowledge graph to provide context for an entity or a relationship in which it participates, support facts stored in the entity's properties, and provide authoritative sources of information. A document in the knowledge graph is a reference to a file in the location where it is stored or to a website or document available on the internet.

Every knowledge graph has a Document entity type and a HasDocument relationship type by default. When you add a document to a knowledge graph, a new entity is created for the Document entity type. When you add a document to a specific entity that represents a person or a vehicle, for example, a HasDocument relationship is created from the vehicle entity to the document entity. A document can be referenced by many entities.

When viewing an entity's details in an investigation, its documents are listed on the Documents tab. The HasDocument relationships between the entity and its documents are also listed on the Relationships tab along with any other relationships in which the entity participates. You can access related documents in the same manner as other related entities are accessed from the details panel.

Some capabilities are available for documents that are not available for other entity types. Files such as pictures and websites can be previewed in the details panel on the Preview tab. Other files such as Microsoft Word documents can be opened in applications associated with the file type on the local computer. For documents such as text files, presentations, and websites, text is extracted and indexed to support searches in the knowledge graph. A document's text can be previewed and modified on the Text tab in the details panel. New documents can be created in the knowledge graph to capture notes related to the investigation.

Note:

Referencing documents is not supported when the knowledge graph uses a NoSQL data store with user-managed data. The Documents tab won't appear on the details panel for entities and relationships.

Add a document to an entity

Add documents to an entity to support your investigation and clarify details. You can add files from the local network or reference a website by providing a URL.

Add a file

You can reference a file stored on your local computer or on the network as a document in a knowledge graph. The file is accessed using its path.

If many people are working with the same knowledge graph, they won't be able to access files stored on your computer if the file is added from a disk accessed from a drive letter such as C:\Data. A better practice is to reference documents by providing a UNC path or a URL to a location from which the file is available to everyone working with the knowledge graph such as a URL for a document shared in Microsoft OneDrive or Microsoft SharePoint.

1. Click all entities in the investigation associated with the document.
2. In the investigation's details panel, click the Documents tab.
3. Click Add... and click Add on the menu.

   The Add Document dialog box appears.

4. Browse to and select the appropriate file and click OK.

A new Document entity is created in the knowledge graph that references the selected file at the location in which it is stored. A HasDocument relationship is created between all entities selected in the investigation and the document.

Tip:

You can add a document to an entity by dragging a file from Windows File Explorer onto the Documents tab on the investigation.

Add a URL

A website or a document available on the internet can be referenced by the knowledge graph by providing its URL.

1. Click all entities in the investigation associated with the document.
2. On the investigation's details panel, click the Documents tab.
3. Click Add... and click Add From URL on the menu.

   The Add Document From Path dialog box appears.

4. Provide a URL for the website and click Add.

A new Document entity is created in the knowledge graph that references the URL. A HasDocument relationship is created between all entities selected in the investigation and the document.

Preview a document

You can preview a document associated with an entity in the investigation's details panel in the same manner as you view details for other entities in the knowledge graph.

1. Select an entity with an associated document in the investigation.
2. On the investigation's details panel, click the Documents tab.
3. Click one of the documents in the list.
4. Hover over the document's name in the Name column.

   An Open button appears.

5. Click the Open button for the document you want to preview.

   The HasDocument relationship is traversed and information about the related document entity appears in the details panel. The location bar updates at the top of the panel to indicate how you arrived at this document.

   Several properties of the document entity are populated automatically. A URL property stores the file path or URL of the document. A file extension property stores the file extension such as .txt; the file extension .htm is used to characterize websites. Other properties such as the file name and content type are also populated.

   For document entities only, the details panel has Preview and Text tabs in addition to the Properties and Relationships tabs.

6. Click the Preview tab.

   If the document type can be previewed, it appears on the Preview tab.

7. Click the Open button on the Preview tab to view the document outside ArcGIS Pro.

   If the local computer is configured to open this file type in an application, the application will start and the file is opened.

Specify which file types can be previewed

Some file types are configured by default so they will not be previewed in the details panel. You can change the file types that can be previewed by modifying the list of file extensions on the Options dialog box. You can either specify a list of file types that can be previewed or specify a list of file types that cannot be previewed.

1. Click the Project tab on the ribbon and click Options.

   The Options dialog box appears.

2. Click the Knowledge Graph tab on the Options dialog box.
3. Click the Supported file extensions for preview heading.

   The All files except these types option is selected by default. If a document in your knowledge graph is one of the file types in the list below, it cannot be previewed in the details panel.

4. If appropriate, click the Only these file types option to designate the file types list as the list of types that can be previewed instead.
5. Click in the text box at the top of the file types list and type a file extension such as .docx. Press Enter or click the Add button that appears.

   The file extension is added to the list.

6. Click a file extension in the file types list and click the Remove button that appears.
7. If you want to save the current list of file extensions for future reference or to use in another project, click the Menu button at the top of the list and click the Save button . On the Save File Extensions dialog box, browse to a writable location, type a name for the text file that will be created and click OK.

   The list of file extensions can be loaded into ArcGIS Pro on another computer.

View and update a document's text

When a document is added to an entity, any text it contains is automatically extracted and stored in the document's text property. You can view the extracted text in the investigation's details panel on the Text tab. Only the first 2,000 characters of the text property's content appear by default on the Text tab. You can load the remainder of the content, if needed.

The contents of a document's text property can be modified in ArcGIS Pro. This provides several opportunities, including the following:

• For pictures and other documents in which text isn't stored within the referenced file, you can use the Text tab to add notes about the document.
• You can store a modified version of the document's text in the knowledge graph that is independent of the original document.
• You can create a document entity independently that isn't associated with a file or a URL and use it to capture notes relevant to the investigation.

A document's text property is indexed. This allows you to find the document and its associated entities when you search the knowledge graph, including any notes you have written.

When the document entity references a presentation, for example, and the presentation is modified outside ArcGIS Pro, the text stored in the knowledge graph is not updated automatically. You can update the extracted text to reflect the current content of the file or website. However, any changes you made to the text will be lost.

View and update extracted text

You can view text extracted from a document on the Text tab in the investigation's details panel.

1. Select an entity with an associated text file or Word document in the investigation.
2. In the investigation's details panel, click the Documents tab.
3. Hover over the document's name in the Name column and click the Open button that appears.

   The HasDocument relationship is traversed and information for the related Document entity appears in the details panel. The location bar updates at the top of the panel to indicate how you arrived at this document.

4. In the investigation's details panel, click the Text tab.

   The first 2,000 characters of the document's text property are displayed. If more text is available, a warning appears indicating that only a portion of the text is displayed and the Load All button is enabled.

5. Click Load All at the top of the Text tab.

   All content stored in the document's text property is displayed on the Text tab.

6. If the extracted text is difficult to read, for example, because it is all on one line, check Wrap Text at the top of the Text tab.
7. Click in the text box on the Text tab and modify the displayed text, for example, by typing a word at the beginning.
8. Click Apply.
9. Click Extract Text at the top of the Text tab.

   An Extract Text message box appears indicating that any changes you made to the document's text, including the edit made above, will be lost.

10. Click Yes to extract text from the document and overwrite the contents of the document entity's text property.

Add notes to an entity

To add notes to an entity, complete the following steps:

1. In the investigation's Contents pane, click Entity Types .

   The investigation lists the first 1,000 entities in the knowledge graph.

2. Click an entity in the list.
3. Click the Relationships tab in the details panel.
4. Click the Add button .

   A relationship is created.

5. For the new relationship, click in the Relationship column and click HasDocument.
6. In the Direction column, accept the default option: =>.
7. Click in the Entity Types column and click Document.
8. Click in the Entity column and click New Entity.

   The Entity column shows the text (New Entity) to indicate a new Document entity will be created.

9. Click Apply.

   A new Document entity is created. The <Null> value appears in the Entity column because the entity's name property is empty.

10. Hover over the <Null> value in the Entity column and click the Open button that appears.

    The HasDocument relationship is traversed, and information for the Document entity appears in the details panel. The location bar updates at the top of the panel to indicate how you arrived at this document.

11. Click the Text tab.
12. Type your notes in the text box and click Apply.

Specify file types from which text is extracted

Some file types are configured by default so text will not be extracted from them when they are added as documents. You can change the file types for which text can be extracted by modifying the list of file extensions on the Options dialog box. You can either specify a list of file types from which text can be extracted or specify a list of file types from which text cannot be extracted.

1. Click the Project tab on the ribbon and click Options.

   The Options dialog box appears.

2. Click the Knowledge Graph tab on the Options dialog box.
3. Click the Supported file extensions for extracting text heading.

   The All files except these types option is selected by default. If a document in your knowledge graph is one of the file types in the list below, text will not be extracted when the file is added as a document.

4. If appropriate, click the Only these file types option to designate the file types list as the list of types for which text can be extracted instead.
5. Click in the text box at the top of the file types list and type a file extension such as .png. Press Enter or click the Add button that appears.

   The file extension is added to the list.

6. Click a file extension in the file types list and click the Remove button that appears.
7. If you want to save the current list of file extensions for future reference or to use in another project, click the Menu button at the top of the list and click the Save button . On the Save File Extensions dialog box, browse to a writable location, type a name for the text file that will be created and click OK.

   The list of file extensions can be loaded into ArcGIS Pro on another computer.