diff --git a/amperity_operator/source/destination_bloomreach.rst b/amperity_operator/source/destination_bloomreach.rst new file mode 100755 index 00000000..53004af9 --- /dev/null +++ b/amperity_operator/source/destination_bloomreach.rst @@ -0,0 +1,474 @@ +.. https://docs.amperity.com/operator/ + + +.. |destination-name| replace:: Bloomreach +.. |plugin-name| replace:: "Amazon S3" +.. |credential-typex| replace:: "iam-credential" or "iam-role-to-role" +.. |required-credentialsx| replace:: "iam-credential" or "iam-role-to-role" +.. |what-send| replace:: Apache Parquet +.. |where-send| replace:: any Amazon S3 bucket +.. |filter-the-list| replace:: "amaz" + + +.. meta:: + :description lang=en: + Configure Amperity to send data to Bloomreach. + +.. meta:: + :content class=swiftype name=body data-type=text: + Configure Amperity to send data to Bloomreach. + +.. meta:: + :content class=swiftype name=title data-type=string: + Configure destinations for Bloomreach + +================================================== +Configure destinations for Bloomreach +================================================== + +.. include:: ../../shared/terms.rst + :start-after: .. term-bloomreach-start + :end-before: .. term-bloomreach-end + +.. destination-bloomreach-s3-or-sftp-start + +.. note:: Configure Amperity to send data to a password-protected Amazon S3 bucket managed by |destination-name|. You must configure |destination-name| to send data to an `Amazon S3 `__ |ext_link| bucket that is managed from |destination-name|. + +.. destination-bloomreach-s3-or-sftp-end + +.. _destination-bloomreach-get-details: + +Get details +================================================== + +.. destination-bloomreach-get-details-start + +Amperity can be configured to send product catalog data to an `Amazon S3 `__ |ext_link| bucket. Send data from Amperity to a customer-managed Amazon S3 bucket :ref:`using cross-account roles `, and then connect |destination-name| to that Amazon S3 bucket. + +.. destination-bloomreach-get-details-end + + +.. _destination-bloomreach-credentials-role-to-role: + +Configure cross-account roles +================================================== + +.. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-overview-start + :end-before: .. sources-amazon-s3-cross-account-roles-overview-end + +.. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-context-start + :end-before: .. sources-amazon-s3-cross-account-roles-context-end + +.. note:: + + .. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-setup-start + :end-before: .. sources-amazon-s3-cross-account-roles-setup-end + +.. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-aws-access-point-start + :end-before: .. sources-amazon-s3-aws-access-point-end + +**To configure an S3 bucket for cross-account role assumption** + +.. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-steps-intro-done-by-admins-start + :end-before: .. sources-amazon-s3-cross-account-roles-steps-intro-done-by-admins-end + +.. destination-bloomreach-credentials-role-to-role-steps-start + +.. list-table:: + :widths: 10 90 + :header-rows: 0 + + * - .. image:: ../../images/steps-01.png + :width: 60 px + :alt: Step 1. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/credentials.rst + :start-after: .. credentials-destinations-configure-start + :end-before: .. credentials-destinations-configure-end + + .. image:: ../../images/mockup-destinations-tab-add-01-select.png + :width: 500 px + :alt: Name, description, choose plugin. + :align: left + :class: no-scaled-link + + .. include:: ../../shared/credentials.rst + :start-after: .. credentials-destinations-configure-options-start + :end-before: .. credentials-destinations-configure-options-end + + + * - .. image:: ../../images/steps-02.png + :width: 60 px + :alt: Step 1. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-steps-add-source-intro-start + :end-before: .. sources-amazon-s3-cross-account-roles-steps-add-source-intro-end + + .. image:: ../../images/mockup-credentials-add-01-settings-amazon-s3-role-to-role.png + :width: 360 px + :alt: Select the iam-role-to-role credential type. + :align: left + :class: no-scaled-link + + + * - .. image:: ../../images/steps-03.png + :width: 60 px + :alt: Step 2. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-steps-settings-intro-start + :end-before: .. sources-amazon-s3-cross-account-roles-steps-settings-intro-end + + .. image:: ../../images/mockup-credentials-add-01-settings-amazon-s3-role-to-role-all.png + :width: 360 px + :alt: Name, description, choose plugin. + :align: left + :class: no-scaled-link + + .. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-steps-settings-details-start + :end-before: .. sources-amazon-s3-cross-account-roles-steps-settings-details-end + + + * - .. image:: ../../images/steps-04.png + :width: 60 px + :alt: Step 3. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-steps-policy-example-intro-start + :end-before: .. sources-amazon-s3-cross-account-roles-steps-policy-example-intro-end + + .. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-steps-policy-example-start + :end-before: .. sources-amazon-s3-cross-account-roles-steps-policy-example-end + + * - .. image:: ../../images/steps-05.png + :width: 60 px + :alt: Step 4. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/amazon-s3.rst + :start-after: .. sources-amazon-s3-cross-account-roles-steps-save-credentials-start + :end-before: .. sources-amazon-s3-cross-account-roles-steps-save-credentials-end + +.. destination-bloomreach-credentials-role-to-role-steps-end + + +.. _destination-bloomreach-add: + +Add destination +================================================== + +.. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-sandbox-recommendation-start + :end-before: .. setting-common-sandbox-recommendation-end + +**To add a destination for Bloomreach** + +.. destination-bloomreach-add-steps-start + +.. list-table:: + :widths: 10 90 + :header-rows: 0 + + * - .. image:: ../../images/steps-01.png + :width: 60 px + :alt: Step 1. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/destination_settings.rst + :start-after: .. destinations-steps-add-destinations-start + :end-before: .. destinations-steps-add-destinations-end + + .. image:: ../../images/mockup-destinations-add-01-select-destination-s3.png + :width: 380 px + :alt: Add + :align: left + :class: no-scaled-link + + .. include:: ../../shared/destination_settings.rst + :start-after: .. destinations-steps-add-destinations-select-start + :end-before: .. destinations-steps-add-destinations-select-end + + + * - .. image:: ../../images/steps-02.png + :width: 60 px + :alt: Step 2. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/destination_settings.rst + :start-after: .. destinations-steps-select-credential-start + :end-before: .. destinations-steps-select-credential-end + + .. tip:: + + .. include:: ../../shared/destination_settings.rst + :start-after: .. destinations-steps-test-connection-start + :end-before: .. destinations-steps-test-connection-end + + + * - .. image:: ../../images/steps-03.png + :width: 60 px + :alt: Step 3. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/destination_settings.rst + :start-after: .. destinations-steps-name-and-description-start + :end-before: .. destinations-steps-name-and-description-end + + .. admonition:: Configure business user access + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-business-user-access-allow-start + :end-before: .. setting-common-business-user-access-allow-end + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-business-user-access-restrict-pii-start + :end-before: .. setting-common-business-user-access-restrict-pii-end + + + * - .. image:: ../../images/steps-04.png + :width: 60 px + :alt: Step 4. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/destination_settings.rst + :start-after: .. destinations-steps-settings-start + :end-before: .. destinations-steps-settings-end + + **Compression** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-compression-start + :end-before: .. setting-common-compression-end + + + **Escape character** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-escape-character-start + :end-before: .. setting-common-escape-character-end + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-escape-character-unspecified-start + :end-before: .. setting-common-escape-character-unspecified-end + + + **File format** + |checkmark-required| **Required** + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-file-format-start + :end-before: .. setting-common-file-format-end + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-file-format-custom-delimiter-start + :end-before: .. setting-common-file-format-custom-delimiter-end + + **Apache Parquet files only** + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-file-format-apache-parquet-start + :end-before: .. setting-common-file-format-apache-parquet-end + + + **Filename template** + .. include:: ../../shared/terms.rst + :start-after: .. term-filename-template-start + :end-before: .. term-filename-template-end + + + **Header** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-header-start + :end-before: .. setting-common-header-end + + + **PGP public key** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-pgp-public-key-start + :end-before: .. setting-common-pgp-public-key-end + + + **Quote mode** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-quote-mode-start + :end-before: .. setting-common-quote-mode-end + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-quote-mode-none-start + :end-before: .. setting-common-quote-mode-none-end + + **S3 prefix** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-amazon-s3-prefix-start + :end-before: .. setting-amazon-s3-prefix-end + + **Success file** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-success-file-start + :end-before: .. setting-common-success-file-end + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-success-file-downstream-start + :end-before: .. setting-common-success-file-downstream-end + + + **Split outputs** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-split-outputs-start + :end-before: .. setting-common-split-outputs-end + + + **Use Zip64?** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-use-zip64-start + :end-before: .. setting-common-use-zip64-end + + + **Row Number** + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-row-number-start + :end-before: .. setting-common-row-number-end + + .. include:: ../../shared/destination_settings.rst + :start-after: .. setting-common-row-number-column-name-start + :end-before: .. setting-common-row-number-column-name-end + + + + * - .. image:: ../../images/steps-05.png + :width: 60 px + :alt: Step 5. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/destination_settings.rst + :start-after: .. destinations-steps-business-users-start + :end-before: .. destinations-steps-business-users-end + + +.. destination-bloomreach-add-steps-end + + +.. _destination-bloomreach-workflow-actions: + +Workflow actions +================================================== + +.. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-intro-start + :end-before: .. workflow-actions-common-table-intro-end + +.. destination-bloomreach-workflow-actions-start + +.. list-table:: + :widths: 10 90 + :header-rows: 0 + + * - .. image:: ../../images/steps-01.png + :width: 60 px + :alt: Step one. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-section-one-a-start + :end-before: .. workflow-actions-common-table-section-one-a-end + + .. image:: ../../images/mockup-destinations-tab-workflow-error.png + :width: 500 px + :alt: Review a notifications error. + :align: left + :class: no-scaled-link + + .. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-section-one-b-start + :end-before: .. workflow-actions-common-table-section-one-b-end + + * - .. image:: ../../images/steps-02.png + :width: 60 px + :alt: Step two. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-section-two-start + :end-before: .. workflow-actions-common-table-section-two-end + + .. image:: ../../images/mockups-workflow-failed.png + :width: 500 px + :alt: The Workflow page, showing a workflow with errors. + :align: left + :class: no-scaled-link + + * - .. image:: ../../images/steps-03.png + :width: 60 px + :alt: Step three. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-section-three-a-start + :end-before: .. workflow-actions-common-table-section-three-a-end + + .. image:: ../../images/workflow-actions-s3-generic-invalid-bucket-name.png + :width: 300 px + :alt: Choose a workflow action from the list of actions. + :align: left + :class: no-scaled-link + + .. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-section-three-b-start + :end-before: .. workflow-actions-common-table-section-three-b-end + + Amperity provides a series of workflow actions that can help resolve specific issues that may arise with |destination-name|, including: + + * :ref:`destination-bloomreach-workflow-actions-invalid-bucket-name` + * :ref:`destination-bloomreach-workflow-actions-invalid-credentials` + + + * - .. image:: ../../images/steps-04.png + :width: 60 px + :alt: Step four. + :align: center + :class: no-scaled-link + - .. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-section-four-a-start + :end-before: .. workflow-actions-common-table-section-four-a-end + + .. image:: ../../images/workflow-actions-s3-generic-invalid-bucket-name-steps.png + :width: 300 px + :alt: Choose a workflow action from the list of actions. + :align: left + :class: no-scaled-link + + .. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-common-table-section-four-b-start + :end-before: .. workflow-actions-common-table-section-four-b-end + +.. destination-bloomreach-workflow-actions-end + + +.. _destination-bloomreach-workflow-actions-invalid-bucket-name: + +Invalid bucket name +-------------------------------------------------- + +.. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-s3-generic-incorrect-bucket-name-destination-start + :end-before: .. workflow-actions-s3-generic-incorrect-bucket-name-destination-end + + +.. _destination-bloomreach-workflow-actions-invalid-credentials: + +Invalid credentials +-------------------------------------------------- + +.. include:: ../../shared/workflow-actions.rst + :start-after: .. workflow-actions-generic-invalid-credentials-start + :end-before: .. workflow-actions-generic-invalid-credentials-end diff --git a/amperity_operator/source/grid_destinations.rst b/amperity_operator/source/grid_destinations.rst index 8e5e01f9..beed2ced 100755 --- a/amperity_operator/source/grid_destinations.rst +++ b/amperity_operator/source/grid_destinations.rst @@ -98,6 +98,10 @@ Set up connections to send data from Amperity to other marketing applications, t :link-type: doc :link: destination_bazaarvoice + .. grid-item-card:: Bloomreach + :link-type: doc + :link: destination_bloomreach + .. grid-item-card:: Bluecore :link-type: doc :link: destination_bluecore @@ -382,7 +386,7 @@ Set up connections to send data from Amperity to other marketing applications, t :maxdepth: 2 :hidden: - ActiveCampign + ActiveCampaign Acxiom Adobe Campaign Adobe Customer Attributes @@ -399,6 +403,7 @@ Set up connections to send data from Amperity to other marketing applications, t Azure Blob Storage Azure Synapse Analytics BazaarVoice + Bloomreach Bluecore Braze Camelot SMM diff --git a/shared/credentials.rst b/shared/credentials.rst index 30f0231a..f96afddf 100755 --- a/shared/credentials.rst +++ b/shared/credentials.rst @@ -67,7 +67,7 @@ Do one of the following to select |source-name|: .. credentials-destinations-configure-options-start -Select |destination-name| from the **Plugin** dropdown. +Select |plugin-name| from the **Plugin** dropdown. .. credentials-destinations-configure-options-end diff --git a/shared/destination_settings.rst b/shared/destination_settings.rst index e206d439..d906f629 100755 --- a/shared/destination_settings.rst +++ b/shared/destination_settings.rst @@ -53,8 +53,8 @@ Open the **Destinations** page, select the **New destinations** button, and then To configure a destination for |destination-name|, do one of the following: -#. Click the row in which |destination-name| is located. Destinations list alphabetically and you can scroll up and down the list. -#. Search for |destination-name|. Start typing |filter-the-list|. The list filters to show only matching destinations. Select |plugin-name|. +#. Click the row in which |plugin-name| is located. Destinations list alphabetically and you can scroll up and down the list. +#. Search for |plugin-name|. Start typing |filter-the-list|. The list filters to show only matching destinations. Select |plugin-name|. .. destinations-steps-add-destinations-select-end @@ -62,8 +62,8 @@ To configure a destination for |destination-name|, do one of the following: To configure a campaign for |destination-name|, do one of the following: -#. Click the row in which |destination-name| is located. Destinations list alphabetically and you can scroll up and down the list. -#. Search for |destination-name|. Start typing |filter-the-list|. The list filters to show only matching destinations. Select |plugin-name|. +#. Click the row in which |plugin-name| is located. Destinations list alphabetically and you can scroll up and down the list. +#. Search for |plugin-name|. Start typing |filter-the-list|. The list filters to show only matching destinations. Select |plugin-name|. .. campaigns-steps-add-destinations-select-end diff --git a/shared/terms.rst b/shared/terms.rst index 430f0aa2..cdc2d923 100755 --- a/shared/terms.rst +++ b/shared/terms.rst @@ -915,6 +915,13 @@ A blocking strategy acts like a filter against large datasets. Each blocking str .. term-blocking-strategy-end +**Bloomreach** + +.. term-bloomreach-start + +Bloomreach is a cloud-based e-commerce experience platform that integrates customer and product data to deliver a personalized shopping experience across channels. + +.. term-bloomreach-end **Bluecore**