# How-To

# Relationship Management

#### Introduction

Relationship management is a critical part of administering the system.

[![image.png](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/scaled-1680-/ZwQimage.png)](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/ZwQimage.png)

---

#### Add a Distributor

**Purpose**  
Register a new distributor as the top-level commercial entity under the platform.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Relationships→ Distributors.
2. Select **Create**.
3. Enter Distributor Name and details.
4. Assign a Distributor Administrator user.
5. Select **Save**.

---

#### Edit a Distributor

**Purpose**  
Update distributor details or administrators.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Relationships → Distributors.
2. Select the distributor you want to edit.
3. Update Name, contact information, or administrator assignments.
4. Select **Save**.

---

#### Delete a Distributor

**Purpose**  
Remove a distributor permanently.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Relationships → Distributors.
2. Select the distributor you want to delete.
3. Select **Delete**.
4. Confirm deletion.

---

#### Add a Partner

**Purpose**  
Register a new partner under a distributor.

**Permission Level**  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Relationships → Partners.
2. Select **Create**.
3. Enter Partner Name and details.
4. Assign Partner Administrator(s).
5. Select the Distributor this partner belongs to.
6. Select **Save**.

---

#### Edit a Partner

**Purpose**  
Update partner details or administrator assignments.

**Permission Level**  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Relationships → Partners.
2. Select the partner you want to edit.
3. Update details or administrators.
4. Select **Save**.

---

#### Delete a Partner

**Purpose**  
Remove a partner permanently.

**Permission Level**  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Relationships → Partners.
2. Select the partner you want to delete.
3. Select **Delete**.
4. Confirm deletion.

---

#### Add a Tenant

**Purpose**  
Onboard a consuming organization under a partner.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Relationships → Tenants.
2. Select **Create**.
3. Enter Tenant Name and details.
4. Assign Tenant Administrator(s).
5. Select the Partner this tenant belongs to.
6. Select **Save**.

---

#### Edit a Tenant

**Purpose**  
Update tenant details or administrators.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Relationships → Tenants.
2. Select the tenant you want to edit.
3. Update details or administrators.
4. Select **Save**.

---

#### Delete a Tenant

**Purpose**  
Remove a tenant permanently.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Relationships → Tenants.
2. Select the tenant you want to delete.
3. Select **Delete**.
4. Confirm deletion.

# Region Management

#### Introduction

This page covers day-to-day region administration.

[![image.png](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/scaled-1680-/mwrimage.png)](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/mwrimage.png)

#### Add a Region

**Purpose**  
Register a new region so usage can be collected and processed.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Administration → Regions.
2. Select **Create**.
3. Enter Region Name and details.
4. Provide required endpoints and credentials.
5. Set default time zone and collection window.
6. Select **Save**.

---

#### Edit a Region

**Purpose**  
Update credentials, endpoints, or metadata for an existing region.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Administration → Regions.
2. Select the region you want to edit.
3. Update Region Name, credentials, endpoints, or time zone as required.
4. Select **Save**.

---

#### Start Usage Processing

**Purpose**  
Manually trigger usage processing for a region.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Administration → Regions.
2. Select the region you want to process.
3. Select **Update Usage**
4. Choose the date range (start and end).
5. Confirm and monitor the job status.

---

#### Remove a Region

**Purpose**  
Delete a region that is no longer in use.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Administration → Regions.
2. Select the region you want to delete.
3. Select **Delete**.
4. Confirm the deletion.

---

#### Check Region Health

**Purpose**  
View the health and last run status of a region.

**Permission Level**  
Platform Administrator

**Steps**

1. Go to Administration → Regions.
2. Open the **Health** or **Status** panel for the region.
3. Review last run time, errors, and next scheduled run.
4. Drill into failed jobs if needed.

# User Management

#### Introduction

This page covers day-to-day user administration across the commercial hierarchy (platform, distributor, partner, tenant). It includes adding, editing, disabling, deleting users, assigning roles and scopes, and handling password/MFA resets.

[![image.png](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/scaled-1680-/ZA7image.png)](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/ZA7image.png)

---

#### Add a new User

##### **Purpose**

Add a new user to the system.

##### **Permission Level**

- Platform Administrator
- Partner Administrator
- Distributor Administrator
- Tenant Administrator

##### **Steps**

1. Go to Settings→ Users.
2. Select Create.
3. Enter First Name, Last Name, Email Address, and optionally Phone Number.
4. Select User Role. Select Distributor, Partner, and Tenant to define the user’s scope.
5. (Optional) Toggle MFA Required if your policy requires MFA at next sign-in.
6. (Optional) Toggle Federated Only to prevent local password login for this user.
7. Save.

---

#### Modify an existing User

##### **Purpose**

Modify an existing user’s details, role, scope, or security options.

##### **Permission Level**

- Platform Administrator
- Partner Administrator
- Distributor Administrator
- Tenant Administrator

##### **Steps**

1. Go to Settings → Users.
2. Select the user you want to edit.
3. Update First Name, Last Name, Email Address, or Phone Number if required.
4. Adjust User Role.
5. Update Distributor, Partner, and Tenant scope as needed.
6. Adjust toggles: MFA Required, Federated Only, Disabled, or Locked Out.
7. Select Save.

---

#### Disable or Enable a User

##### **Purpose**

Temporarily block or restore user access without deleting the account.

##### **Permission Level**

- Platform Administrator
- Partner Administrator
- Distributor Administrator
- Tenant Administrator

##### **Steps**

- Go to Settings → Users.
- Select the user you want to edit.
- Toggle **Disabled** on to suspend, off to re-enable.
- Select **Save.**

---

### Unlock a User

**Purpose**  
Clear a lockout after failed login attempts.

**Permission Level**  
Platform Administrator  
Distributor Administrator  
Partner Administrator  
Tenant Administrator

**Steps**

1. Go to Settings → Users.
2. Select the user you want to edit.
3. Unset the **Locked Out** indicator.
4. Select **Save**.

---

### Enforce MFA

**Purpose**  
Require the user to register or re-register MFA at next sign-in.

**Permission Level**  
Platform Administrator  
Distributor Administrator  
Partner Administrator  
Tenant Administrator

**Steps**

1. Go to Settings → Users.
2. Select the user you want to edit.
3. Toggle **MFA Required** on.
4. Select **Save**.

---

### Force Federated Only

**Purpose**  
Restrict the account to federated sign-in only (no local password).

**Permission Level**  
Platform Administrator  
Distributor Administrator  
Partner Administrator  
Tenant Administrator

**Steps**

1. Go to Settings → Users.
2. Select the user you want to edit.
3. Toggle **Federated Only** on.
4. Select **Save**.

---

### Delete a User

**Purpose**  
Remove a user account permanently.

**Permission Level**  
Platform Administrator  
Distributor Administrator  
Partner Administrator  
Tenant Administrator

**Steps**

1. Go to Settings → Users.
2. Select the user you want to delete.
3. Choose **Delete**.
4. Confirm the deletion.

# Subscription Management

#### Introduction

This page covers creating, managing and removing subscriptions in the system.

[![image.png](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/scaled-1680-/TS7image.png)](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/TS7image.png)

#### Add a Subscription

**Purpose**  
Create a new subscription for a tenant.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Administration → Subscriptions.
2. Select **Create**.
3. Enter Subscription Name.
4. Select the tenant required.
5. Enter in the Entra tenant and initial owner information.
6. Select **Save**.

---

#### Edit a Subscription

**Purpose**  
Update subscription detail.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Administration → Subscriptions.
2. Select the subscription you want to edit.
3. Update as required.
4. Select **Save**.

---

#### View Subscription Details

**Purpose**  
See subscription usage, billing, and configuration.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator  
Tenant Administrator (limited to own subscriptions)

**Steps**

1. Go to Administration → Subscriptions.
2. Select the subscription to open its details.
3. Review usage metrics, plan assignments, and status.

---

#### Update Usage (Manual)

**Purpose**  
Trigger a manual usage update for a subscription.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Administration → Subscriptions.
2. Select the subscription you want to update.
3. Choose **Update Usage**.
4. Enter date range if prompted.
5. Confirm.

---

#### View Subscription Summary

**Purpose**  
Generate a usage and billing summary for reporting or reconciliation.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Administration → Subscriptions.
2. Select **Summary**.
3. Enter filters (tenant, date range).
4. Run summary.
5. Review usage totals and billing results.

---

#### Delete a Subscription

**Purpose**  
Remove a subscription that is no longer required.

**Permission Level**  
Partner Administrator  
Distributor Administrator  
Platform Administrator

**Steps**

1. Go to Administration → Subscriptions.
2. Select the subscription you want to delete.
3. Select **Delete**.
4. Confirm deletion.

# System Settings

#### Introduction

Configure global CMS behavior, including provisioning rules, billing defaults, invoice appearance, calculators, and health checks.

[![image.png](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/scaled-1680-/141image.png)](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/141image.png)

#### Permission Level

Platform Administrator

---

#### Tenant Settings

- **Partner Self Provisioning** — Allow partners to create their own tenants. *(Switch)*
- **Distributor Self Provisioning** — Allow distributors to create their own tenants. *(Switch)*
- **Default Tenant Currency** — Set the default currency for new tenants, partners, and distributors. *(Currency List)*

**Steps**

1. Go to Administration → System Settings → Tenants.
2. Toggle or select values as needed.
3. Select **Save**.

---

#### Subscription Settings

- **Tenant Self Provisioning** — Allow tenants to create their own subscriptions. *(Switch)*
- **Partner Provisioning** — Allow partners to provision subscriptions for their tenants. *(Switch)*
- **Distributor Provisioning** — Allow distributors to provision subscriptions for their tenants. *(Switch)*
- **Auto Created Subscription Tenant Id** — Default tenant for subscriptions created automatically from platform subscriptions. *(Tenant List)*
- **Perform Tenant Identity Health Checks** — Enable tenant identity health checks. *(Switch)*
- **Auto Create Missing Subscriptions** — Automatically create CMS subscriptions from detected platform subscriptions. *(Switch)*

**Steps**

1. Go to Administration → System Settings → Subscriptions.
2. Adjust values.
3. Select **Save**.

---

#### Invoice Settings

- **Invoice Submission Delay (Days)** — Delay sending preview invoices after month end. *(Number Box)*
- **Header Background Colour** — Set invoice header background color. *(Colour Picker)*
- **Body Background Colour** — Set invoice body background color. *(Colour Picker)*
- **Footer Background Colour** — Set invoice footer background color. *(Colour Picker)*
- **Header Font Colour** — Set header text color. *(Colour Picker)*
- **Body Font Colour** — Set body text color. *(Colour Picker)*
- **Footer Font Colour** — Set footer text color. *(Colour Picker)*
- **Grouping Background Colour** — Set table grouping background color. *(Colour Picker)*
- **Grouping Font Colour** — Set table grouping font color. *(Colour Picker)*
- **Invoice Header Logo** — Upload logo for invoice header. *(File Picker)*
- **Invoice Payment Details** — Configure invoice footer payment details. *(Text Box)*
- **Auto Create Invoices** — Enable automatic invoice generation. *(Switch)*
- **Auto Email Invoices** — Enable automatic emailing of issued invoices. *(Switch)*
- **Delinquent Payment Notification Interval (Days)** — Frequency for sending delinquent notifications. *(Number Box)*
- **Send Delinquent Payment Notifications** — Enable sending of delinquent notifications. *(Switch)*
- **Store Invoices In Azure Storage** — Upload invoices to Azure Stack storage account. *(Switch)*
- **Default Invoice Payment Terms (Days)** — Default overdue period. *(Number Box)*

**Steps**

1. Go to Administration → System Settings → Invoices.
2. Adjust visual, timing, and delivery settings.
3. Select **Save**.

---

#### User Settings

- **Tenant Self Provisioning** — Allow tenants to create their own users. *(Switch)*
- **Partner Self Provisioning** — Allow partners to create their own users. *(Switch)*
- **Distributor Self Provisioning** — Allow distributors to create their own users. *(Switch)*
- **Require User Activation** — Require users to activate their accounts before login. *(Switch)*
- **Require User Activation Code** — Require activation code at first login. *(Switch)*

**Steps**

1. Go to Administration → System Settings → Users.
2. Adjust toggles.
3. Select **Save**.

---

#### Billing Settings

- **Default Platform Currency** — Base currency for the platform. *(Currency List)*
- **Use Monthly Variable Pricing** — Apply variable pricing based on hours in the month. *(Switch)*

**Steps**

1. Go to Administration → System Settings → Billing.
2. Adjust defaults.
3. Select **Save**.

---

#### Calculator Settings

- **Show To Tenants** — Show the calculator to tenants. *(Switch)*
- **Show To Partners** — Show the calculator to partners. *(Switch)*
- **Show To Distributors** — Show the calculator to distributors. *(Switch)*

**Steps**

1. Go to Administration → System Settings → Calculator.
2. Adjust visibility.
3. Select **Save**.

---

#### Platform Settings

- **Report Platform Alerts** — Generate CMS alerts for platform-specific health events. *(Switch)*

**Steps**

1. Go to Administration → System Settings → Platforms.
2. Toggle settings.
3. Select **Save**.

---

#### Job Settings

- **Job Maximum Runtime (Hours)** — Maximum runtime before a job is marked as failed. *(Number Box)*

**Steps**

1. Go to Administration → System Settings → Jobs.
2. Adjust the maximum runtime.
3. Select **Save**.

# Price Management

#### Introduction

Manage all pricing constructs for the CMS. Pricing is scoped either at the **Region** or **Tenant** level. Features include SKU and meter pricing, credits, tiered thresholds, cloning price lists, applying modeled price increases, and estimating impact.

[![image.png](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/scaled-1680-/1HVimage.png)](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/1HVimage.png)

#### Permission Level

Platform Administrator

---

#### Create or Edit a Price List

**Purpose**  
Define rates for a region or tenant.

**Steps**

1. Go to Pricing.
2. Choose Region or Tenant scope.
3. Enter a Display Name and Description.
4. Add Pricing Items:
    
    
    - **Meter / SKU** — Select from available meters.
    - **Rate** — Enter base rate.
    - (Optional) **Credits** — Enter credits to offset usage.
    - (Optional) **Tiered Thresholds** — Define usage ranges with rates.
5. Save.

---

#### Clone a Price List

**Purpose**  
Quickly create a new list by copying an existing one.

**Steps**

1. Go to Administration → Pricing.
2. Select the price list to clone.
3. Choose **Clone Price List**.
4. Select target scope (Region or Tenant).
5. Update details as required.
6. Save.

---

#### Add or Edit Meter and SKU Pricing

**Purpose**  
Set or adjust prices for specific meters and SKUs.

**Steps**

1. Open a Price List.
2. Select **Add Meter/SKU**.
3. Choose the desired Meter.
4. Enter Rate, Unit, and Description.
5. (Optional) Apply Credits or Tiered Thresholds.
6. Save.

---

#### Configure Credits

**Purpose**  
Offset costs for specific meters, subscriptions, or tenants.

**Steps**

1. Open a Price List.
2. Select a Meter or SKU.
3. Enter Credit amount.
4. Save.

---

#### Configure Tiered Pricing

**Purpose**  
Apply progressive rates based on usage ranges.

**Steps**

1. Open a Price List.
2. Select a Meter or SKU.
3. Add **Tiered Threshold**.
4. Enter From Quantity, To Quantity, and Rate.
5. Save.

---

#### Apply Price Increases (with Modeling)

**Purpose**  
Increase pricing by percentage or fixed amount and preview the impact before applying.

**Steps**

1. Go to Administration → Pricing Tools → Price Increase.
2. Choose **Scope** (Region or Tenant).
3. Select Increase Type: **Percentage** or **Fixed Amount**.
4. Enter Increase Amount.
5. Run **Model** to preview impacts across meters and tenants.
6. Review modeled results.
7. Apply changes to generate updated Price List.

---

#### Estimate Costs (Estimator Tool)

**Purpose**  
Model tenant or subscription costs using current or proposed pricing.

**Steps**

1. Go to Administration → Pricing Tools → Estimator.
2. Select Tenant or Subscription.
3. Choose a Price List.
4. Enter estimated usage quantities.
5. Run Estimate.
6. Review projected cost breakdown.

---

#### Delete a Price List

**Purpose**  
Remove an obsolete price list.

**Steps**

1. Go to Administration → Pricing.
2. Select the price list.
3. Choose **Delete**.
4. Confirm.

# Billing Management

#### Purpose

Manage invoicing and commission processing in the CMS.  
Invoices capture tenant consumption and apply pricing rules.  
Commissions remunerate partners and distributors based on consumption.

[![image.png](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/scaled-1680-/fYSimage.png)](https://docs.cloudaxis.cloud/uploads/images/gallery/2025-09/fYSimage.png)

#### Permission Level

Platform Administrator  
Distributor Administrator (limited to own scope)  
Partner Administrator (limited to own scope)

---

#### Generate Invoices

**Purpose**  
Create invoices for a billing period.

**Steps**

1. Go to Administration → Billing → Invoices.
2. Select **Generate**.
3. Choose Billing Period (e.g. month).
4. Select Tenant(s) or run for all.
5. Confirm generation.

---

#### View Invoice

**Purpose**  
Review invoice details before issuing to tenants.

**Steps**

1. Go to Administration → Billing → Invoices.
2. Select the invoice.
3. Review consumption, pricing, discounts, and totals.
4. Verify currency and payment terms.

---

#### Issue Invoice

**Purpose**  
Move invoice from preview to issued.

**Steps**

1. Go to Administration → Billing → Invoices.
2. Open the preview invoice.
3. Select **Issue**.
4. Confirm.

---

#### Email Invoice

**Purpose**  
Send an issued invoice to tenant billing contacts.

**Steps**

1. Go to Administration → Billing → Invoices.
2. Select the invoice.
3. Choose **Email Invoice**.
4. Confirm.

---

#### Store Invoice in Azure Stack

**Purpose**  
Upload invoices to configured Azure Stack storage.

**Steps**

1. Ensure “Store Invoices in Azure Storage” is enabled under System Settings → Invoices.
2. Generate or Issue an invoice.
3. Verify invoice appears in the storage account.

---

#### Delete an Invoice

**Purpose**  
Remove an invoice (typically in preview status).

**Steps**

1. Go to Administration → Billing → Invoices.
2. Select the invoice.
3. Choose **Delete**.
4. Confirm.

---

### Commission Management

#### Purpose

Calculate and review commissions for partners and distributors.

---

#### Configure Commission Rates

**Purpose**  
Set commission tiers based on consumption.

**Steps**

1. Go to Administration → Billing → Commissions → Rates.
2. Select Distributor or Partner.
3. Add one or more Tiers: From Amount, To Amount, Percentage.
4. Save.

---

#### Generate Commission Summary

**Purpose**  
Produce commission calculations for a billing period.

**Steps**

1. Go to Administration → Billing → Commissions.
2. Select **Generate Summary**.
3. Choose Period (month or year).
4. Confirm.

---

#### View Commission Summary

**Purpose**  
Review commission results for a distributor or partner.

**Steps**

1. Go to Administration → Billing → Commissions.
2. Select the entity.
3. Review calculated totals and tier application.

---

#### Export Commission Data

**Purpose**  
Download commission summaries for financial reporting.

**Steps**

1. Go to Administration → Billing → Commissions.
2. Select **Export**.
3. Choose format (CSV, Excel, etc.).
4. Confirm.

# Container Management

#### Introduction

This section will outline the steps necessary to patch and maintain the CMS software delivered as containers.

---

#### Patch Docker Host

**Purpose**  
Deploy the latest updated to the Docker host itself.

**Permission Level**  
Docker Host Administrator

**Notes**

- You will likely need to enable the firewall ruleset that allows SSH access into the Docker host.
- If necessary, execute docker logs \[container name\].

**Steps**

1. Connect via SSH to the host.
2. Execute **sudo apt update**
3. Execute **apt list --upgradable**
4. Execute **sudo apt upgrade -y**
5. Execute **cd /mnt/cms**
6. Execute **docker ps -a**

---

#### Update Containers

**Purpose**  
Update all containers in the CMS service to the latest version.

**Permission Level**  
Docker Host Administrator

**Notes**

- You will likely need to enable the firewall ruleset that allows SSH access into the Docker host.

**Steps**

1. Connect via SSH to the host.
2. Execute **cd /mnt/cms**
3. Execute **docker compose down**
4. Execute **docker compose pull**
5. Execute **docker compose up -d**
6. Execute **docker ps -a**
7. Execute **docker system prune -a**