ctxcli 0.1.5

CLI Tools for Amdocs ConnectX

Table of Contents

• Introduction

• Installation

• Authentication

• Commands

  • Users

  • Tenant

  • Migration

  • Business Units

  • Orders

    • Usage

    • Arguments

• License

Introduction

The ctxcli package provides Command Line Interface (CLI) tools for Amdocs ConnectX. These tools allow authorized ConnectX users to perform various operations on the system.

Installation

Before installing ctxcli, ensure that Python and pip are installed on your system.

To install ctxcli from PyPI, use the following command:

pip install ctxcli

Authentication

Before running any command, you need to authenticate by running the ‘auth’ command. Use the following command to authenticate:

ctxcli auth

You will be prompted to enter your tenant, environment (dev, ppe, prod), username, and password.

You can check the validity of your current session in any time by using the authcheck command. This command verifies whether you are authenticated and provides information about your active session.

Commands

The ctxcli commands are divided into the following categories: Users, Tenant, and Migration.

Users

To list all the users in the system, use the following command:

ctxcli user list

Here’s an example of the output:

Tenant

To list all the sub-tenants in the system, use the following command:

ctxcli tenant list

Here’s an example of the output:

Migration

To list all the migration files in the system, use the following command:

ctxcli migration file list

Here’s an example of the output:

Business Units

To list all the business units in the system, use the following command:

ctxcli business-unit list

Here’s an example of the output:

To add users to business units, use the following command:

ctxcli business-unit add-users --file <file_path>

This command requires a CSV file that contains the necessary user information. The file can be placed in the “input” folder. You can specify the path to this CSV file using the –file argument followed by the path to your file. The CSV file should include two columns with headers:

business_unit_id: The internal ID of the Business Unit to which you want to add users. username: The username of the user you want to add to the Business Unit.

The command will read each line of the CSV file and attempt to add the specified user to the corresponding Business Unit.

Orders

The ctxcli order export command allows you to export orders to an Excel file for a specified date range.

Usage

To export orders to an Excel file, use the following command:

ctxcli order export --start-date <start_date> --end-date <end_date> --output <file_path>

Arguments

• –start-date <start_date>: The start date for the order export in the format YYYY-MM-DD.

• –end-date <end_date>: The end date for the order export in the format YYYY-MM-DD.

• –output <file_path>: The file path for the output Excel file. The file will be created if it does not exist.

License

Copyright 2024 Amdocs