# Groupping Tool
# Onboarding Workflow for Grouping Tool
Param for API onboard:
In these params:
org_id
input_table
is required fieldsout_table
parent_org_id
is optinal fields
# Onboarding logic:
Firstly, check whether the passed org_id
has the same parent_org_id
passed in.
- If
parent_org_id
is passed along withorg_id
- Check if parent_org_id is onboarded or not in metadata table of CTG. If it has not yet been onboarded, BE side will raise an error -> onboard for
org_id
failed - If
parent_org_id
onboard, BE side will use information about tables ofparent_org_id
-> insert new rows including tables oforg_id
in postgres metadata -> onboard successfully.
- If
parent_org_id
is not passed -> Now,org_id
is parent_org When onboarding fororg_id
, the following tables will be automatically initialized
Output Table
Benchmark Metric Table
Tactical Benchmark Metric Table
Funnel Level Table
=> The names of these tables will be generated and created by the BE side
if out_table
is passed in API, BE side will use this name to create out table instead of using out_table name which generated