Skip to main content

Python Client for the UltiPro SOAP API

Project description

ultipro-soap-python

A Python 3 library and command line tool for the UltiPro Soap API. At present, all functions are read-only against UltiPro.

Installation:

pip install ultipro

Web Service User and Credentials:

  1. Ensure you have credentials for the UltiPro API endpoints you need to access. If you are pulling BI Reports, your Web Service User must have the Reports-as-a-service endpoint enabled with read access. Please see your UltiPro administrator if you do not have a web service user.

  2. Set up your credentials file. The default location is:

~/Library/Application Support/ultipro-soap-python/config.ini

You can find a sample config file in the root of this project's github repository, config.ini.sample.

To use this tool on the command line, install with pip, then:

$ ultipro --help

Pulling BI Reports:

You will need to log in to UltiPro and find the path for your desired report. It should look something like:

/content/folder[@name='_UltiPro Delivered Reports']/folder[@name='Human Resources Reports']/report[@name='Employee Birthdays']

You can find more information on page 7 of the WebServiceAPIGuide_BIService.doc

To execute, retrieve, and save a report to disk, use the following syntax:

$ ultipro report "/content/folder[@name='_UltiPro Delivered Reports']/"

If you'd like to use non-default locations for your config.ini file or output file, you can use the following syntax:

ultipro -f ~/some/other/path/to/config.ini -o ~/Desktop/fooreport.csv report "/content/folder[@name='_UltiPro Delivered Reports']/folder[@name='Human Resources Reports']/report[@name='Employee Birthdays']"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ultipro-0.0.3.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

ultipro-0.0.3-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file ultipro-0.0.3.tar.gz.

File metadata

  • Download URL: ultipro-0.0.3.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.42.1 CPython/3.6.9

File hashes

Hashes for ultipro-0.0.3.tar.gz
Algorithm Hash digest
SHA256 1de84755a428307c60aaffd14e39b7cc1d19a2447157184cbbaa05b1a3e74560
MD5 4364bc927d2a3679c8b3a119a5d3d2c7
BLAKE2b-256 c96593ff72a409f6d1a1647fe8483c17418500f6bd7849a3c9ea6476dc0b483d

See more details on using hashes here.

File details

Details for the file ultipro-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: ultipro-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.42.1 CPython/3.6.9

File hashes

Hashes for ultipro-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 97289939e61e1c7d5a35041f2eb7650dcabd366c2e4a2a2787cd5e84067d4719
MD5 570fd215f32c150c2724612e90727575
BLAKE2b-256 0d6b541b643c6a1c4325cb0ddefd062dbaf3bc8e5483ebc8134266039c19a3cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page