Structure

The file structure is a semicolon separated csv file with “Windows-1252” encoding. The columns are predefined in their names and order. Even if not all attributes are used, they have to be present in the file at the correct position.

Schema

column name

data type

restrictions

column identifier

Identity type

[Name]

[Primary,Organizational,Admin,Sponsored,Shared,Service,Machine]

IdentityType

Employee type

[Name]

[Employee,Apprentice,Contractor,Consultant,Partner,Customer,Other]

EmployeeType

Personnel Number

[ID]

[max. 32 Character]

PersonnelNumber

Security identification

[Text]

[max. 32 Character]

SecurityIdent

Title

[Text]

[max. 64 Character]

Title

Form of address

[Mr,Ms]

Salutation

First name

[Text]

[max. 64 Character]

FirstName

Middle name

[Text]

[max. 64 Character]

MiddleName

Last name

[Text]

[max. 64 Character]

LastName

VIP

[1,0]


IsVIP

Last name prefix

[Text]

[max. 16 Character]

NameAddOn

Preferred name

[Text]

[max. 64 Character]

PreferredName

Name at birth

[Text]

[max. 64 Character]

FormerName

Initials

[Text]

[max. 10 Character]

Initials

Gender

[Name]

[unknown;male;female;unspecified]

Gender

Generational affix

[Text]

[max. 8 Character]

GenerationalQualifier

Date of birth

[DateTime]

[ISO Format]

BirthDate

Entry date

[DateTime]

[ISO Format]

EntryDate

User account creation date

[DateTime]

[ISO Format]

TechnicalEntryDate

Temporarily disabled from

[DateTime]

[ISO Format]

DeactivationStart

Temporarily disabled until

[DateTime]

[ISO Format]

DeactivationEnd

Leaving date

[DateTime]

[ISO Format]

ExitDate

Last working day

[DateTime]

[ISO Format]

DateLastWorked

Job description

[Text]

[max. 128 Character]

PersonalTitle

Reference to a Master Identity by Personnel Number

[ID]

[max. 32 Character]

Reference_MasterIdentityPersonnelNumber

Reference to a Manager by Personnel Number

[ID]

[max. 32 Character]

Reference_ManagerPersonnelNumber

Reference to a Department by ID

[ID]

[max. 32 Character]

Reference_DepartmentID

Reference to a Position by ID

[ID]

[max. 32 Character]

Reference_PositionID

Reference to a Profitcenter by AccountNumber

[ID]

[max. 32 Character]

Reference_ProfitcenterAccountNumber

Reference to a Location by ID

[ID]

[max. 64 Character]

Reference_LocationID

Reference to a Business Partner by ShortName

[ID]

[max. 32 Character]

Reference_BusinessPartnerShortName

Refrence to a Country by 3 digit Iso3166

[???]

[max. 3 Character]

Reference_CountryIso3166_3

Reference to a State by national Name 

[Text]

[max. 64 Character]

Reference_NationalStateName

Reference to a Culture by Ident 

[Text]

[max. 16 Character]

Reference_CultureIdent

Sub Organization

[Text]

[max. 32 Character]

SubCompany

Company member

[Text]

[max. 64 Character]

CompanyMember

Email address to contact

[Text]

[max. 256 Character]

ContactEmail

Sponsor

[Text]

[max.2GB]

Sponsor

Office mailbox

[Text]

[max.2GB]

PostalOfficeBox

Building

[Text]

[max. 64 Character]

Building

Floor

[Text]

[max.2GB]

Floor

Room

[Text]

[max.2GB]

Room

Street

[Text]

[max.2GB]

Street

City

[Text]

[max.2GB]

City

Zip code

[Text]

[max. 40 Character]

ZIPCode

Phone

[Text]

[max.2GB]

Phone

Phone extension

[Number]

[max. 20 Digits]

PhoneExtension

Fax

[Text]

[max.2GB]

Fax

Fax extension

[Number]

[max. 20 Digits]

FaxExtension

Mobile phone

[Text]

[max.2GB]

PhoneMobile

Display in phone book

[Yes,No]


DisplayTelephoneBook

External Identity

[1, 0]


IsExternal

Inactive state

[1, 0]


IsInActive

Notebook User

[1, 0]


IsNoteBookUser

Security risk

[1, 0]


IsSecurityIncident

Description

[Text]

[max. 2GB]

Description

Remarks

[Text]

[max. 2GB]

Remarks

Spare field

[Text]

[max. 64 Character]

CustomProperty01

Spare field

[Text]

[max. 64 Character]

CustomProperty02

Spare field

[Text]

[max. 64 Character]

CustomProperty03

Spare field

[Text]

[max. 64 Character]

CustomProperty04

Spare field

[Text]

[max. 64 Character]

CustomProperty05

Spare field

[Text]

[max. 64 Character]

CustomProperty06

Spare field

[Text]

[max. 64 Character]

CustomProperty07

Spare field

[Text]

[max. 64 Character]

CustomProperty08

Spare field

[Text]

[max. 64 Character]

CustomProperty09

Spare field

[Text]

[max. 64 Character]

CustomProperty10

Employee Photo

[Binary]

[max. 2GB]

JPegPhoto


Special Properties


column name

speciality

Personnel Number

mandatory, unique

First name

mandatory

Last name

mandatory

Inactive state

  • 0 means active

  • 1 means inactive

Identity type

limited list of values which symbolize the type of an identity

Primary identity

Employee's default identity. The employee has a default user account.

Organizational identity

Virtual employee (subidentity) for mapping different roles to an employee in the organization. The sub-identity has a user account of the type Organizational identity.

Personalized admin identity

Virtual person (sub-identity) that belongs to a user account of the type Personalized administrator identity.

Sponsored identity

Dummy employee who is linked to a user account of the type Sponsored identity.

Shared identity

Dummy employee who is linked to an administrative user account of the type Shared identity.

Service identity

Dummy employee who is linked to a user account of the type Service identity.

Employee type

limited list of values which symbolize the employee type of a primary identity

Reference to a Master Identity by Personnel Number

mandatory in case of an organizational, admin, service identity

Reference to a Manager by Personnel Number

mandatory in case of an sponsored, shared identity

Employee Photo

it needs to be a Base64 Encoded String and this can be done via the following powershell example


$filecontent = Get-Content -Path $FileNameOfPicture -Encoding Byte
$filecontentbase64 = [Convert]::ToBase64String($filecontent)
POWERSHELL


References

column namedescription
Reference to a Department by ID

reference to an organizational unit within the file with organization information

Department Information

the referenced attribute is the department id

Reference to a Location by ID

reference to a location within the file with location information 

Location Information

the referenced attribute is the location id

Reference to a State by national Name 

reference to a state

the referenced attribute is the national name, like Sachsen, Nordrhein-Westphalen, Vaude, Steiermark

Reference to a Manager by Personnel Number

reference to an identity within the same file

the referenced attribute is the personnel number

Reference to a Profitcenter by AccountNumber

reference to a cost center within the file with cost center information

Cost Center Information

the referenced attribute is the account number

Reference to a Master Identity by Personnel Number

reference to an identity within the same file

the referenced attribute is the personnel number

Reference to a Position by ID

reference to a position within the file with position information

Position Information

the referenced attribute is the position id

Reference to a Business Partner by ShortName

reference to a business partner which can be imported via powershell or ReST Client

the referenced attribute is the shortname

Reference to a Culture by Ident 

reference to a culture

the referenced attribute is the ident, like “de-DE”, “en-US”, a.s.o.

Refrence to a Country by 3 digit Iso3166

reference to a country

the referenced attribute is the 3 digit Iso3166 country abbreviation (List of ISO 3166 country codes - Wikipedia), like DEU, AUT, CHE


Use Cases




source-data-example-identities-simple.csv



source-data-example-identities-with-sub.csv