Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tools4everbv/helloid-conn-prov-source-sap

SAP - Source
https://github.com/tools4everbv/helloid-conn-prov-source-sap

erp hrm on-premises provisioning source

Last synced: 16 days ago
JSON representation

SAP - Source

Awesome Lists containing this project

README 

        
# HelloID-Conn-Prov-Source-SAP



| :information_source: Information |

|:---------------------------|

| This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements.       |








  




## Table of contents



 - [Introduction](#Introduction)

 - [Work In Progress](#Work-In-Progress)

 - [Prerequisites](#Prerequisites)

 - [Connection Settings](#Connection-Settings)

 - [BAPI Function Calls](#BAPI-function-calls)

 - [Setup the connector](#Setup-the-connector)



## Introduction



The *HelloID-Conn-Prov-Source-SAP connector* requires the **SAP Connector for Microsoft .NET**. This also implies that the connector needs to be **executed on-premises**. Make sure you have **Windows PowerShell 5.1** installed on the server where the **HelloID agent and provisioning** agent are running, and that the *Execute on-premises* switch is toggled on the connector system tab within HelloID.



## Work in progress



Out of the box, The *HelloID-Conn-Prov-Source-SAP connector* is not ready for implementation. The provided *persons.ps1* is merely an example on how to extract data from SAP and import that data into HelloID. Therefore, changes will have to be made to the source code according to your implementation of SAP. 



## Prerequisites



- [ ] SAP Connector for Microsoft .NET



  The SAP Connector files can be downloaded from: https://support.sap.com/en/product/connectors/msnet.html



- [ ] Windows PowerShell 5.1



  Windows PowerShell 5.1 must be installed on the server where the 'HelloID agent and provisioning agent' are running.



  > The connector is not tested on older versions of Windows PowerShell.



- [ ] BAPI Function calls



  Function calls must be created within SAP in order to retrieve data.

  

## Connection Settings



In order to connect to SAP, the following information is required:



| Connection setting | Description                                                  |

| ------------------ | ------------------------------------------------------------ |

| HostName           | The HostName of the SAP server where the SAP system is installed |

| SysId              | The ID of the SAP system                                     |

| SysNr              | The Number of the SAP system                                     |

| Client             | The Client of the SAP system                                 |

| UserName           | The UserName to connect the SAP system                       |

| Password           | The Password to connect the SAP system                       |

| FunctionCall       | The name of the functionCall. This is specified within SAP. The function call must be configured to retrieve the requested data from SAP |

| TableName          | The name of the table in which the data is stored       |



## BAPI function calls



Data from SAP is retrieved by using the BAPI interface. (Business Application Programming Interface). The BAPI interface exposes _function calls_. These _function calls_ will have to be created by the customer or a SAP consultant. The _function calls_ will return a predefined set of data (tables) containing the data that is necessary for HelloID. At minimum, the following data is required:



| Person                                                       |

| ------------------------------------------------------------ |

| Initials
Nickname
Given_name
Family_name_prefix
Family_name
Family_name_partner_prefix
Family_name_partner
Family_name_formatted
Name_separator
Convention
Birthdate
Phone |



| Contract                                                     |

| ------------------------------------------------------------ |

| Type
Sequence
Fraction
Fte
Hours_per_week2
Business
Organizational_unit
Manager
Profession
Start
End |



> The name of the function call and table are required for the connector.



For more information on the BAPI interface: https://help.sap.com/viewer/df959412681b4619a38f03ff90207e6b/4.2.12/en-US/577b7d566d6d1014b3fc9283b0e91070.html



## Setup the connector



1. Download the SAP Connector for Microsoft .NET from: https://support.sap.com/en/product/connectors/msnet.html Make sure to donwload the connector that is compiled with .NET Framework 4.0.



2. Extract the contents of zip file and copy them to a sensible location. The HelloID connector requires the following *.dll files: 



   - sapnco_utils.dll



   - sapnco.dll



3. Create the required BAPI function calls within SAP.



4. Download all the files in the *HelloID-Conn-Prov-Source-SAP* connector repository on Github.



5. Make changes to the *.PS1 file(s) according to your SAP implementation. You can use the *persons.ps1* as an example. Another example on how to retrieve the tablesNames from SAP can found within the *<./resources/Get-SAPTables.ps1>* file.



6. Add a new 'Source System' to HelloID and make sure to import all the necessary files.

 

# HelloID Docs

The official HelloID documentation can be found at: https://docs.helloid.com/