Target Audience: Administrators
Introduced in Payway 4.6.7, packages can now be grouped in the PAP. While editing various configurations based on specific, hand-picked packages can sometimes be a necessity, it can during other times be a huge hassle, and this is what package groups aim to eliminate.
Package groups allow you to create a group, consisting of one or more packages, to later use this group in various configurations across Payway. This means you can group together packages of your choosing, and then simply modify your configurations to use these groups instead. And the best part? We'll take care of the rest!
Configuring a Package group¶
Package groups are disabled by default, so before you can start using them, we'll need to enable them for you. In order to enable package groups, please reach out to our support.
Once you have the feature enabled, you can create your first package group. In order to do so, navigate to PAP => Packages & Campaigns => Package groups. In here, you will decide on a few things:
- Name: The name the package group should have. While the customer's won't see this name, it will be used to identify the group across the PAP.
- Key: A unique, read-only code corresponding to this package group, which can be used to easier identify a package group in API responses.
- Rank: The rank each package included in the group should use.
- A rank specified on a specific package will always take priority over the rank set on package groups.
- If a package is included in multiple groups with different rankings, the group with the highest ranking will be used.
- Included packages: These packages will be included in the group. You can select currently active packages, as well as across different titles.
Using a Package group¶
Once you have your first campaign group created, you will now be able to start using it. Currently we offer campaign group usage in the following configurations, though the list is constantly expanding, so make sure you check back every so often!
Note: The configurations that use package groups are often cached, and changes can take up to an hour to break through.
Package group priority¶
When working with a configuration that allows both packages and package groups to be selected, the specific packages will always take priority over the selected package groups.
For example, if a sharing configuration is configured for "My Package", and another sharing configuration is configured using a package group that also includes "My Package", the first sharing configuration will be used when deciding whether a subscription can be shared or not.
Much like what is stated above, a field configuration configured on a specific package will always take priority over the field configuration specified on a package group. However, to get a better idea on what the field configuration hierarchy looks like, we recommend having a look at the hierarchy table found here.