# Oracle CPQ UI Automation
Selenium based automation bot to do routine and time consuming tasks on Oracle CPQ Cloud application.
## Pre-requisites
* Chrome Browser should be installed
* Supports Python >= 3.9
* CPQ account should have admin access with proxy login option
### Installation
```
pip install py-oracle-cpq-ui-automation
```
### Usage
Just type `import oracle_cpq_ui_automation` in the module you want to use Oracle CPQ UI Automation.
### Example
```
import oracle_cpq_ui_automation
#Initialise the automation class with SiteName, username, password
main = oracle_cpq_ui_automation("<cpqInstanceName>","<userName>","<password>")
#It will autolaunch the Chromedriver browser
#Login into the CPQ Site
main.login()
```
## Automation Functions
### 1) Partner Orgs: Create Groups
Navigate to Partner Orgs page and check if the given groups exists in the partner org, else it will create the group
#### Inputs:
1. groupsToCreate = [ [<groupName | string>, <groupVarName | string>, <addAllUsersToGroup | boolean> ] ]
2. exceptionListOfCompanies = [<partnerOrg-VariableName>]
3. noOfPagesToSkip = -1
#### Code:
```
main.createGroupsinPartnerOrg(
[["<groupName>","<groupVar",True]], #groupsToCreate #2D Array of mixed datatype
[], #exceptionListOfCompanies = [] #Array of strings
-1 #noOfPagesToSkip = -1
)
```
### 2) Extract and Save BML Libraries as Text files.
Navigates to Util library page and save all the util libraries as text file
#### Inputs:
1. skipLibraries = 0 #Skip no.of.libraries to save
#### Code:
```
main.extractBmlLibrary(skipLibraries=0)
```
#### Output:
The output folder will be created and files will be saved locally in the below path
```
D:\
> <cpqInstanceName
> BML Library
> library1.txt
library2.txt
```
### Bot Features
* Automation Bot will automatically download the compatible chrome driver version based on your installed browser.
* Automations are UI-based so users can monitor, if any unexpected behaviour occurs then can close the automation to avoid problems.
### Authors & Contributors
* Arun Kumar (arunkumar.js25@gmail.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/arunkumar-js25/oracle_cpq_ui_automation",
"name": "py-oracle-cpq-ui-automation",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "automation,oracle,oracle cpq",
"author": "",
"author_email": "arunkumar.js25@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e4/d7/8656e5fdc689b6616be32a4413fec0f384c85c51614ca5f51b6bb0bbe330/py-oracle-cpq-ui-automation-1.0.2.tar.gz",
"platform": null,
"description": "# Oracle CPQ UI Automation\nSelenium based automation bot to do routine and time consuming tasks on Oracle CPQ Cloud application.\n\n## Pre-requisites\n* Chrome Browser should be installed\n* Supports Python >= 3.9\n* CPQ account should have admin access with proxy login option\n\n\n### Installation\n```\npip install py-oracle-cpq-ui-automation\n```\n### Usage\nJust type `import oracle_cpq_ui_automation` in the module you want to use Oracle CPQ UI Automation.\n\n### Example\n```\nimport oracle_cpq_ui_automation\n\n#Initialise the automation class with SiteName, username, password\nmain = oracle_cpq_ui_automation(\"<cpqInstanceName>\",\"<userName>\",\"<password>\") \n\n#It will autolaunch the Chromedriver browser\n\n#Login into the CPQ Site\nmain.login()\n```\n\n## Automation Functions\n### 1) Partner Orgs: Create Groups\nNavigate to Partner Orgs page and check if the given groups exists in the partner org, else it will create the group\n\n#### Inputs:\n1. groupsToCreate = [ [<groupName | string>, <groupVarName | string>, <addAllUsersToGroup | boolean> ] ] \n2. exceptionListOfCompanies = [<partnerOrg-VariableName>] \n3. noOfPagesToSkip = -1\n\n#### Code:\n```\nmain.createGroupsinPartnerOrg(\n [[\"<groupName>\",\"<groupVar\",True]], #groupsToCreate #2D Array of mixed datatype\n [], #exceptionListOfCompanies = [] #Array of strings\n -1 #noOfPagesToSkip = -1\n)\n```\n### 2) Extract and Save BML Libraries as Text files.\nNavigates to Util library page and save all the util libraries as text file \n\n#### Inputs:\n1. skipLibraries = 0 #Skip no.of.libraries to save\n\n#### Code:\n```\nmain.extractBmlLibrary(skipLibraries=0)\n```\n\n#### Output:\nThe output folder will be created and files will be saved locally in the below path\n```\nD:\\\n > <cpqInstanceName\n > BML Library\n > library1.txt\n library2.txt\n```\n\n### Bot Features\n* Automation Bot will automatically download the compatible chrome driver version based on your installed browser.\n* Automations are UI-based so users can monitor, if any unexpected behaviour occurs then can close the automation to avoid problems.\n\n### Authors & Contributors\n* Arun Kumar (arunkumar.js25@gmail.com)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Selenium based automation on Oracle CPQ UI",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/arunkumar-js25/oracle_cpq_ui_automation"
},
"split_keywords": [
"automation",
"oracle",
"oracle cpq"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da2d5d0afd3f5dad23561085886fef6c42b168798f380aaf05406db6be51f4e1",
"md5": "d61d9996e048c85ebfafc6c043633ed9",
"sha256": "968bac78e56362650e8ecdf3562af2bcf382a33bb6fafd90b0c2d98dcd270770"
},
"downloads": -1,
"filename": "py_oracle_cpq_ui_automation-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d61d9996e048c85ebfafc6c043633ed9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8494,
"upload_time": "2024-02-02T02:31:21",
"upload_time_iso_8601": "2024-02-02T02:31:21.691132Z",
"url": "https://files.pythonhosted.org/packages/da/2d/5d0afd3f5dad23561085886fef6c42b168798f380aaf05406db6be51f4e1/py_oracle_cpq_ui_automation-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e4d78656e5fdc689b6616be32a4413fec0f384c85c51614ca5f51b6bb0bbe330",
"md5": "967832610884d949401b678a646bd573",
"sha256": "4505a4b698523a5c3b6d3797048795f77eacc7f2ad2e210a56469c2662fe2647"
},
"downloads": -1,
"filename": "py-oracle-cpq-ui-automation-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "967832610884d949401b678a646bd573",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7551,
"upload_time": "2024-02-02T02:31:23",
"upload_time_iso_8601": "2024-02-02T02:31:23.242999Z",
"url": "https://files.pythonhosted.org/packages/e4/d7/8656e5fdc689b6616be32a4413fec0f384c85c51614ca5f51b6bb0bbe330/py-oracle-cpq-ui-automation-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 02:31:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arunkumar-js25",
"github_project": "oracle_cpq_ui_automation",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "selenium",
"specs": []
},
{
"name": "setuptools",
"specs": []
},
{
"name": "chromedriver-autoinstaller",
"specs": []
}
],
"lcname": "py-oracle-cpq-ui-automation"
}
JSON
