Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions amperity_operator/source/sandboxes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,16 @@ Short-lived sandboxes
:end-before: .. sandboxes-best-practice-short-lived-end


.. _sandboxes-best-practice-small-test-audiences:

Very small test audiences
--------------------------------------------------

.. include:: ../../amperity_reference/source/sandboxes.rst
:start-after: .. sandboxes-best-practice-small-test-audiences-start
:end-before: .. sandboxes-best-practice-small-test-audiences-end


.. _sandboxes-howtos:

Common activities
Expand Down
56 changes: 54 additions & 2 deletions amperity_reference/source/sandboxes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Amperity recommends the following patterns when working with sandboxes:
* :ref:`Delete sandbox on promote <sandboxes-best-practice-delete-on-promote>`
* :ref:`Run partial workflows <sandboxes-best-practice-partial-workflows>`
* :ref:`Short-lived sandboxes <sandboxes-best-practice-short-lived>`

* :ref:`Very small test audiences <sandboxes-best-practice-small-test-audiences>`
.. sandboxes-best-practice-end


Expand Down Expand Up @@ -337,7 +337,7 @@ Run partial workflows

Each workflow should be validated before promoting changes to production using a partial workflow.

* A partial workflow pulls data from upstream sources to the sandbox, run Stitch, and then refresh databases.
* A partial workflow pulls data from upstream sources to the sandbox, runs Stitch, and then refreshes databases.
* A partial workflow *does not* run orchestrations *or* campaigns. This ensures that data in your sandbox is not inadvertently sent to any downstream workflows.

.. sandboxes-best-practice-partial-workflows-end
Expand Down Expand Up @@ -366,6 +366,15 @@ A sandbox should be short-lived and should be used to make small, iterative chan
.. sandboxes-best-practice-short-lived-end


.. sandboxes-best-practice-small-test-audiences-start

Use very small audiences to test and validate configuration updates for destinations. In a sandbox you can build a query that returns an audience that matches the requirements for the downstream use case. Use the **LIMIT** clause at the end of the query to limit the size of the audience to the specified integer. For example: ``LIMIT 10`` returns an audience with ten members and ``LIMIT 100`` returns an audience with one hundred members. Use a manual orchestration to send the test audience to the destination. Log into the destination and verify the audience was received and is correctly formatted for your use case.

.. tip:: Campaigns do not run in sandboxes. If you must use a segment and campaign to test an audience you must do this in production. Promote the sandbox with the configuration updates, and then build a query that is unique by Amperity ID with the same size limits. Make this query available to the **Segments** page, and then build a segment using that query. Add the query to the campaign, and then run the test with the limited audience size.

.. sandboxes-best-practice-small-test-audiences-end


.. _sandboxes-howtos:

How-tos
Expand All @@ -390,6 +399,49 @@ Tasks related to working with sandboxes in Amperity:
.. sandboxes-howtos-end


.. _sandboxes-howto-access-sandbox:

Access a sandbox
--------------------------------------------------

.. sandboxes-howto-access-sandbox-start
=======
.. _sandboxes-best-practice-small-test-audiences:

Very small test audiences
--------------------------------------------------

.. sandboxes-best-practice-small-test-audiences-start

To validate configuration updates for destinations use a manual workflow and a query to send a very small test audience from Amperity to the configured destination. Use the **LIMIT** clause at the end of the query to enforce the size of the very small audience. For example: ``LIMIT 10`` or ``LIMIT 100``.

.. sandboxes-best-practice-small-test-audiences-end


>>>>>>> External Changes

How-tos
==================================================

.. sandboxes-howtos-start

Tasks related to working with sandboxes in Amperity:

* :ref:`Access a sandbox <sandboxes-howto-access-sandbox>`
* :ref:`Add a sandbox <sandboxes-howto-add-sandbox>`
* :ref:`Delete a sandbox <sandboxes-howto-delete-sandbox>`
* :ref:`Edit sandbox details <sandboxes-howto-edit-sandbox-details>`
* :ref:`Open a sandbox <sandboxes-howto-open-sandbox>`
* :ref:`Pull updates from production <sandboxes-howto-pull-updates-from-production>`
* :ref:`Promote changes <sandboxes-howto-promote-changes>`
* :ref:`Resolve validation issues <sandboxes-howto-resolve-validation-issues>`
* :ref:`Review changes <sandboxes-howto-review-changes>`
* :ref:`View sandbox details <sandboxes-howto-view-sandbox-details>`
* :ref:`View validation details <sandboxes-howto-view-validation-details>`

.. sandboxes-howtos-end


.. _sandboxes-howto-access-sandbox:

Access a sandbox
Expand Down
5 changes: 3 additions & 2 deletions shared/destination_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -486,10 +486,11 @@ Use the **Column name** setting to specify the name of the row number column in

.. setting-common-sandbox-recommendation-start

Use a sandbox to configure a destination for |destination-name|. Before promoting your changes, send a test audience, and then verify the results in |destination-name|. After verifying the end-to-end workflow, push the destination from the sandbox to production.
Amperity recommends using a sandbox to configure a destination for |destination-name|. Before promoting your changes to production from the sandbox, consider sending a very small test audience using a query and an orchestration to verify the results in |destination-name|. After verifying the end-to-end workflow, push the configuration changes from the sandbox to production.

.. setting-common-sandbox-recommendation-end
.. tip:: Learn more about `how sandboxes work <../reference/sandboxes.html>`__ and sandbox best practices such as `deleting sandboxes after configuration changes are promoted to production <../reference/sandboxes.html#sandboxes-best-practice-delete-on-promote>`__, `using short-lived sandboxes <../reference/sandboxes.html#short-lived-sandboxes>`__, and `sending very small test audiences <../reference/sandboxes.html#short-lived-small-test-audiences>`__.

.. setting-common-sandbox-recommendation-end

**Split outputs**

Expand Down