Skip to content

Latest commit

 

History

History
121 lines (104 loc) · 4.77 KB

CUSTOM_DATA.md

File metadata and controls

121 lines (104 loc) · 4.77 KB

Custom data

How to run with custom data (outside the classpath)

You must have a folder (e.g. /path/to/custom/resources/folder/) that contains one or more custom json files. You set all new locations (or just the ones that you are interested in) like this:

java -Denvironment.name=your-env-00 \
-Dcustom.path=/path/to/custom/resources/folder \
-Djob.profiles.json=${custom.path}/job-profiles.json \
-Dproducts.json=${custom.path}/products.json \
-Dproduct.group.seed.json=${custom.path}/product-group-seed.json \
-Dservice.agreements.json=${custom.path}/service-agreements.json \
-Dlegal.entities.with.users.json=${custom.path}/legal-entities-with-users.json \
-jar bb-fuel-{version}-boot.jar

An alternative approach is when you have copied the data.properties from the jar you can configure properties above and put it in the current directory or in the user home directory.

java -Denvironment.name=your-env-00 bb-fuel-{version}-boot.jar

It is also possible to collect data into property files and provide path to it via custom.properties.path system property

java -Dspring.profiles.active=k8s \
-Denvironment.name={your-env-number} \
-Dingest.access.control=true -Dingest.custom.service.agreements=true \
-Dingest.balance.history=true -Dingest.transactions=true \
-Dcustom.properties.path=data/us-productized-dataset/us-productized-data.properties 
-jar bb-fuel-{version}-boot.jar

Built-in custom data setup

How to run with performance test data setup

Based on gatling-performance-simulations:

java -Denvironment.name=your-env-00 -Dlegal.entities.with.users.json=data/performance/performance-test-legal-entities-with-users-{retail or business}.json bb-fuel-{version}-boot.jar

How to run on multi-tenancy environments

Based on multi-tenancy LDAP configuration in Autoconfig environments

java -Denvironment.name=your-env-00 \
-Dmulti.tenancy.environment=true \
-jar bb-fuel-{version}-boot.jar

This will ingest the following:

tenant.id root.entitlements.admin legal.entities.with.users.json
tenant_a user001_t1 data/multitenancy/tenant_a.json
tenant_b user006_t2 data/multitenancy/tenant_b.json
tenant_c user011_t3 data/multitenancy/tenant_c.json
tenant_d user016_t4 data/multitenancy/tenant_d.json
tenant_e user021_t5 data/multitenancy/tenant_e.json

Note: this default is a simple multi-tenancy setup example. If you want a different setup you can override the default property multi.tenancy.legal.entities.with.users.json and configure it with multiple json files by separating them with a semi-colon (;). Note that in each file you have to define the tenantId and the root admin user for that tenant, e.g.:

    "tenantId": "tenant_a",
    "users": [
      {
        "externalId": "user001_t1",
        "role": "admin"
      }, ...

How to create custom data

Example for the legal-entities-with-users.json (other files are: serviceagreements.json and products.json):

  1. Create json file named legal-entities-with-users.json with custom legal entities and assigned custom user list conforming existing format (in this case conforming: legal-entities-with-users.json)

By default if customizable fields have not been provided, system will generate randomized values for it. Full names will be derived from externalId if this field contains dot(s) or underscore(s) (just set the full name if you do not want this feature). Optional fields in the data structure:

  • legalEntityExternalId
  • parentLegalEntityExternalId
  • legalEntityName
  • legalEntityType
  • tenantId
  • user.fullName
  • user.role

Mandatory fields:

  • user.externalId - string representing User id.

Each user in array will be ingested under the above legal entity.

Example:

[
  {
    "legalEntityExternalId": "LE000002",
    "parentLegalEntityExternalId": "C000000",
    "legalEntityName": "Hong Kong Legal Entity",
    "legalEntityType": "CUSTOMER",
    "users": [
      {
        "externalId": "U0091011"
      },
      {
        "externalId": "U0091012"
      },
      {
        "externalId": "U0091013"
      },
      {
        "externalId": "U0091014"
      },
      {
        "externalId": "U0091015"
      }
    ]
  }
]
  1. Place legal-entities-with-users.json in a folder named data

Note: it is also possible to name/place the json file differently with the specific properties: legal.entities.with.users.json and service.agreements.json