.. _trackme_admin_dsm_doc_notes:

Feeds (DataSource - splk-dsm) - Docs notes & links
##################################################

Introduction to documentation notes & links for splk-dsm
========================================================

.. admonition:: Documentation notes & links

    - The documentation notes for splk-dsm is a simple feature which allows to provide easy to access documentation context directly in the TrackMe UI.
    - This feature is only available for the Data Source tracking component. (splk-dsm)
    - You can define **global and default documentation notes and links**, which apply for every entity in TrackMe.
    - In Addition, you can also define **documentation notes and links for each entity separately or linked to multiple entities**.
    - If both global documentation notes and entity specific documentation notes are defined, the entity specific documentation notes will be used.

Where to find the documentation notes & links in TrackMe UI
===========================================================

When you open the screen of a a specific entity, TrackMe shows as the top of the screen a link referring to documentation notes & link, depending on if a documentations notes have been defined yet: (global or per entity)

*No documentation notes defined yet*

.. image:: img_v2/dsm_docs_notes/screen001.png
    :alt: screen001
    :align: center
    :width: 1200px
    :class: with-border

*Documentation notes defined*

.. image:: img_v2/dsm_docs_notes/screen002.png
    :alt: screen002
    :align: center
    :width: 1200px
    :class: with-border

*If documentation notes are defined, the content would appear as:*

.. image:: img_v2/dsm_docs_notes/screen003.png
    :alt: screen003
    :align: center
    :width: 1200px
    :class: with-border

*If documentation notes are not defined yet, the following screen shows up and allows to create a new documentation reference, or link to an existing documentation reference:*

.. image:: img_v2/dsm_docs_notes/screen004.png
    :alt: screen004
    :align: center
    :width: 1200px
    :class: with-border

Defining global documentation notes & links
===========================================

To define global documentation notes & links, you need to navigate to the "Configure" screen and select the "splk-general" tab:

.. image:: img_v2/dsm_docs_notes/screen005.png
    :alt: screen005
    :align: center
    :width: 1200px
    :class: with-border

.. image:: img_v2/dsm_docs_notes/screen006.png
    :alt: screen006
    :align: center
    :width: 1200px
    :class: with-border

*Example:*

.. image:: img_v2/dsm_docs_notes/screen007.png
    :alt: screen007
    :align: center
    :width: 1200px
    :class: with-border

.. image:: img_v2/dsm_docs_notes/screen008.png
    :alt: screen008
    :align: center
    :width: 1200px
    :class: with-border

Note that the documentation notes & links defined globally can be overridden on per entity basis, so you can still reference specific documentation notes & links for each entity.

.. admonition:: Before TrackMe 2.0.87

    - Before this release of TrackMe, the global configuration was made in several Splunk macros (trackme_identity_card_default_url, trackme_identity_card_default_note)
    - If you were using this feature before this version, please backport your configuration to the new global configuration screen.

Defining documentation notes & links per entity
===============================================

If a global documentation reference is defined, TrackMe shows an informational message and allows defining an entity specific documentation reference, or link to an existing one:

.. image:: img_v2/dsm_docs_notes/screen009.png
    :alt: screen009
    :align: center
    :width: 1200px
    :class: with-border

If a specific entity note was defined however, the screen will allow deleting or updating this reference:

.. image:: img_v2/dsm_docs_notes/screen010.png
    :alt: screen010
    :align: center
    :width: 1200px
    :class: with-border

REST API endpoints
==================

Identity cards are managed via read only and write REST API endpoints, consult the REST API Dashboard in TrackMe for the detailed usage and example:

*API resource groups:*

- ``splk_identity_cards``: read only endpoints (trackmeuseroperations capability)
- ``splk_identity_cards/write``: write endpoints (trackmepoweroperations capability)

.. image:: img_v2/dsm_docs_notes/screen011.png
    :alt: screen011
    :align: center
    :width: 1200px
    :class: with-border