# Enable Importing Literature References from Databases

Learn how to configure your Vault for intake of literature reference information from external databases.

## About the Feature

With the 23R3 release, SafetyDocs supports <a href="/en/lr/01238/">importing literature references in bulk from third-party databases</a>. Users upload an RIS file from a database into the Vault Library and then associate a _Literature Search Term_ with it. Users can select an action to import articles from the file, directing Vault to create _Literature Article_ records and map all of the file's information to them. 

### 25R1 Updates 

With the 25R1 release, SafetyDocs introduces the following new features:
- Highlight Literature Abstract Terms
- EMA MLM RIS Literature File Support

#### Highlight Literature Abstract Terms

With the 25R1 release, SafetyDocs has replaced the _Abstract (English)_ section on the _Literature Article_ object with an updated _Abstract_ control section. This control section contains a drop-down that enables the user to toggle the _Abstract_ text between English and its original language, eliminating the need for a separate English language field. To update your Vault to support this functionality, you must <a href="/en/lr/01318/#update-the-literature-article-object-layout">update the _Literature Article_ object layout</a>.

#### EMA MLM RIS Literature File Support

With the 25R1 release, Vault supports <a href="/en/lr/01238/#field-mapping-from-ema-mlm-ris-files">importing literature references from European Medicines Agency Medical Literature Monitoring (EMA MLM) RIS files</a>. Configure this feature by [adding new fields to your _Literature Article_ and _Product Family_ object layouts][5].

## Create Literature Database Records
To support importing literature references from database files, you must create a _Literature Database_ record for each database from which you want to import content (for example, PubMed, Scopus, or Embase).

To create a _Literature Database_ record:
1. Navigate to **Business Admin > Literature Databases**.
2. Select **Create**.
3. Enter a **Name** to indicate the literature database to which you are connecting.
4. Select **Save**.

## Configure Object Layouts

To support importing literature references from database files, configure the following object layouts:
- [_Literature Article_ layout][1]
- [_Literature Search Term_ layout][2]
- [_Literature Author_ layout][3]
- [_Literature Additional Information_ layout][4]

### Literature Article Layout

<ol>
    <li>Navigate to <strong>Objects > Literature Article > Layouts > Literature Article Detail Page Layout</strong>.</li>
    <li>Add the following fields to the <strong>Reference Information</strong> section:
                <ul>
                    <li>DOI</li>
                    <li>Reference Type</li>
                    <li>Abbreviated Title of Journal</li>
                    <li>Date of Publication</li>
                    <li>Database Name</li>
                    <li>Database Provider</li>
                    <li>Publisher</li>
                    <li>Accession Number</li>
                    <li>Title (English)</li>
                    <li>Call Number</li>
                    <li>ISBN/ISSN</li>
                    <li>Volume</li>
                    <li>Issue Number</li>
                    <li>Section</li>
                    <li>Edition</li>
                    <li>Start Page</li>
                    <li>End Page</li>
                    <li>Reference ID</li>
                </ul></li>
</ol>

#### Insert the Literature Author Section

<ol>
    <li>On the <strong>Literature Article Detail Page Layout</strong>, select <strong>Insert Section</strong> and then select <strong>Related Object</strong> from the picklist.</li>
    <li>In the <strong>Add Related Object Section</strong> dialog, select <strong>Literature Author</strong> as the related object and select the <strong>Create record in pop-up dialog</strong> option.</li>
    <li>In the <strong>Literature Author</strong> section, select <strong>Edit Columns</strong> and ensure the following columns are added:
        <ul>
            <li>Author Type</li>
            <li>First Name</li>
            <li>Last Name</li>
        </ul></li>
</ol>

#### Insert the Vancouver Citation Section

<ol>
    <li>On the <strong>Literature Article Detail Page Layout</strong>, select <strong>Insert Section</strong> and then select <strong>Text</strong> from the picklist.</li>
    <li>In the <strong>Add Text Section</strong> dialog, complete the fields as follows and then select <strong>Done</strong>:
        <ul>
            <li><strong>Section Label</strong>: Enter "Vancouver Citation"</li>
            <li><strong>Section Name</strong>: Enter "vancouver_citation"</li>
            <li><strong>Long Text / Rich Text Field</strong>: Select <strong>Vancouver Citation</strong></li>
        </ul></li>
</ol>

#### Insert the Literature Additional Info Section

<ol>
    <li>On the <strong>Literature Article Detail Page Layout</strong>, select <strong>Insert Section</strong> and then select <strong>Related Object</strong> from the picklist.</li>
    <li>In the <strong>Add Related Object Section</strong> dialog, select <strong>Literature Additional Info</strong> as the related object and select the <strong>Prevent record creation</strong> option.</li>
    <li>In the <strong>Additional Info</strong> section, select <strong>Edit Default Columns</strong> and ensure the following columns are added:
        <ul>
            <li>Tag</li>
            <li>Value</li>
        </ul></li>
</ol>

### Literature Search Term Layout

<ol>
    <li>Navigate to <strong>Objects > Literature Search Term > Layouts > Literature Search Term Detail Page Layout</strong>.</li>
    <li>Select <strong>Insert Section</strong> and then select <strong>Related Documents</strong> from the picklist.</li>
    <li>In the <Strong>Add Related Document Section</Strong> dialog, edit the fields as needed and then select <strong>Done</strong>.</li>
    <li>In the <strong>Documents</strong> section, select <strong>Edit Columns</strong> and ensure the following columns are added:
        <ul>
            <li>Document Number</li>
            <li>Type</li>
            <li>Subtype</li>
            <li>Classification</li>
            <li>Status</li>
        </ul></li>
</ol>


### Literature Author Layout

<ol>
    <li>Navigate to <strong>Objects > Literature Author > Layouts > Literature Author Detail Page Layout</strong>.</li>
    <li>Add the following fields to the <strong>Details</strong> section:
        <ul>
            <li>Author Type</li>
            <li>First Name</li>
            <li>Last Name</li>
            <li>Value</li>
        </ul>
    </li>
</ol>

### Literature Additional Information Layout

<ol>
    <li>Navigate to <strong>Objects > Literature Additional Information > Layouts > Literature Additional Information Detail Page Layout</strong>.</li>
    <li>Add the following fields to the <strong>Details</strong> section:
        <ul class="uk-list uk-list-bullet">
            <li>Literature Article</li>
            <li>Tag</li>
            <li>Value</li>
        </ul>
    </li>
</ol>


## Update Field Layout

Complete the following steps to move the **Literature Search Term** field next to other related fields.

<ol>
    <li>Navigate to <strong>Admin > Configuration > Field Layout > General (general_c)</strong>.</li>
    <li>Select <strong>Edit</strong>.</li>
    <li>Drag and drop the fields to group together the following:
        <ul>
            <li>Literature Review (Literature)</li>
            <li>Literature Article (Literature › Literature Article)</li>
            <li>Literature Search Term (Literature › Review Document › Database Export)</li>
        </ul></li>
    <li>Save the page.</li>
</ol>

## Create Object Action

Complete the following steps to add the **Import Articles from File** action on the **Literature Search Term** object:

<ol>
    <li>Navigate to <strong>Admin > Configuration > Objects > Literature Search Term</strong>.</li>
    <li>On the <strong>Actions</strong> tab, select <strong>Create</strong>.</li>
    <li>In the <strong>Create Action</strong> window, select <strong>Import Articles From File</strong> and then select <strong>Continue</strong>.</li>
    <li>Make any required changes to the action and then save the page.</li>
</ol>

## Configure Object Lifecycles

Complete the following steps to set up the object lifecycles related to this feature.

### Configure Settings on the Literature Search Term Lifecycle

Navigate to **Admin > Configuration > Object Lifecycles > Literature Search Term Lifecycle** and complete the following steps:

#### 1. Add Roles

In the **Roles** section, add the following roles:

<ul>
    <li>Aggregate Report Writer</li>
    <li>Reviewer</li>
</ul>

#### 2. Update Role Permissions

In the **Roles** section, select **Edit** to update the role permissions as follows:

<table>
                        <thead>
                            <tr>
                                <th>Role</th>
                                <th>Permissions</th>
                            </tr>
                        </thead>
                        <tbody>
                            <tr>
                                <td>Aggregate Report Writer</td>
                                <td>All states: Read</td>
                            </tr>
                            <tr>
                                <td>Editor</td>
                                <td>All states: Read</td>
                            </tr>
                            <tr>
                                <td>Owner</td>
                                <td>All states: Read</td>
                            </tr>
                            <tr>
                                <td>Reviewer</td>
                                <td><ul>
                                    <li>Error, Active, Importing: Read</li>
                                    <li>Active, Imported: Read, Edit</li>
                                    </ul></td>
                            </tr>
                            <tr>
                                <td>Viewer</td>
                                <td>All states: Read</td>
                            </tr>
                        </tbody>
                    </table>

#### 3. Add a User Action to the Active State

<ol>
    <li>In the <strong>States</strong> section, select <strong>Active</strong>.</li>
    <li>In the <strong>User Actions</strong> section, select <strong>Edit</strong>.</li>
    <li>Select <strong>Create Rule</strong> and configure the following rule:
        <ul>
            <li><strong>Always ></strong> Import Articles From File</li>
            <li><strong>Action Label:</strong> Import Articles from File</li>
        </ul></li>
</ol>

### Configure Settings on the Literature Author Lifecycle

Navigate to **Admin > Configuration > Object Lifecycles > Literature Author Lifecycle** and complete the following steps:

#### 1. Add Roles

In the **Roles** section, add the following roles:

<ul>
    <li>Aggregate Report Writer</li>
    <li>Reviewer</li>
</ul>

#### 2. Update Role Permissions

In the **Roles** section, select **Edit** to update the role permissions as follows:

<table>
                        <thead>
                            <tr>
                                <th>Role</th>
                                <th>Permissions</th>
                            </tr>
                        </thead>
                        <tbody>
                            <tr>
                                <td>Aggregate Report Writer</td>
                                <td>All states: Read</td>
                            </tr>
                            <tr>
                                <td>Editor</td>
                                <td>All states: Read, Edit, Delete</td>
                            </tr>
                            <tr>
                                <td>Owner</td>
                                <td>All states: Read, Edit, Delete</td>
                            </tr>
                            <tr>
                                <td>Reviewer</td>
                                <td><ul>
                                    <li>Inactive: Read</li>
                                    <li>Active: Read, Edit</li>
                                    </ul></td>
                            </tr>
                            <tr>
                                <td>Viewer</td>
                                <td>All states: Read</td>
                            </tr>
                        </tbody>
                    </table>

### Configure Settings on the Literature Additional Info Lifecycle

Navigate to **Admin > Configuration > Object Lifecycles > Literature Additional Info Lifecycle** and complete the following steps:

#### 1. Add Roles

In the **Roles** section, add the following roles:

<ul>
    <li>Aggregate Report Writer</li>
    <li>Reviewer</li>
</ul>

#### 2. Update Role Permissions

In the **Roles** section, select **Edit** to update the role permissions as follows:

<table>
                        <thead>
                            <tr>
                                <th>Role</th>
                                <th>Permissions</th>
                            </tr>
                        </thead>
                        <tbody>
                            <tr>
                                <td>Aggregate Report Writer</td>
                                <td>All states: Read</td>
                            </tr>
                            <tr>
                                <td>Editor</td>
                                <td>All states: Read, Edit, Delete</td>
                            </tr>
                            <tr>
                                <td>Owner</td>
                                <td>All states: Read, Edit, Delete</td>
                            </tr>
                            <tr>
                                <td>Reviewer</td>
                                <td>All states: Read</td>
                            </tr>
                            <tr>
                                <td>Viewer</td>
                                <td>All states: Read</td>
                            </tr>
                        </tbody>
                    </table>

## Configure Document Lifecycle

Complete the following steps to set up the document lifecycle related to this feature.

### Configure Settings on the Literature Document Lifecycle

Go to **Admin > Configuration > Document Lifecycles > Literature Document Lifecycle** and complete the following steps.

#### 1. Add Role

<ol>
    <li>On the <strong>Roles</strong> tab, select <strong>Create</strong>.</li>
    <li>On the <strong>Create Lifecycle Role</strong> page, complete the fields as follows:
        <ul>
            <li><strong>Label</strong>: Enter "Aggregate Report Writer"</li>
            <li><strong>Application Role</strong>: Select <strong>Aggregate Report Writer</strong></li>
        </ul></li>
    <li>Save the page.</li>
</ol>

#### 2. Add Security Settings to the New State

<ol>
    <li>On the <strong>States</strong> tab, select <strong>New</strong>.</li>
    <li>Go to <strong>Security Settings</strong> and select <strong>Edit</strong>.</li>
    <li>Configure the settings as follows:<br>
        <a href="https://platform.veevavault.help/assets/images/saf-lit-doc-lc-security-new.png" data-lightbox="saf-lit-doc-lc-security-new.png" data-title="Security Settings on the New State" data-alt="Security Settings on the New State">
  <img class="docimage" src="https://platform.veevavault.help/assets/images/saf-lit-doc-lc-security-new.png" alt="Security Settings on the New State" style="width: 70%;"  />
</a></li>
</ol>

#### 3. Add Security Settings to the Importing State

<ol>
    <li>On the <strong>States</strong> tab, select <strong>Importing</strong>.</li>
    <li>Go to <strong>Security Settings</strong> and select <strong>Edit</strong>.</li>
    <li>Configure the settings as follows:<br>
        <a href="https://platform.veevavault.help/assets/images/saf-lit-doc-lc-security-importing.png" data-lightbox="saf-lit-doc-lc-security-importing.png" data-title="Security Settings on the Importing State" data-alt="Security Settings on the Importing State">
  <img class="docimage" src="https://platform.veevavault.help/assets/images/saf-lit-doc-lc-security-importing.png" alt="Security Settings on the Importing State" style="width: 70%;"  />
</a></li>
</ol>

#### 4. Add Security Settings to the Error State

<ol>
    <li>On the <strong>States</strong> tab, select <strong>Error</strong>.</li>
    <li>Go to <strong>Security Settings</strong> and select <strong>Edit</strong>.</li>
    <li>Configure the settings as follows:<br>
        <a href="https://platform.veevavault.help/assets/images/saf-lit-doc-lc-security-error.png" data-lightbox="saf-lit-doc-lc-security-error.png" data-title="Security Settings on the Error State" data-alt="Security Settings on the Error State">
  <img class="docimage" src="https://platform.veevavault.help/assets/images/saf-lit-doc-lc-security-error.png" alt="Security Settings on the Error State" style="width: 70%;"  />
</a></li>
</ol>

## Configure Security

Add security settings to grant access to this feature. Use the following settings as a starting point, but configure access according to your business processes.

### Add the Literature Actions Permission Set

<ol>
    <li>Go to <strong>Admin > Users & Groups > Permission Sets</strong>.</li>
    <li>Select <strong>Create</strong>.</li>
    <li>In the <strong>Name </strong>field, enter "Literature Actions".</li>
    <li>Save the page.</li>
</ol>

### Grant Object Permissions

Once the above Permission Set has been created, complete the following steps to ensure your permissions sets are granted the appropriate level of access to objects needed for this feature.

<ol>
    <li>On the <strong>Signal Management</strong> permission set, navigate to the <strong>Objects</strong> tab and select <strong>Edit</strong>.</li>
    <li>Grant <strong>Read</strong> permissions on the <strong>Literature Additional Information</strong> object.</li>
    <li>Grant <strong>Read, Create, Edit, Delete</strong> permissions on the <strong>Literature Author</strong> object.</li>
    <li>Save the page.</li>
 </ol>

## Configure Custom Sharing Rules on the Literature Author Object

Complete the steps below to configure Custom Sharing Rules on the **Literature Author** object:

<ol>
    <li>Navigate to <strong>Admin > Configuration > Objects > Literature Author</strong>.</li>
    <li>On the <strong>Details</strong> tab, select <strong>Edit</strong> and then select the <strong>Enable Custom Sharing Rules</strong> checkbox.</li>
    <li>When prompted, select <strong>Continue</strong> and save the page.</li>
    <li>In the <strong>Sharing Rules</strong> tab, select <strong>Create</strong>.</li>
    <li>In the <strong>Label</strong> field, enter "Literature Author - Reviewer" and save the page.</li>
    <li>In the <strong>Roles </strong>section on the new custom rule page, select <strong>Add</strong>.</li>
    <li>Add the following roles, with <strong>Literature Users</strong> in the <strong>Users & Groups</strong> field:
        <ul>
            <li>Editor</li>
            <li>Reviewer</li>
        </ul></li>
</ol>

## (25R1) Configure EMA MLM RIS Literature File Support

To configure EMA MLM RIS Literature File Support, add the specified fields to the following object layouts:
- _Literature Article_
- _Product Family_

### Update the Literature Article Layout

To update the _Literature Article_ object layout: 

1. Navigate to **Admin > Configuration > Objects > Literature Article > Layouts > Literature Article Detail Page Layout**.
2. <a href="/en/lr/26387/#how-to-add-object-fields">Add</a> the following fields:
    - **ICSR Review Outcome**: Add this field to the _Review Outcome_ section under the _Number of Identified Cases_ field
    - **EMA Inclusion/Exclusion Criteria**: Add this field to the _Reference Information_ section under the _Database Provider_ field

### Update the Product Family Layout

To update the _Product Family_ object layout: 
1. Navigate to **Admin > Configuration > Objects > Product Family > Layouts > Product Family Detail Page Layout**.
2. <a href="/en/lr/26387/#how-to-add-object-fields">Add</a> the **EMA Substance Group** field.



[1]: #literature-article-layout
[2]: #literature-search-term-layout
[3]: #literature-author-layout
[4]: #literature-additional-information-layout
[5]: #25r1-configure-ema-mlm-ris-literature-file-support
[6]: #update-the-literature-article-layout
[7]: #update-the-product-family-layout