@petarmihaylov/node-raas/oclif.manifest.json

A tiny library and CLI for interacting with the Reports as a Service - RAAS - API from UKG - Ultimate Kronos Group. This project is maintained by the team behind RaasTastic and the community. It provides a balanced set of features that should suit a broad

{"version":"0.0.20","commands":{"console":{"id":"console","description":"Quickly test reports and access with this interactive console pulling data from a BI report through Reports as a Service (RAAS).","strict":true,"pluginName":"@petarmihaylov/node-raas","pluginAlias":"@petarmihaylov/node-raas","pluginType":"core","aliases":[],"examples":["$ node-raas console","$ node-raas console -e rental4.ultipro.com"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"username":{"name":"username","type":"option","char":"u","description":"Username of user or service account. Employee user is required for pulling UKG Time Management data.","multiple":false},"password":{"name":"password","type":"option","char":"p","description":"Password for the provided username.","multiple":false},"customerApiKey":{"name":"customerApiKey","type":"option","char":"c","description":"A 5-character alpha-numeric key from UKG Pro > MENU > SYSTEM CONFIGURATION > Security > Service Account Administration.","multiple":false},"userApiKey":{"name":"userApiKey","type":"option","char":"a","description":"A 12-character alpha-numeric key for the provided username from UKG Pro > MENU > SYSTEM CONFIGURATION > Security > Service Account Administration.","multiple":false},"baseEndpointUrl":{"name":"baseEndpointUrl","type":"option","char":"e","description":"Base endpoint URL from UKG Pro > MENU > SYSTEM CONFIGURATION > Security > Web Services. Do not include the protocol (https://).","multiple":false,"options":["servicet.ultipro.com","service2.ultipro.com","service3.ultipro.ca","service4.ultipro.com","service5.ultipro.com","rental2.ultipro.com","rental3.ultipro.ca","rental4.ultipro.com","rental5.ultipro.com"]},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Output raw request/response combination for failing requests.","allowNo":false},"console":{"name":"console","type":"boolean","allowNo":false}},"args":[],"_globalFlags":{}},"pull":{"id":"pull","description":"Pull data from a BI report through Reports as a Service (RAAS).","strict":true,"pluginName":"@petarmihaylov/node-raas","pluginAlias":"@petarmihaylov/node-raas","pluginType":"core","aliases":[],"examples":["$ node-raas pull \"i22500177CDE54018AC31713BEBE2F644\" -u ServiceAccount -p \"u(3Unv0ERjlaksdjf*jfa89wfjklj23j!@3j423j#OI@^j2342\" -c B5JLX -a BB7VDK0000K0 -e rental4.ultipro.com","$ node-raas pull \"/content/folder[@name='zzzCompany Folders']/folder[@name='Eastwood Industries - Master SC(72)']/folder[@name='UltiPro']/folder[@name='Customs']/report[@name='Audit Report 2']\" -u ServiceAccount -p \"u(3Unv0ERjlaksdjf*jfa89wfjklj23j!@3j423j#OI@^j2342\" -c B5JLX -a BB7VDK0000K0 -e rental4.ultipro.com"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"username":{"name":"username","type":"option","char":"u","description":"Username of user or service account. Employee User is required for pulling UKG Time Management data.","required":true,"multiple":false},"password":{"name":"password","type":"option","char":"p","description":"Password for the provided username. Be sure to escape any special characters for your command line. (Ex: ! should be \\! in bash shells.)","required":true,"multiple":false},"customerApiKey":{"name":"customerApiKey","type":"option","char":"c","description":"A 5-character alpha-numeric key from UKG Pro > MENU > SYSTEM CONFIGURATION > Security > Service Account Administration or Web Services.","required":true,"multiple":false},"userApiKey":{"name":"userApiKey","type":"option","char":"a","description":"A 12-character alpha-numeric key for the provided username from UKG Pro > MENU > SYSTEM CONFIGURATION > Security > Service Account Administration. If using an Employee User use the User API Key from UKG Pro > MENU > SYSTEM CONFIGURATION > Security > Web Services.","required":true,"multiple":false},"baseEndpointUrl":{"name":"baseEndpointUrl","type":"option","char":"e","description":"Base endpoint URL from UKG Pro > MENU > SYSTEM CONFIGURATION > Security > Web Services. Do not include the protocol (https://).","required":true,"multiple":false,"options":["servicet.ultipro.com","service2.ultipro.com","service3.ultipro.ca","service4.ultipro.com","service5.ultipro.com","rental2.ultipro.com","rental3.ultipro.ca","rental4.ultipro.com","rental5.ultipro.com"]},"printCreds":{"name":"printCreds","type":"boolean","char":"l","description":"Print the credentials. Useful when ensuring flag input is processed correctly. As a best practice, credentials should be surrounded in double-quotes and any special characters for your conssole escaped. (Ex: ! should be \\! in bash.)","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Output raw request/response combination for failing requests.","allowNo":false}},"args":[{"name":"reportPathOrId","description":"Report path or ID from Cognos (BI). Obtained by inspecting Properties of a BI report. (Right-click > Properties > General > Advanced > [Search path | ID].)","required":true}],"_globalFlags":{}},"ubirr":{"id":"ubirr","description":"Displays information about Ubirr - a production-ready, feature-rich set of tools built on top of node-raas.","strict":true,"pluginName":"@petarmihaylov/node-raas","pluginAlias":"@petarmihaylov/node-raas","pluginType":"core","aliases":[],"flags":{},"args":[]}}}