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-target-daywize-updateuser

Daywize - Target (Update user)
https://github.com/tools4everbv/helloid-conn-prov-target-daywize-updateuser

hrm provisioning target

Last synced: about 1 month ago
JSON representation

Daywize - Target (Update user)

Host: GitHub
URL: https://github.com/tools4everbv/helloid-conn-prov-target-daywize-updateuser
Owner: Tools4everBV
Created: 2024-03-04T15:23:13.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-03-15T12:53:33.000Z (9 months ago)
Last Synced: 2024-03-15T14:05:51.274Z (9 months ago)
Topics: hrm, provisioning, target
Language: PowerShell
Homepage:
Size: 257 KB
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# HelloID-Conn-Prov-Target-Daywize-Updateuser

> [!IMPORTANT]

> 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

- [HelloID-Conn-Prov-Target-Daywize-Updateuser](#helloid-conn-prov-target-Daywize-Updateuser)

  - [Table of contents](#table-of-contents)

  - [Introduction](#introduction)

  - [Getting started](#getting-started)

    - [Provisioning PowerShell V2 connector](#provisioning-powershell-v2-connector)

      - [Correlation configuration](#correlation-configuration)

      - [Field mapping](#field-mapping)

    - [Connection settings](#connection-settings)

    - [Prerequisites](#prerequisites)

    - [Remarks](#remarks)

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

  - [Getting help](#getting-help)

  - [HelloID docs](#helloid-docs)

## Introduction

_HelloID-Conn-Prov-Target-Daywize-Updateuser_ is a _target_ connector. _Daywize-Updateuser_ utilizes a set of REST API's that allow you to programmatically interact with its data.

This particular connector is _not_ a general connector for DayWize. It implementes only the specific functionality of  _updating_ Contact properties of existing Daywize accounts.

It performs no correlation . The unique user identifier (DaywizeAccountName) MUST be provided by HelloID as an input value for this connector.

 The HelloID connector uses the API endpoints listed in the table below.

| Endpoint | Description |

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

| /employeeContact_update      |  updates conntact information for a existing account|

| /        |             |

The following lifecycle actions are available:

| Action                 | Description                                      |

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

| create.ps1             | Does NOT create an account in Daywize. Only generates an account reference required for HelloId |

| delete.ps1             | Not available                                    |

| disable.ps1            | Not available                                    |

| enable.ps1             | Not available                                    |

| update.ps1             | PowerShell _update_ action                       |

| configuration.json     | Configuration settings template                  |

| fieldMapping.json      | _fieldMapping.json_                              |

## Getting started

### Provisioning PowerShell V2 connector

#### Correlation configuration

This connector does _not_ use the correlation settings in helloId. It expects to get an unique DayWizeAccountName value as input from a mapped field (for the create lifecycle action)

#### Field mapping

An  default field mapping can be imported by using the _fieldMapping.json_ file.

Note, The input source for the field mapping

|FieldName| Description |

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

|_DaywizeAccountName_ |  The unique name of the daywize account to update  (create) |

|_EmailAddress_   |  The new value emailaddress to update  (update, store in countdata) |

|_SSOLoginName_   |  The new value of the SSOLoginName to update (update, store in accountdata) |

|_SystemName_  | The name of the HelloId target system. Required for lookup purposes (create, update store in accountdata)|

### Connection settings

The following settings are required to connect to the API.

| Setting  | Description                        | Mandatory |

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

| UserName | The UserName to connect to the API | Yes       |

| Password | The Password to connect to the API | Yes       |

| BaseUrl  | The URL to the API                 | Yes       |

### Prerequisites

The unique _DaywizeAccountName_ must be available on the HelloId Person

### Remarks

This connector updates only the EmailAddress and the SSOLoginName properties of the user.

The mapped field  _SystemName_ is an arbitrairy unique value required to be able to retrieve(lookup) the stored accountdata info in helloid, needed for the compare function in the update.  A good value for this field would be displayname of the created target system in HelloID.

>

## Getting help

> [!TIP]

> _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/en/provisioning/target-systems/powershell-v2-target-systems.html) pages_.

> [!TIP]

>  _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_.

> ore more specifically, https://forum.helloid.com/forum/helloid-connectors/provisioning/5048-helloid-conn-prov-target-daywize-updateuser

## HelloID docs

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