ka-uts-eviq 5.0.1.250630

Utilities for EcoVadis IQ Processing

ka_uts_eviq

Overview

Utilities for EcoVadis IQ Processing

Installation

The Python Package ka_uts_eviq can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install ka_uts_eviq

To install with conda:

$ conda install -c conda-forge ka_uts_eviq

Package

Classification

The Files of Package ka_uts_eviq could be classified into the follwing file types:

1. Special package files; c.f.: Appendix: Special package files

   1. py.typed

2. Special package modules; Appendix: Special package modules

   1. __init__.py

   2. __version__.py

3. Package modules

   1. utils.py

Package Module

Module: utils

Classes of Modul: utils

The Module utils.py contains the the follwing static classes.

utils.py classes*

Name	Description
Evup	Manage EcoVadis upload workbook
Evex	Manage EcoVadis export workbook
Evin	Manage EcoVadis inputworkbook (provided by external systems like OmniTracker)
EvinEvex	Check EcoVadis input workbook against EcoVadis export workbook
EvexEvin	Check EcoVadis Export workbook against EcoVadis input workbook

Class: Evup

The static Class Evup contains the subsequent methods.

Methods of Class: Evup

Evup methods*

Name	Description
sh_aod_evup_adm	Create and show the array of dictionaries for given dictionary of arrays of dictionaries and given operation by applying the union function to the array of dictionaries.

Class: Evex

The static Class Evex contains the subsequent methods.

Methods of Class: Evex

Evex methods*

Name	Description
sh_d_evex	Migrate an EcoVadis export dataframe to a dictionary.
sh_d_evup_del_from_dic	Migrate an EcoVadis export dictionary to a dictionary for the EcoVadis upload delete sheet.
sh_d_evup_del_from_df	Migrate an EcoVadis export dataframe row to a dictionary for the EcoVadis upload delete sheet.
map	Map the EcoVadis IQ sustainability risk rating in the array of EcoVadis disk dictionaries to the risk rating defined by UMH.

Class: Evin

The static Class Evin contains the subsequent methods.

Evin: Methods

Evin methods*

Name	Description
sh_d_evup_adm	Migrate an OmniTracker export dictionary to a EcoVadis upload dictionary.
sh_aod_evup_adm	Migrate an array of OmniTracker export dictionaries to an array of EcoVadis upload dictionaries.
verify_duns	Verify the field ‘DUNS-Nummer’ for all dictionaries of the given array of OmniTracker export dictionaries if the verification is requested.
verify_objectid	Verify the field ‘Eindeutige ID’ for all dictionaries of the given array of OmniTracker export dictionaries if the verification is requested.
verify_countrycode	Verify the field ‘Landesvorwahl’ for all dictionaries of the given array of OmniTracker export dictionaries if the verification is requested.
verify_town_in_country	Verify the field ‘Stadt’ together with the field ‘Landesvorwahl’ for all dictionaries of the given array of OmniTracker export dictionaries if the verification is requested.
verify_postalcode_in_country	Verify the field ‘Postleitzahl’ together with the field ‘Landesvorwahl’ for all dictionaries of the given array of OmniTracker export dictionaries if the verification is requested.
verify	Verify all fields of all dictionaries of the given array of OmniTracker export dictionaries if the verification is requested and return the verification status controlled by the verify ignore switches.
verify_aod_evin	Apply the verify function to all dictionaries of the array of Omnitracker export dictionaries.
sh_doaod_adm_new	Migrate array of Omnitracker export dictionaries to dictionary of array of EcoVadis upload dictionaries for Admin processing

Class: EvexEvin

The static Class EvexEvin contains the subsequent methods.

EvexEvin: Methods

EvexEvin methods*

Name	Description
join_del	Join the Array of EcoVadis export dictionaries with the dataframe of OmniTracker export records for delete processing.

Class: EvinEvex

The static Class EvinEvex contains the subsequent variables and methods.

EvinEvex: Variables

EvinEvex variables*

Name	Description
msg_evex	Message that could be displayed when processing the EcoVadis export.
msg_evin	Message that could be displayed when processing the OmniTracker export.

Methods of class: EvinEvex

EvinEvex methods*

Name	Description
query_with_keys	Query EcoVadis dataframe with multiple keys and country code until row is found and return row.
query	Query EcoVadis dataframe with OmniTracker export keys: ‘Eindeutige ID’ or ‘DUNS-Nummer’ or keys form array of keys until row is found.
join_adm	Join the Array of OmniTracke export dictionaries with the dataframe of EcoVadis export records for admin processing.
join_del	Join the Array of OmniTracke export dictionaries with the dataframe of EcoVadis export records for delete processing.
sh_d_evup_adm	Show change status and EcoVadis upload dictionary for OmniTracker export- and EcoVadis export-dictionary

Appendix

Package Logging

Description

The Standard or user specifig logging is carried out by the log.py module of the logging package ka_uts_log using the standard- or user-configuration files in the logging package configuration directory:

• <logging package directory>/cfg/ka_std_log.yml,

• <logging package directory>/cfg/ka_usr_log.yml.

The Logging configuration of the logging package could be overriden by yaml files with the same names in the application package- or application data-configuration directories:

• <application package directory>/cfg

• <application data directory>/cfg.

Log message types

Logging defines log file path names for the following log message types: .

1. debug

2. info

3. warning

4. error

5. critical

Log types and Log directories

Single or multiple Application log directories can be used for each message type:

Log types and directoriesg

Log type	Log directory
long	short	multiple	single
debug	dbqs	dbqs	logs
info	infs	infs	logs
warning	wrns	wrns	logs
error	errs	errs	logs
critical	crts	crts	logs

Application parameter for logging

Application parameter used in log naming

Name	Decription	Values	Example
dir_dat	Application data directory		/otev/data
tenant	Application tenant name		UMH
package	Application package name		otev_xls_srr
cmd	Application command		evupreg
pid	Process ID		681025
log_ts_type	Timestamp type used in logging files|ts, dt	ts, dt’	ts
log_sw_single_dir	Enable single log directory or multiple log directories	True, False	True

Log files naming

Naming Conventions

Naming conventions for logging file paths

Type	Directory	File
debug	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
info	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
warning	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
error	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
critical	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log

Naming Examples

Naming examples for logging file paths

Type	Directory	File
debug	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	debs_1737118199_9470.log
info	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	infs_1737118199_9470.log
warning	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	wrns_1737118199_9470.log
error	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	errs_1737118199_9470.log
critical	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	crts_1737118199_9470.log

Python Terminology

Python Packages

Overview

Python Packages Overview

Name	Definition
Python package	Python packages are directories that contains the special module __init__.py and other modules, packages files or directories.
Python sub-package	Python sub-packages are python packages which are contained in another pyhon package.
Python package sub-directory	directory contained in a python package.
Python package special sub-directory	Python package sub-directories with a special meaning like data or cfg

Examples

Python Package sub-directory-Examples

Name	Description
bin	Directory for package scripts.
cfg	Directory for package configuration files.
data	Directory for package data files.
service	Directory for systemd service scripts.

Python package files

Overview

Python package overview files

Name	Definition
Python package files	Files within a python package.
Special python package files	Package files which are not modules and used as python and used as python marker files like __init__.py.
Python package module	Files with suffix .py; they could be empty or contain python code; other modules can be imported into a module.
Special python package module	Modules like __init__.py or main.py with special names and functionality.

Examples

Python package examples files

Name	Type	Description
py.typed	Type checking marker file	The py.typed file is a marker file used in Python packages to indicate that the package supports type checking. This is a part of the PEP 561 standard, which provides a standardized way to package and distribute type information in Python.
__init__.py	Package directory marker file	The dunder (double underscore) module __init__.py is used to execute initialisation code or mark the directory it contains as a package. The Module enforces explicit imports and thus clear namespace use and call them with the dot notation.
__main__.py	entry point for the package	The dunder module __main__.py serves as an entry point for the package. The module is executed when the package is called by the interpreter with the command python -m <package name>.
__version__.py	Version file	The dunder module __version__.py consist of assignment statements used in Versioning.

Python methods

Overview

Python methods overview

Name	Description
Python method	Python functions defined in python modules.
Special python method	Python functions with special names and functionalities.
Python class	Classes defined in python modules.
Python class method	Python methods defined in python classes

Examples

Python methods examples

Name	Type	Description
__init__	class object constructor method	The special method __init__ is called when an instance (object) of a class is created; instance attributes can be defined and initalized in the method.

Table of Contents

Table of Content

• ka_uts_eviq

  • Overview

  • Installation

  • Package

  • Package Module

    • Classes of Modul: utils

    • Class: Evup

      • Methods of Class: Evup

    • Class: Evex

      • Methods of Class: Evex

    • Class: Evin

      • Evin: Methods

    • Class: EvexEvin

      • EvexEvin: Methods

    • Class: EvinEvex

      • EvinEvex: Variables

      • Methods of class: EvinEvex

• Appendix

  • Package Logging

    • Description

    • Log message types

      • Log types and Log directories

      • Application parameter for logging

      • Log files naming

        • Naming Conventions

        • Naming Examples

  • Python Terminology

    • Python Packages

      • Overview

      • Examples

    • Python package files

      • Overview

      • Examples

    • Python methods

      • Overview

      • Examples

• Table of Contents