Skip to main content

Creating embeddings

Embeddings let you drop a KV UI Form into any Splunk app. This enables a native viewing experience for your end users.

  1. Open App Embeddings and select Create embedding.
  2. Choose the app that we will be embedding views in.
  3. Press "Add Embedding".
  4. Select the KV Form we will embed, and choose a view name (must be unique) and label.
  5. Lastly, Select a mode:
    • Add Records -> Display the form, so users can add multiple records to the KV Store.
    • Edit Single Record -> Edit a single record in the KV Store. Available in two modes:
      • Select Record: Select an existing record from the KV Store. Usecase: Edit a single settings page for an app
      • Splunk Search: Write a Splunk search, which returns the _key of the record to edit. Usecase: Dynamically edit a record, like a user preference page.
    • View Records -> Displays the entries table. Furthermore, you can configure if a user can Edit, Delete and Add records from this page.
  6. Save. You will be prompted to Deploy the views to the app. Until this is done, the views will not be available to end users.
  7. Once deployed, a list of embeddings will be displayed, which you can click to view natively in the selected app.