{"id":23651864,"url":"https://github.com/microfocus/alm-octane-document-report-downloader","last_synced_at":"2025-11-16T19:30:15.574Z","repository":{"id":56856172,"uuid":"525708983","full_name":"MicroFocus/alm-octane-document-report-downloader","owner":"MicroFocus","description":"A node app utility that allows generating and downloading of an ALM Octane document report based on a given template.","archived":false,"fork":false,"pushed_at":"2022-08-18T08:44:17.000Z","size":47,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-01-30T07:04:53.829Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MicroFocus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-17T08:46:47.000Z","updated_at":"2022-08-29T10:00:41.000Z","dependencies_parsed_at":"2022-08-19T09:21:19.838Z","dependency_job_id":null,"html_url":"https://github.com/MicroFocus/alm-octane-document-report-downloader","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Falm-octane-document-report-downloader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Falm-octane-document-report-downloader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Falm-octane-document-report-downloader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Falm-octane-document-report-downloader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MicroFocus","download_url":"https://codeload.github.com/MicroFocus/alm-octane-document-report-downloader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239611992,"owners_count":19668274,"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":[],"created_at":"2024-12-28T16:48:41.368Z","updated_at":"2025-11-16T19:30:15.531Z","avatar_url":"https://github.com/MicroFocus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# alm-octane-document-report-downloader\n\n## How to install\n\n### Install locally\n\n#### By cloning the project\n\n- Download the project locally\n- Navigate inside the project\n- run `npm i -g`\n- You can now run `npx alm-octane-document-report-downloader` command from anywhere using a terminal\n\n#### By directly installing the command globally\n\n- run `npm i -g @microfocus/alm-octane-document-report-downloader`\n- You can now run `npx alm-octane-document-report-downloader` command from anywhere using a terminal\n\n### Run directly from the npm registry\n\n- Directly run `npx @microfocus/alm-octane-document-report-downloader` command so that npm automatically downloads and runs the tool\n\n## How to use\n\nThe tool can be run using two types of configuration:\n- Command line argument configuration\n- Environment file configuration (.env file)\n\n### Running using command line arguments\n\n#### Command to execute: `npx @microfocus/alm-octane-document-report-downloader useArgs`\n\n#### Required command line arguments:\n* `--octaneUrl` - ALM Octane URL\n\n\n* `--sharedSpace` - ALM Octane shared space ID\n\n\n* `--workspace` - ALM Octane workspace ID\n\n\n* `--clientId` - ALM Octane Client ID\n\n\n* `--clientSecret` - ALM Octane Client Secret\n\n\n* `--templateName` - Name of the saved report document template in ALM Octane\n\n\n* `--saveLocation` - Path of the destination directory for the downloaded report\n\n#### Example:\n``` shell\nnpx @microfocus/alm-octane-document-report-downloader useArgs --octaneUrl=\"http://localhost:8080\" --sharedSpace=1001 --workspace=1002 --clientId=\"MyClientId\" --clientSecret=\"MyClientSecret\" --templateName=\"MyCustomTemplate\" --saveLocation=\"reports\"\n```\nA report will be generated using the `MyCustomTemplate` template and it will be downloaded inside the `reports/` directory.\nIf the directory does not exist then it will be automatically created.\n\n### Running using an environment file\n\n#### Command to execute: `npx @microfocus/alm-octane-document-report-downloader useEnvFile`\n\nCreate a file with the `.env` extension (you can also name it just .env).\nThe file should contain the following properties:\n\n```\nOCTANE_URL=\nOCTANE_SHARED_SPACE=\nOCTANE_WORKSPACE=\nOCTANE_CLIENT_ID=\nOCTANE_CLIENT_SECRET=\nDOCUMENT_REPORT_TEMPLATE_NAME=\nDOCUMENT_REPORT_SAVE_LOCATION=\n```\n\n#### Required command line arguments:\n\n* `--path` - The relative path to the `.env` config file\n\n#### Example:\n\nCreated a subdirectory in the current directory named `config` and inside it a file named `.env` with the following structure:\n\n#### config/.env\n```\nOCTANE_URL=\"http://localhost:8080\"\nOCTANE_SHARED_SPACE=1001\nOCTANE_WORKSPACE=1002\nOCTANE_CLIENT_ID=\"MyClientId\"\nOCTANE_CLIENT_SECRET=\"MyClientSecret\"\nDOCUMENT_REPORT_TEMPLATE_NAME=\"MyCustomTemplate\"\nDOCUMENT_REPORT_SAVE_LOCATION=\"reports\"\n```\n\nRun the command:\n```shell\nnpx @microfocus/alm-octane-document-report-downloader useEnvFile --path=\"config/.env\"\n```\nA report will be generated using the `MyCustomTemplate` template and it will be downloaded inside the `reports/` directory.\nIf the directory does not exist then it will be automatically created.\n\n## Limitations\n\n* The tool requires that the Report Document Template name is unique inside ALM Octane\n* Widgets are supported in document reports starting with ALM Octane version 16.0.400\n* Octane might timeout for reports containing more than 4 widgets (ALM Octane Limitation)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrofocus%2Falm-octane-document-report-downloader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrofocus%2Falm-octane-document-report-downloader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrofocus%2Falm-octane-document-report-downloader/lists"}