Skip to content
Draft
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
6 changes: 3 additions & 3 deletions html5/_main_toc.html.slim
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,10 @@ nav.sidebar-nav
| Plugin Development
li
a.nav-link href="/latest/plugin_installation.html"
| Plugin Installation
| Plugin Installation and Configuration
li
a.nav-link href="/latest/plugin_management.html"
| Plugin Management
| Plugin Management via APIs
li
a.nav-link href="/latest/plugin_use_cases.html"
| Special Plugin Use Cases
Expand Down Expand Up @@ -329,7 +329,7 @@ nav.sidebar-nav
| Aviate Catalog Guide
li
a.nav-link href="/latest/how-to-install-the-aviate-plugin.html"
| Plugin Installation
| Aviate Plugin Installation
li
a.nav-link href="/latest/aviate-database-migrations.html"
| Database Migrations
Expand Down
19 changes: 10 additions & 9 deletions userguide/analytics/userguide_analytics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,18 @@ The https://github.com/killbill/killbill-analytics-plugin[analytics plugin] is a

== Plugin Installation

A plugin can be installed either via https://docs.killbill.io/latest/userguide_kaui.html[__Kaui__] or https://github.com/killbill/killbill-cloud/blob/master/kpm[_KPM_]. In order to install a plugin via Kaui, please refer to the https://docs.killbill.io/latest/plugin_installation.html#_installing_via_kaui[__Plugin Installation Instructions__] document. In order to install a plugin via kpm, you may follow the steps given below:
The analytics plugin can easily be installed via the https://aviate.killbill.io[__Aviate UI__]. Refer to https://docs.killbill.io/latest/plugin_installation#_installing_via_aviate_marketplace[this doc] for a detailed demo.

. Ensure that you have kpm installed as explained https://github.com/killbill/killbill-cloud/tree/master/kpm#kpm-installation[here].
Alternatively, the plugin can also be via https://docs.killbill.io/latest/userguide_kaui.html[__Kaui__] or https://github.com/killbill/killbill-cloud/blob/master/kpm[_KPM_] as explained in the https://docs.killbill.io/latest/plugin_installation#_plugin_installation[Plugin Installation Guide].

For example, to install the plugin via https://github.com/killbill/killbill-cloud/blob/master/kpm[KPM], you can run the following command:

. Install the plugin using the following `kpm` command (Replace `<path_to_install_plugin>` with the path where you want to install the plugin. This path should match the path specified by the `org.killbill.osgi.bundle.install.dir` property in the https://docs.killbill.io/latest/userguide_configuration.html#_configuration_properties_table[__Kill Bill Configuration__]):
[source,bash]
----
kpm install_java_plugin analytics --destination=<path_to_install_plugin>
----

. Verify that the plugin is installed properly. This can be done by ensuring that the plugin JAR is present at the `path_to_install_plugin` specified in the previous step. Alternatively, you can also open https://docs.killbill.io/latest/userguide_kaui.html[Kaui], hover over the plug icon and click on `analytics`. This should display the following screen:

image::https://github.com/killbill/killbill-docs/raw/v3/userguide/assets/img/analytics-plugin/analytics-plugin-in-kaui.png[align=center]

. If you would like to make changes to the plugin, you can clone the plugin code, build and deploy it as explained https://github.com/killbill/killbill-analytics-plugin[here].
If you would like to make changes to the plugin, you can clone the plugin code, build and deploy it as explained https://github.com/killbill/killbill-analytics-plugin[here].


== Database Configuration
Expand Down Expand Up @@ -61,7 +60,9 @@ You can configure the following properties related to the analytics plugin in th
*Note:*
All the properties specified above are optional and the analytics plugin uses suitable defaults in case they are not specified. We however encourage you use different notification queue tables by specifying the `org.killbill.notificationq.analytics.tableName` and `org.killbill.notificationq.analytics.historyTableName` properties.

In addition, the analytics plugin also allows some optional https://docs.killbill.io/latest/userguide_configuration.html#_per_tenant_properties[tenant level] configuration. This can be done by executing the https://apidocs.killbill.io/tenant.html#add-a-per-tenant-configuration-for-a-plugin[per-tenant configuration] endpoint as follows:
In addition, the analytics plugin also allows some optional https://docs.killbill.io/latest/userguide_configuration.html#_per_tenant_properties[tenant level] configuration. The configuration can easily be done via the https://aviate.killbill.io/home[Aviate UI] Refer to https://docs.killbill.io/latest/plugin_installation#_configuring_via_aviate_ui[this doc] for a detailed demo.

Alternatively, the tenant configuration can also be done or via the https://apidocs.killbill.io/tenant#add-a-per-tenant-configuration-for-a-plugin[Add a per-tenant configuration for a plugin] endpoint as follows:

[source,bash]
----
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions userguide/platform/userguide_configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ The subsequent sections elaborate each of these approaches.

Per tenant properties refers to properties that can be specified at a tenant level. Thus, each tenant can have different values for these properties.

Such properties are stored in the Kill Bill database and can be set by invoking the https://apidocs.killbill.io/#tenant-add-a-per-tenant-system-properties-configuration[_uploadPerTenantConfig_] endpoint.
Such properties are stored in the Kill Bill database. These properties can easily be set via the https://aviate.killbill.io[Aviate UI] by navigating to the `Settings` tab in the left nav.

For instance to set the invoice dry run notification schedule for the `boblazar` tenant, you can invoke the endpoint as follows:
Alternatively, they can be set by invoking the https://apidocs.killbill.io/#tenant-add-a-per-tenant-system-properties-configuration[_uploadPerTenantConfig_] endpoint.

For instance to set the invoice dry run notification schedule for the `bob/lazar` tenant, you can invoke the endpoint as follows:

[source]
----
Expand Down
13 changes: 7 additions & 6 deletions userguide/tutorials/avatax-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ Here is how the main Avalara fields map to Kill Bill:

== Plugin Installation

You can install the plugin as explained in the https://docs.killbill.io/latest/plugin_installation#_plugin_installation[Plugin Installation Guide].
The Avatax plugin can easily be installed via the https://aviate.killbill.io[__Aviate UI__]. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.

Alternatively, the plugin can also be via https://docs.killbill.io/latest/userguide_kaui.html[__Kaui__] or https://github.com/killbill/killbill-cloud/blob/master/kpm[_KPM_] as explained in the https://docs.killbill.io/latest/plugin_installation#_plugin_installation[Plugin Installation Guide].

For example, to install the plugin via https://github.com/killbill/killbill-cloud/blob/master/kpm[KPM], you can run the following command:

Expand All @@ -67,8 +69,6 @@ For example, to install the plugin via https://github.com/killbill/killbill-clou
kpm install_java_plugin killbill-avatax --destination=<path_to_install_plugin>
----

You can also install the plugin via the https://aviate.killbill.io/home[Aviate UI] "Plugin Marketplace" tab. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.

== Database Configuration

The AvaTax plugin requires some additional database tables. To create these tables, please follow the steps given below:
Expand Down Expand Up @@ -106,7 +106,10 @@ org.killbill.billing.plugin.avatax.accountId |Your AvaTax account number | Ye
|org.killbill.billing.plugin.avatax.requestTimeout|Specifies the maximum time in millisecond the client waits until the response is completed|No|60000
|===

These properties can be configured globally via the https://docs.killbill.io/latest/userguide_configuration.html#global_configuration_properties[Kill Bill Configuration File] or on a per-tenant basis via the https://apidocs.killbill.io/tenant#add-a-per-tenant-configuration-for-a-plugin[Add a per-tenant configuration for a plugin] endpoint. For example, to configure these properties for the `bob/lazar` tenant, you can use the following curl:
This configuration can easily be done via the https://aviate.killbill.io/home[Aviate UI] by clicking the "Configuration" link in the Aviate left nav. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.
//TODO create a separate storylane demo and add a link here?

Alternatively, these properties can be configured globally via the https://docs.killbill.io/latest/userguide_configuration.html#global_configuration_properties[Kill Bill Configuration File] or on a per-tenant basis via the https://apidocs.killbill.io/tenant#add-a-per-tenant-configuration-for-a-plugin[Add a per-tenant configuration for a plugin] endpoint. For example, to configure these properties for the `bob/lazar` tenant, you can use the following curl:

[source, bash]
----
Expand All @@ -124,8 +127,6 @@ org.killbill.billing.plugin.avatax.licenseKey=ZZZ' \
----
//TODO: Properties for TaxRatesAPI are not included as I can no longer find any documentation for this in the Avalara docs. Check if the TaxRates API works and if so include these properties

Alternatively, you can also configure these properties via the https://aviate.killbill.io/home[Aviate UI] "Plugin Configuration" tab. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.

[[aviate_integration]]
== Aviate Integration

Expand Down
12 changes: 6 additions & 6 deletions userguide/tutorials/braintree-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ The Braintree plugin allows you to process payments via the Braintree payment ga

== Plugin Installation

You can install the plugin as explained in the https://docs.killbill.io/latest/plugin_installation#_plugin_installation[Plugin Installation Guide].
The Braintree plugin can easily be installed via the https://aviate.killbill.io[__Aviate UI__]. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.

Alternatively, the plugin can also be via https://docs.killbill.io/latest/userguide_kaui.html[__Kaui__] or https://github.com/killbill/killbill-cloud/blob/master/kpm[_KPM_] as explained in the https://docs.killbill.io/latest/plugin_installation#_plugin_installation[Plugin Installation Guide].

For example, to install the plugin via https://github.com/killbill/killbill-cloud/blob/master/kpm[KPM], you can run the following command:

Expand All @@ -23,8 +25,6 @@ For example, to install the plugin via https://github.com/killbill/killbill-clou
kpm install_java_plugin braintree --destination=<path_to_install_plugin>
----

You can also install the plugin via the https://aviate.killbill.io/home[Aviate UI] "Plugin Marketplace" tab. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.

== Database Configuration

The Braintree plugin requires some additional database tables. To create these tables, please follow the steps given below:
Expand All @@ -47,7 +47,9 @@ The Braintree plugin requires the following properties:
|org.killbill.billing.plugin.braintree.btPrivateKey|The private API key from your Braintree account used alongside the public key to authenticate API calls.|Yes|-
|===

These properties can be configured globally via the https://docs.killbill.io/latest/userguide_configuration.html#global_configuration_properties[Kill Bill Configuration File] or on a per-tenant basis via the https://apidocs.killbill.io/tenant#add-a-per-tenant-configuration-for-a-plugin[Add a per-tenant configuration for a plugin] endpoint. For example, to configure these properties for the `bob/lazar` tenant, you can use the following curl:
This configuration can easily be done via the https://aviate.killbill.io/home[Aviate UI] by clicking the "Configuration" link in the Aviate left nav. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.

Alternatively, these properties can be configured globally via the https://docs.killbill.io/latest/userguide_configuration.html#global_configuration_properties[Kill Bill Configuration File] or on a per-tenant basis via the https://apidocs.killbill.io/tenant#add-a-per-tenant-configuration-for-a-plugin[Add a per-tenant configuration for a plugin] endpoint. For example, to configure these properties for the `bob/lazar` tenant, you can use the following curl:

[source, bash]
----
Expand All @@ -67,8 +69,6 @@ org.killbill.billing.plugin.braintree.btPrivateKey=xxx' \

Expected result: HTTP `201`/`204` and no validation errors in the response.

Alternatively, you can also configure these properties via the https://aviate.killbill.io/home[Aviate UI] "Plugin Configuration" tab. Refer to the <<aviate_integration, Aviate Integration>> section below for more details.

// == Kaui Integration TBD

[[aviate_integration]]
Expand Down
21 changes: 11 additions & 10 deletions userguide/tutorials/email-notification-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,23 @@ To send an email the following is required:

== Plugin Installation

A plugin can be installed either via https://docs.killbill.io/latest/plugin_installation.html#_installing_via_kaui[__Kaui__] or https://github.com/killbill/killbill-cloud/blob/master/kpm[__KPM__] or https://docs.killbill.io/latest/plugin_installation#_installing_via_aviate_marketplace[_Aviate UI_]. In order to install a plugin via kpm, you may follow the steps given below:
The email notification plugin can easily be installed via the https://aviate.killbill.io[__Aviate UI__]. Refer to https://docs.killbill.io/latest/plugin_installation#_installing_via_aviate_marketplace[this doc] for a detailed demo.

. Ensure that you have kpm installed as explained https://github.com/killbill/killbill-cloud/tree/master/kpm#kpm-installation[here].
Alternatively, the plugin can also be installed either via https://docs.killbill.io/latest/plugin_installation.html#_installing_via_kaui[__Kaui__] or https://github.com/killbill/killbill-cloud/blob/master/kpm[__KPM__] as explained in the https://docs.killbill.io/latest/plugin_installation#_plugin_installation[Plugin Installation Guide].

For example, to install the plugin via https://github.com/killbill/killbill-cloud/blob/master/kpm[KPM], you can run the following command:

. Install the plugin using the following kpm command (Replace `<path_to_install_plugin>` with the path where you want to install the plugin. This path needs to be configured via the `org.killbill.osgi.bundle.install.dir` property as specified in the https://docs.killbill.io/latest/userguide_configuration.html[Kill Bill Configuration Guide]):
[source,bash]
----
kpm install_java_plugin email-notifications --destination=<path_to_install_plugin>
----

. Verify that the plugin is installed properly. This can be done by ensuring that the plugin JAR is present at the `path_to_install_plugin` specified in the previous step. Alternatively, you can also open `kpm` in https://docs.killbill.io/latest/userguide_kaui.html[Kaui] and verify that the email notification plugin is running as follows:
+
image::https://github.com/killbill/killbill-docs/raw/v3/userguide/assets/img/email-notification-plugin/kaui_email_notification_plugin.png[align=center]

. If you would like to make changes to the plugin, you can clone the plugin code, build and deploy it as explained https://github.com/killbill/killbill-email-notifications-plugin[here].
If you would like to make changes to the plugin, you can clone the plugin code, build and deploy it as explained https://github.com/killbill/killbill-email-notifications-plugin[here].


== Database Configuration

The email-notification-plugin requires some additional database tables. To create these tables, please follow the steps given below:
The email-notification-plugin requires some additional database tables. To create these tables, please follow the stes given below:

. Connect to the Kill Bill database.

Expand Down Expand Up @@ -89,7 +88,9 @@ Reboot the system to apply the changes.
=== SMTP Configuration
A tenant needs to be configured with the SMTP properties required for sending emails. Additionally, the tenant can also be configured with the events for which emails should be sent. In addition to the per-tenant configuration, the plugin also allows a more granular account-level configuration for the set of emails to be sent for the particular account. Thus, either the tenant or the account needs to be configured with the events for which the email needs to be sent.

The tenant configuration can be done by executing the required API endpoints via *cURL* as explained below:
The configuration can easily be done via the https://aviate.killbill.io/home[Aviate UI] Refer to https://docs.killbill.io/latest/plugin_installation#_configuring_via_aviate_ui[this doc] for a detailed demo.

Alternatively, the tenant configuration can also be done or via the https://apidocs.killbill.io/tenant#add-a-per-tenant-configuration-for-a-plugin[Add a per-tenant configuration for a plugin] endpoint as explained below:

[[tenant-config]]
*Configure the tenant* using the following cURL command (Replace `<events>` with a comma-separated list of the events for which the emails need to be sent. For example, to configure the tenant to send emails for *INVOICE_CREATION* and *INVOICE_PAYMENT_SUCCESS*, specify `org.killbill.billing.plugin.email-notifications.defaultEvents=INVOICE_CREATION,INVOICE_PAYMENT_SUCCESS`):
Expand Down
Loading
Loading