Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field #

Field

Type

Description

Required

Comments

1

FirstName

String

First Name

Yes

Min Length: 2

Max Length: 50

2

LastName

String

Last Name

Yes

Min Length: 2

Max Length: 50

3

FullName

String

Full Name

Optional

Min Length: 2

Max Length: 200

4

Address

String

Address Line 1

Yes

Min Length: 2

Max Length: 150

5

Address2

String

Address Line 2

Optional

Min Length: 2

Max Length: 150

6

City

String

City

Yes

Min Length: 2

Max Length: 20

7

State

String

State

Yes

The state's two letter abbreviation (i.e., AZ)

8

PostalCode

String

Postal Code

Yes

Length = 5 numerals

9

CountryCode

String

3 Letter Country Code

Yes

Should be USA

10

Phone

String

Phone Number     

Yes

10-digit phone number; exclude dashes and parentheses

11

AltPhone

String

Alternate Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

12

MobilePhone

String

Mobile Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

13

Email

String

Email Address

Yes

Email format: test@dcisoftware.com

14

TimeZone

String

Time Zone

Yes

Use the correct Time Zone from the “Import Profile Static Data File” in the Help Center

15

CostCenterId

Integer

Unique Identifier for the Cost Center

Yes

Must use existing Id in DCI

16

DOB

Date

Date of Birth

Yes

MM/DD/YYYY

17

Username

String

Username for login

*Activation email is not automatically sent to employee after import

Yes

Min Length: 6 characters

Max Length: 50 characters

18

Password

String

Password for login

*Requires employee to change password on first log in after import

Yes

Min Length: 10 characters

Max Length: 32 characters

Must be at least 10 characters, Must contain 1 uppercase letter, lowercase letters, numbers and special characters 

19

ProfileReference

String

Third-party reference number for the Profile

Optional

Min Length: 1

Max Length: 200

20

EmployeeType

Integer

Employee Type

Yes

See “Import Profile Static Data File”

21

EmployeeNumber

String

Third-party Employee Number

Yes

Min Length: 2

Max Length: 20

22

SSN

String

Social Security Number

*Must be cleartext (not encrypted)  

Conditional
 


The field will be Optional when Retain SSN is set to No in instance level setting.


If Retain SSN is set to Yes then SSN becomes mandatory.

Min and Max Length: 9 (Numerals)


SSN will be conditionally optional when Employee Type is Contractor (5)

23

ProfessionalID1

String

Third-party Professional Identifier 1  

Optional

Min Length: 2

Max Length: 20

24

ProfessionalID2

String

Third-party Professional Identifier 2

Optional

Min Length: 2

Max Length: 20

25

PayrollId

String

Third-party Payroll Identifier

Optional

Min Length: 2

Max Length: 20

26

WeeklyHours

Decimal

Weekly Hours available to Work

Yes

Min Length: 2

Max Length: 20

27

HolidayScheduleId

Integer

Holiday Schedule Identifier

Yes

Unique existing Id for a particular Holiday Schedule

28

TemplateId

Integer

Certification Template Id

Optional

Must use existing Id in DCI

29

DomesticWorker

Boolean

Domestic Worker

Yes

0 - No

1 - Yes

30

OneDayRestIn7Exemption

Boolean

OneDayRestIn7Exemption

Conditional -Required if DomesticWorker = Yes

0 - No

1 - Yes

31

PreferredDayOfRest

Integer

Preferred Day Of Rest

Conditional -

Required if OneDayRestIn7Exemption = 1

Day          Integer

Sunday        0

Monday       1

Tuesday       2

Wednesday  3

Thursday      4

Friday          5

Saturday     6

32

RetainSSN

Bit

Checks whether the SSN needs to be stored in Encrypted SSN or not.

Yes

Must be 0 or 1 value

Value:

●       0 - No

●       1 - Yes

33

HireDate

DateTime

Hire Date of Employee

No

Should be in format “MM/DD/YYYY”

34

Pin

nvarchar

Login Pin of the Employee

Yes

Min Length: 4

Max Length: 4

35

ProfileStatus

Integer

Status of the Employee

*Imported employee profile status is set to Active

Yes

Must be a valid Status:

●       1 - Active

●       2 - Inactive

36

PreferredLanguage

nVarchar

Preferred language for an Employee

Yes

Must be a valid value:

●       en - English

●       es - Spanish

●       vi - Vietnamese

●       zh - Mandarin

●       ru - Russian

●       so - Somali

●       ar - Arabic

Client

Field #

Field

Type

Description

Required

Comments

1

FirstName

String

First Name

Yes

Min Length: 1

Max Length: 50

2

LastName

String

Last Name

Yes

Min Length: 1

Max Length: 50

3

FullName

String

Full Name

Optional

Min Length: 2

Max Length: 200

4

Address

String

Address Line 1

Yes

Min Length: 2

Max Length: 150

5

Address2

String

Address Line 2

Optional

Min Length: 2

Max Length: 150

6

City

String

City

Yes

Min Length: 2

Max Length: 20

7

State

String

State

Yes

The state's two letter abbreviation (i.e., AZ)

8

PostalCode

String

Postal Code

Yes

Length = 5 numerals

9

CountryCode

String

3 Letter Country Code

Yes

Should be USA

10

Phone

String

Phone Number

Yes

10-digit phone number; exclude dashes and parentheses

11

AltPhone

String

Alternate Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

12

MobilePhone

String

Cell Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

13

Email

String

Email Address

Yes

Email format: test@dcisoftware.com

14

TimeZone

String

Time Zone

Yes

See “Admin Guide: Static Data Reference File for Imports” in the Help Center

15

CostCenterId

Integer

Unique Identifier for the Cost Center

Yes

Use the existing Cost Center Id from DCI

16

DOB

Date

Date of Birth

Yes

Format: MM/DD/YYYY

17

Username

String

Username for login

Optional

Min Length: 6 characters

Max Length: 50 characters

18

Password

String

Password for login

Optional

Min Length: 10 characters

Max: 32 characters

19

ProfileReference

String

Third-party reference number for the Profile

Optional

Min Length: 1

Max Length: 200

20

ClientNumber

Integer

Third-party Client Number

Yes

Min Length: 1

Max Length: 20

21

MedicaidNumber

String

Medicaid Number

Optional

Min Length: 2

Max Length: 20

22

InsuranceNumber

String

Third-party Insurance Number

Optional

Min Length: 2

Max Length: 20

23

InsurancePlan

String

Insurance Company Plan

Optional

Min Length: 2

Max Length: 20

24

InsuranceGroup

String

Insurance Company Group

Optional

Min Length: 2

Max Length: 20

25

InsurancePayerId

String

Insurance Company Payer Number

Optional

Min Length: 2

Max Length: 20

26

ClientCode

String

Third-party code for the Client

Optional

Min Length: 2

Max Length: 20

27

RegionId

String

Third-party Region Name

Optional

Min Length: 2

Max Length: 25

28

SSN

String

Social Security Number

*Must be cleartext (not encrypted)

Optional

Min and Max Length: 9 (Numerals)

29

TemplateId

Integer

Existing Certification Template Id from DCI

Optional

Must use existing Id in DCI

30

Fee

Decimal

Fee Amount

Optional

Min Length: 1

Max Length: 18

(After Decimal: 2)

31

CostShare

Decimal

Cost Share

Optional

Min Length: 1

Max Length: 18

(After Decimal: 2)

32

EnableCaregiverRatingEmails

Int

Allows clients to rate the caregiver for services they’ve received

Yes

Must be 0 or 1 value

Value:

●       0 – No

●       1 - Yes

33

ReceivedDate

Date

Received Date

Optional

Format: MM/DD/YYYY

34

RetainSSN 

Bit

Checks SSN needs to store in encrypted form or not

No

Must be 0 or 1 value

Value:

●       0 - No

●       1 - Yes

35

Pin

Varchar

Login Pin of the Client

Yes

Min/Max Length: 4

36

ProfileStatus

Integer

Status of the Client Profile

*Imported client profile status is set to Active

Yes

Must be a valid Status:

●       1 - Active

●       2 - Inactive

37

PreferredLanguage

Varchar

Preferred language for a Client

Yes

Must be a valid value:

●       en - English

●       es - Spanish

●       vi- Vietnamese

●       zh - Mandarin

●       ru - Russian

●       so - Somali

●       ar - Arabic

Guardian

Field #

Field

Type

Description

Required

Comments

1

FirstName

String

First Name

Yes

Min Length: 2

Max Length: 50

2

LastName

String

Last Name

Yes

Min Length: 2

Max Length: 50

3

Address

String

Address Line 1

Yes

Min Length: 2

Max Length: 150

4

Address2

String

Address Line 2

Optional

Min Length: 2

Max Length: 150

5

City

String

City

Yes

Min Length: 2

Max Length: 20

6

State


String

State

Yes

State abbreviation of 2 characters i.e., Min Length and Max Length: 2

7

PostalCode

String


Postal Code

Yes

Length = 5 numerals

8

CountryCode

String


3 Letter Country Code

Yes

Should be USA

9

Phone

String

Phone Number

Yes

10-digit phone number; exclude dashes and parentheses

10

AltPhone

String

Alternate Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

11

MobilePhone

String

Mobile Number

Optional

10-digit phone number; exclude dashes and parentheses

12

Email

String


Email Address

Yes

Email format: test@dcisoftware.com

13

TimeZone

String


Time Zone

Yes

See “Admin Guide: Static Data Reference File for Imports” in the Help Center

14

CostCenterId

Integer

Unique identifier for the Cost Center

Yes

Must use existing Id in DCI

15

Username

String

Username for Login

Optional

Min Length: 6 characters

Max Length: 20 characters

16

Password

String

Password for Login

Optional

Min Length: 10 characters

Max Length: 32 characters

17

ProfileReference

String


Third-party reference number for the Profile

Optional

Min Length: 1

Max Length: 200

...