{"id":21810193,"url":"https://github.com/williamsmithedward/cmssupervisorautomation","last_synced_at":"2026-03-19T21:12:59.756Z","repository":{"id":192688510,"uuid":"675539695","full_name":"WilliamSmithEdward/CMSSupervisorAutomation","owner":"WilliamSmithEdward","description":"VB.Net code for interfacing with Avaya's CMS Supervisor call center management software.","archived":false,"fork":false,"pushed_at":"2023-09-22T00:47:24.000Z","size":15,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T09:55:20.798Z","etag":null,"topics":["automation","avaya","call-center-analytics","cms","cms-supervisor"],"latest_commit_sha":null,"homepage":"","language":"Visual Basic .NET","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WilliamSmithEdward.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-07T06:50:39.000Z","updated_at":"2024-08-28T00:38:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"fa3d3d6d-92cb-4746-baaa-733ebe805a41","html_url":"https://github.com/WilliamSmithEdward/CMSSupervisorAutomation","commit_stats":null,"previous_names":["williamsmithedward/cmssupervisorautomation"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WilliamSmithEdward%2FCMSSupervisorAutomation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WilliamSmithEdward%2FCMSSupervisorAutomation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WilliamSmithEdward%2FCMSSupervisorAutomation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WilliamSmithEdward%2FCMSSupervisorAutomation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WilliamSmithEdward","download_url":"https://codeload.github.com/WilliamSmithEdward/CMSSupervisorAutomation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244767542,"owners_count":20507110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","avaya","call-center-analytics","cms","cms-supervisor"],"created_at":"2024-11-27T13:33:29.212Z","updated_at":"2026-01-04T06:43:47.989Z","avatar_url":"https://github.com/WilliamSmithEdward.png","language":"Visual Basic .NET","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CMSSupervisorAutomation\nVB.Net code for interfacing with Avaya's CMS Supervisor call center management software. Testing was performed using CMS Supervisor R19.\n\n## Example\n\nThe example below establishes a connection to both an MS Access database and a CMS server. After setting up the connections, it triggers a report generation based on selected date ranges and finally, disconnects from the CMS server.\n\n* Initializes a connection to an MS Access database using the given path: \"PATH_TO_ACCESS_DB.accdb\".\n* Initializes a connection to the CMS server with specified server details and user credentials.\n* Connects to the CMS server.\n* Calls the `RunMyCMSReport` method of the Reporting class to generate a report. The report is based on the date range selected using startDateTimePicker and endDateTimePicker controls.\n* Disconnects from the CMS server.\n\n```csharp\nPrivate Sub RunReportButton_Click(sender As Object, e As EventArgs) Handles RunReportButton.Click\n\n    Dim access As New MSAccessConnection(\"PATH_TO_ACCESS_DB.accdb\")\n\n    Dim connection As New CMSSupervisorConnection(\"CMS_SERVER\", 2, \"Username\", \"Password\")\n    connection.Connect()\n\n    Reporting.RunMyCMSReport(connection,\n        access, \n        startDateTimePicker.Value.ToString(\"M/d/yyyy\"),\n        endDateTimePicker.Value.ToString(\"M/d/yyyy\")\n    )\n\n    connection.Disconnect()\n\nEnd Sub\n```\n\n### Considerations\n* Ensure the path to the MS Access database (\"PATH_TO_ACCESS_DB.accdb\") is valid and accessible.\n* The logic in the `RunMyCMSReport` method should be tailored to your CMS report as well as the database table you have implemented.\n* The server address, ACD number, and user credentials for the CMS server should be valid to establish a successful connection.\n* Date range is selected using startDateTimePicker and endDateTimePicker controls, and it's essential they are correctly set before triggering this method.\n\n## CMSSupervisorConnection Class\n\nThis class is used to establish and manage a connection with the CMS server.\n\n### Properties\n\n- **_serverAddress** (String): Address of the server.\n- **_acd** (Integer): ACD number.\n- **_userName** (String): User name for connection.\n- **_password** (String): Password for connection.\n- **_cvsApp** (ACSUP.cvsApplication): CVS Application instance.\n- **_cvsConn** (ACSCN.cvsConnection): CVS Connection instance.\n- **_cvsSrv** (ACSUPSRV.cvsServer): CVS Server instance.\n\n### Constructor\n\n#### `Public Sub New(ByVal serverAddress As String, ByVal acd As Integer, ByVal userName As String, ByVal password As String)`\n\nConstructor for the CMSSupervisorConnection class. Initializes any default values, sets up required configurations, and prepares the instance for communication with the CMS server.\n\n* **serverAddress**: The hostname or IP address of the CMS server.\n* **acd**: The Automatic Call Distributor (ACD) number. Represents the ACD system number on the CMS which the connection is intended for.\n* **userName**: The username used for authentication.\n* **password**: The password used for authentication.\n\n### Methods\n\n#### `Public Sub Connect()`\n\nEstablishes the connection to the CMS server using provided credentials.\n\n#### `Public Sub Disconnect()`\n\nDisconnects and releases the resources associated with the CMS server connection.\n\n#### `Public Function ExecuteQuery(reportPath As String, reportParams As Dictionary(Of String, String), timeZone As String) As String`\n\nExecutes a report query on the CMS server and returns the result as a string.\n\n- **reportPath**: Path to the desired report.\n- **reportParams**: Key-value pairs of parameters for the report.\n- **timeZone**: Time zone for the report (pass empty string if the report does not implement time-zone).\n\n## MSAccessConnection Class\nThis class provides a connection to a Microsoft Access database.\n\n### Properties\n* **_dbFilePath** : A string indicating the path to the Microsoft Access database file.\n\n### Methods\n\n#### `Public Function QueryIntoDataTable(sql As String) As DataTable`\n\nConnects to the MS Access database and fetches the data as per the provided SQL query into a DataTable.\n\n* **sql**: A SQL query string to fetch data from the database.\n* **Returns**: A DataTable object containing the result of the query.\n\n#### `Public Sub ExecuteSql(sql As String)`\n\nConnects to the MS Access database and executes the provided SQL command, which is typically used for non-query operations like Insert, Update, and Delete.\n\n* **sql**: A SQL command string for database operation.\n\n## Reporting Class\n\nThis class provides example methods for generating different types of reports.\n\n### Methods\n\n#### `Public Shared Sub RunSkillSummary(cms As CMSSupervisorConnection, access As MSAccessConnection, startDate As String, endDate As String)`\n\nThis method is designed to process and insert skill summary reports into an MS Access database from the data extracted using a CMS server connection.\n\n* **cms**: CMSSupervisorConnection object.\n* **access**: MSAccessConnection object.\n* **startDate**: Start date for the report.\n* **endDate**: End date for the report.\n\n1.) Date Loop:  \n* The method starts by setting the sDate (current processing date) to startDate.\n* There's a loop that processes data for each date from startDate to endDate.\n    \n2.) Data Extraction and Insertion:\n* For each date in the loop:\n    * The method checks if there's already existing data for the current date (sDate) in the Access database. If not:\n        * It fetches the skill summary data for the current date from the CMS server using the cms.ExecuteQuery method.\n        * This data is then parsed and split into individual lines.\n        * The relevant line containing data fields is then split into individual fields.\n        * An SQL INSERT statement is constructed using these fields and then executed to insert the data into the DATA_Skill_Summary table in the Access database.\n\n3.) Date Increment:\n* After processing for the current date is completed, sDate is incremented by 1 day.\n* The loop continues until all dates from startDate to endDate have been processed.\n\n4.) After all dates have been processed, a final SQL statement (Execute []) is executed on the Access database.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilliamsmithedward%2Fcmssupervisorautomation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwilliamsmithedward%2Fcmssupervisorautomation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilliamsmithedward%2Fcmssupervisorautomation/lists"}