Werkstatt Tools

Basic Python modules for Werkstatt projects

Core functions for integrating with solutions using Python

• Basic transform and core functions
• Encryption of credential
• External configuration in custom json file

Core Library and purpose

• w3rkstatt base python functions for project support
• w3rkstatt encrypt the cleartext passwords

Dependencies

• Basic Libraries
• Cryptodome

Install dependencies, see Setup documentation for more details.

Linux
python3 -m pip install wheel requests urllib3 pyCryptodome pandas json2html jsonpath-ng jsonpath_rw_ext --user
python3 -m pip install git+https://github.com/dcompane/controlm_py.git --user

Windows
python -m pip install wheel requests urllib3 pyCryptodome pandas json2html jsonpath-ng jsonpath_rw_ext
python -m pip install git+https://github.com/dcompane/controlm_py.git

Solutions leveraging the base tools

Solution	API	Python
Werkstatt Tools	⬜	✅
BMC Control-M	🔶	✅
BMC Helix ITSM	🔶	✅
BMC TrueSight	🔶	✅
ServiceNOW	🔶	🚧
E-Mail	🔶	✅
Shell Scripts	⬜	⬜

• ✅ — Supported
• 🔶 — Partial support
• 🚧 — Under development
• ⬜ - N/A ️

ToDO:

• Initial Core Development
• update CamelCase / snake_case
• automate this process

Info:

• Log files are being written to [home]/werkstatt/logs
• Werkstatt main log file is [home]/werkstatt/logs/integrations.log
• Configuration files are in [home]/werkstatt/configs
• Example files are in [project]/samples

Documentation of Modules

SMTP:

Module	Method	Description
core_smtp	prepareEmail	Prepare HTML content, based on template
core_smtp	sendEmailSmtpSSL	Send E-mail with SSL enabled

Helix ITSM Application:

Module	Method	Description
core_itsm	createChange	Create ITSM Change Request
core_itsm	getChange	Get ITSM Change Request status
core_itsm	extractChangeState	Translate ITSM Change Request details
core_itsm	createIncident	Create ITSM Incident
core_itsm	getIncident	Get ITSM Incident details
core_itsm	getIncidentStatus	Get ITSM Incident status

Helix ITSM Core:

Module	Method	Description
core_itsm	authenticate	Login to Helix ITSM
core_itsm	logout	Logout of Helix ITSM
core_itsm	itsmFormGet	HTTP Get from Helix ITSM Form
core_itsm	itsmFormPost	HTTP Post to Helix ITSM Form

TrueSight Operations Manager Application:

Module	Method	Description
core_tsim	getEventID	Extract TSIM Event mc_ueid
core_tsim	createCI	Create TSIM CI
core_tsim	searchCI	Search for TSIM CI
core_tsim	searchCIAdvanced	Search for TSIM CI Advanced

TrueSight Operations Manager Core:

Module	Method	Description
core_tsim	authenticate	Login to TrueSight Presentation Server
core_tsim	createEvent	Create TSIM Event
core_tsim	updateEvent	Update TSIM Event
core_tsim	searchEvent	Search for TSIM Event

TrueSight Orchestrator Application:

Module	Method	Description
core_tso	getTsoModules	Get TrueSight Orchestrator Modules
core_tso	getTsoAdapters	Get TrueSight Orchestrator Adapters
core_tso	executeTsoProcess	Execute TrueSight Orchestrator

TrueSight Orchestrator Core:

Module	Method	Description
core_tso	authenticate	Login to TrueSight Orchestrator
core_tso	logout	Logout of TrueSight Orchestrator
core_tso	apiGet	HTTP Get from TrueSight Orchestrator
core_tso	apiPost	HTTP Post to TrueSight Orchestrator

Shell Scripts:

Solution	Script	Description
ctm	remove_ctm_env.sh	Remove Control-M environments matching a pattern for ctm aapi

Python Scripts:

Solution	Script	Description
ctm	disco_ctm.py	Create inventory of Control-M environment and resources