Data Integration Utility
Overview
The Data Integration Tool is a batch mechanism used to process jobs that pull in class, user and class/user data
from other back-end systems into the DyKnow server database. The Data Integration Tool offers administrators
a command line interface to update the DyKnow server database with information contained in a flat file and is
automatically installed as part of the DyKnow application server installation. Also, the Administrators Console
has new functionality that works in conjunction with the command line tool to setup and monitor results of the
Data Integration Tool job runs. By using the default settings, you can get started quickly without making any
setup changes.
This Data Integration Tool document includes the following sections.
Section
Section Description
Introduction to Data Integration
Describes the method and processes that the Data Integration Tool uses
to integrate institutional data into the DyKnow server database.
Feed Files
Describes the various types of data feed files that are used by the Data
Integration Tool.
Data integration Tool Modes
Describes in detail the three types of integration: Manual, Snapshot and
Removal
Data Integration Tool Command
Line Syntax
Describes the required syntax for commands issued to the Data
Integration Tool.
One to One Workstation Imports
Details the requirements for importing student/workstation assignments
for DyKnow Monitor Institutions.
Appendix A
Provides a complete list of all importable fields and the required field
names for users, classes and class/user imports.
Appendix B
Provides a list of DyKnow data values.
Appendix C
Provides a list of the settings for each of the DyKnow default Import
Definitions (found in the Administration Console > Manage Data
Integration > Manage Import Definitions)
Appendix D
Provides a list of reasons a row in the import file may be rejected by the
import process.
Appendix E
Provides a list of errors that may occur when DITO.exe cannot complete
the import process.
For additional information on the import utility or creating import definitions, refer to the DyKnow
Administration Console Help File > Administration > Manage Data Integration.
Data Integration Utility File Specifications and User Guide
May, 2011
Introduction to Data Integration
The Data Integration Tool is a simple command line program that takes a class, user or class/user (enrollment)
feed file from an external source and pushes the data into the DyKnow server database in accordance with predefined parameters provided by the institution. It is built for bulk operations and has several modes that can be
used to facilitate different workflows.
The Data Integration Tool allows data for an entity to be transferred from an institutional information system
into the DyKnow database as of a particular point in time. It is analogous to taking a “picture” of the institutional
database and transferring the contents to the DyKnow server database.
The data in the feed file(s) has been extracted from an intuitional database and formatted so that it is
compatible for use by the Data Integration Tool. Feed file(s) can have a header row as the first row of the file
that explains the types of information contained in the file. All data rows (including the header row) are divided
into columns by a delimiter character.
Process Types
Overview
In order to push institutional data into the DyKnow server, the Data Integration Tool follows a certain workflow,
relying on different file types processed during a system update. The workflow process type is either:

Manual - inserts new and updates existing records.

Snapshot - inserts new and updates existing records like Manual mode. However, in certain
circumstances, it also identifies records in the DyKnow database that are not in the current feed file and
blocks the records or marks these records for deletion in accordance with the Institution’s pre-defined
purge settings.

Removal - sets the deletion process in motion for all records included in the feed file using the
institution’s purge settings as described above for Snapshot mode.
The process diagram illustrates the work flow.
Data Integration Tool Process Workflow
DyKnow Version 5.3.34
Page 2
Data Integration Utility File Specifications and User Guide
May, 2011
Frequency of Data Imports
Overview
Data can be loaded into the DyKnow server database on a schedule determined by the institution. The
frequency of data imports can change throughout the year as defined by the institution.
Scheduling
To set the frequency, use the Task Scheduler with Windows 2003 or Windows 2008 operating systems.
Feed Files
Overview
The Data Integration Tool “feed files” are fed into the DyKnow server database to delete, update, or create
records. These feed files are “flat files”, which is another term for character-delimited text files. This section
reviews in detail the format of the Data Integration Tool flat files.
File Format
Overview
A feed file may encompass any of the 3 types of data (users, classes and class/users). A feed file consists of a
header row that identifies each of the columns or fields of data followed by one or more rows of data records.
Note: if the feed file does not include a header row, the file can still be imported by mapping the fields in the
Import Definition: DyKnow Administration Console > Manage Data integration > Manage Import Definitions.
Header Row
The feed file header row contains the field names included in the file. These field names must exactly match the
corresponding DyKnow field names, which are listed in Appendix A of this document. In addition, the header
fields are delimited with the same character as the data records.
Fields can appear in the header row in any order, and fields not recognized by the Data Integration Tool will be
ignored. Therefore, they will not impact the import process nor cause it to fail.
Each feed file type for updating or creating DyKnow server database records has a minimum set of required
fields that need to be identified in the header row.
The minimum fields for a user feed file are (values in parenthesis are acceptable alternate field labels):
Required
Recommended
√
√
√
EXTERNAL_PERSON_KEY
USERID
INSTITUTION_ROLE
√
√
DyKnow Version 5.3.34
Field Label
Field Requirements
Value must exist in Manage User Mappings
found in the Administration Console > Manage
Import Definitions. Defaults include Student,
Faculty and System Administrator.
FIRSTNAME
LASTNAME
Page 3
Data Integration Utility File Specifications and User Guide
May, 2011
The minimum fields for a Class feed file are:
Required
Recommended
√
√
Field Label
Field Requirements
EXTERNAL_COURSE_KEY
COURSE_NAME
For date-based institutions, the following fields are recommended for inclusion in a class feed file:
Required
Recommended
√
√
√
Field Label
Field Requirements
START_DATE
END_DATE
AVAILABLE_IND
For semester-based institutions, the following fields are recommended for inclusion in a class feed file:
Required
Recommended
Field Label
Field Requirements
√
SEMESTERID
Found in the Administration Console_-
Institution Setup Wizard Set Grading Cycles
√
√
SEMESTERYEAR
AVAILABLE_IND
The minimum fields for a class/user (enrollment) feed file are:
Required
Recommended
√
√
√
Field Label
EXTERNAL_COURSE_KEY
EXTERNAL_PERSON_KEY
ROLE
Field Requirements
Value must exist in Manage Class User
Mappings found in the Administration Console
> Manage Import Definitions. Defaults include
Student, Faculty and Instructor.
The following is an example of a header row for a user feed file using a pipe (|) delimiter:
System_Role|External_Person_Key|User_ID|Password|Email|LastName|FirstName|Institution_Role|
Data Rows
After the header row, data records are added to the feed file, one per line. Records are separated by a carriage
return, a linefeed or the combination of the two. The record separator is neither optional nor configurable.
Some data feed elements have sets of string constants for their possible values. For example, the attributes
SYSTEM_ROLE and INSTITUTION_ROLE map to hard-coded values in the DyKnow database. Map User or Class
User institution values in: DyKnow Administration Console > Manage Data Integration > Manage User
Mappings and/or Manage Class User Mappings.
DyKnow Version 5.3.34
Page 4
Data Integration Utility File Specifications and User Guide
May, 2011
Most of the fields whose values are not given (or are blank), are not changed during the import, but will cause
that DyKnow database field to be set to an empty string (or blank). However, the following fields are exceptions
to this rule:






PASSWORD – if the password is blank or not provided then the User ID will be set as the password.
USER_ID – non-blank value required.
INSTITUTION_ROLE – non-blank value required. (i.e. Faculty, Student, etc.)
EXTERNAL_PERSON_KEY – non-blank value required.
EXTERNAL_COURSE_KEY – non-blank value required.
ROLE – non-blank value required. (i.e. Instructor, Student, etc.)
Any fields not found in Appendix A, but are included in the feed file will be ignored by the import.
Data contained in each record must conform to values that are acceptable to the DyKnow server. For acceptable
values for each field, see the Appendix B of this document.
Below are examples of the three types of feed files.
Users
The users feed file is a list of users to be imported into the DyKnow database. The Data Integration Tool
supports either separate faculty and student user files or both faculty and student users in the same file.
This is a sample pipe delimited user’s feed file, which includes the column headers.
System_Role|External_Person_Key|User_ID|Password|Email|LastName|FirstName|Institution_Role|
System Administrator|000507|adm-PB507|507|pb@gmail.com|BOSKER|PAT|faculty|
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
none|000832|adm-CB832|832||BARKER|CATHY|faculty|
none|000040|adm-BB040|040||BASE|BARB|faculty|
none|000300|adm-PE300|300||EASY|PAT|faculty|
. . .
none|120020|stu-120020|120020||ABBEY|MARCY|student|
none|100020|stu-100020|100020||ADAMS|DAN|student|
none|120030|stu-120030|120030||AHRENS|TOM|student|
none|100040|stu-100040|100040||ANDERSON|ANN MARIE|student|
. . .
DyKnow Version 5.3.34
Page 5
Data Integration Utility File Specifications and User Guide
May, 2011
Users feed file columns
If the column names are provided in the feed file, then they must be in the first row, and the column names
must be separated by the same delimiter used throughout the feed file. The following column names are
meaningful within the sample Users feed file.
System_Role – determines if user is System Administrator.
System Administrator|000507|adm-PB507|507|pb@gmail.com|BOSKER|PAT|faculty|
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
External_Person_Key – a unique key as defined by external DB system. This field is required for future import
updates.
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
User_ID – a unique identifies for a user and is stored as the User ID in the DyKnow database.
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
Password – this value is the password used by the user to login to DyKnow. This example has the password “in
the clear”. There are options available that the password can be passed in as an MD5 hashed value. The default
setting is not to ask the user to reset their password during their first login.
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
Email – this is the email assigned to the DyKnow user.
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
LastName – last name of user.
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
FirstName – first name of user.
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
Institution_Role – role of user that determines if user is student or faculty.
none|000822|adm-JD822|822|jd@gmail.com|DOE|JON|faculty|
none|120020|stu-120020|120020||ABBEY|MARCY|student|
DyKnow Version 5.3.34
Page 6
Data Integration Utility File Specifications and User Guide
May, 2011
Classes
The classes feed file is a list of classes to be imported into the DyKnow database. This is a sample class feed file,
which includes the column headers.
External_Course_Key|Course_Name|Available_Ind|Start_Date|End_Date|
001201Y|ECONOMICS
001501F|COMPUTER LIT
001502F|COMPUTER LIT
001503F|COMPUTER LIT
009401X|CAREERS
009601X|DESKTOP PUB
009701Y|LEGAL/MED
111101F|ALGEBRA 1
(01)|Y|08/01/2008|12/31/2008|
(01)|Y|08/01/2008|12/31/2008|
(02)|Y|08/01/2008|12/31/2008|
(03)|Y|08/01/2008|12/31/2008|
(01)|Y|08/01/2008|12/31/2008|
(01)|Y|08/01/2008|12/31/2008|
(01)|Y|08/01/2008|12/31/2008|
(01)|Y|08/01/2008|12/31/2008|
Classes Feed File columns
If the column names are provided in the feed-file, then they must be in the first row, and the column names
must be separated by the same delimiter used throughout the feed-file. The following column names are
meaningful within the sample Class feed-file.
External_Course_Key – a unique course key as defined by external DB system. This is a required field for future
import updates.
001201Y|ECONOMICS
(01)|Y|08/01/2008|12/31/2008|
Course_Name – name of course
001201Y|ECONOMICS
(01)|Y|08/01/2008|12/31/2008|
Available_Ind – indicates if course is available to users.
001201Y|ECONOMICS
(01)|Y|08/01/2008|12/31/2008|
Start_Date – date the course begins.
001201Y|ECONOMICS
(01)|Y|08/01/2008|12/31/2008|
End_Date – date the course ends.
001201Y|ECONOMICS
DyKnow Version 5.3.34
(01)|Y|08/01/2008|12/31/2008|
Page 7
Data Integration Utility File Specifications and User Guide
May, 2011
Class/Users
The class/users feed file contains the student enrollment and faculty class assignments to be imported into the
DyKnow database. The Data Integration Tool supports either separate instructor and student user enrollment
files or both instructors and students in the same file.
This is a sample class/users feed file, which includes the column headers.
External_Course_Key|External_Person_Key|Role|
01201Y|000360|instructor|
01501F|000255|instructor|
01502F|000255|instructor|
. . .
14203F|090020|student|
26206Y|090020|student|
28203X|090020|student|
. . .
Class/Users feed file columns
If the column names are provided in the feed-file, then they must be in the first row, and the column names
must be separated by the same delimiter used throughout the feed-file. The following column names are
meaningful within the sample class/users feed-file.
External_Course_Key – a unique course identifier as defined by external DB system.
01201Y|000360|instructor|
External_Person_Key – a unique person identifier as defined by external DB system.
01201Y|000360|instructor|
Role – role of user that defines if this enrolled user is a student or an instructor.
01201Y|000360|instructor|
14203F|090020|student|
DyKnow Version 5.3.34
Page 8
Data Integration Utility File Specifications and User Guide
May, 2011
Delete Records File
A delete records feed file includes the list of records to purge from the DyKnow server database. The file need
only contain certain key fields in order to identify which records to delete. All other columns in the feed file will
be ignored. Here is an example of a delete records feed file for purging users from the DyKnow server.
External_Person_Key|User_ID|
000507|adm-PB507|
000822|adm-JD822|
000832|adm-CB832|
000040|adm-BB040|
000300|adm-PE300|
. . .
120020|stu-120020|
100020|stu-100020|
100030|stu-100030|
120030|stu-120030|
100040|stu-100040|
. . .
Invalid Data
In the import process, incorrectly formatted data is handled as follows:

Strings that exceed the specified max length for that column will be truncated.

Invalid column headers are ignored.

Rows that have too many or not enough column delimiters are rejected.
For a complete list of all the reasons a row can be rejected, see Appendix D.
Following an import, any rejected rows can be viewed from the Dyknow Administration Console > Manage
Data Integration > View Rejected Records.
Delimiters and Escape Characters
Overview
In order for data to be parsed correctly from a feed file, the Data Integration Tool needs to know where the data
for each different field ends. A character that does not regularly appear in the data is usually selected as the
“delimiter” – the character that separates one field from another within a row. The “,” comma character is the
delimiter character for the DyKnow provided default import definitions.
Occasionally the delimiter character will appear in the data. Unless the system knows that this particular
instance of the delimiter character is actually part of the data itself and not denoting the division of a field, the
data feed will contain errors or fail all together. In order to tell the system that a particular delimiter character is
part of the data set it must be “escaped”.
In order to be able to escape a delimiter, an escape character is defined in the command line options when the
program DITO.EXE executes.
DyKnow Version 5.3.34
Page 9
Data Integration Utility File Specifications and User Guide
May, 2011
Changing the Delimiter
The “,” comma character is the delimiter character for the DyKnow provided default import definitions. To
change the default delimiter character, go to: DyKnow Administration Console > Manage Data Integration >
Manage Import Definitions. The import tool supports the following delimiters in the file.
Comma
Pipe
Carat
Tilde
Colon
Semi-colon
Tab
,
|
^
~
:
;
If this delimiter character appears within a data field, it must be escaped in every field where it occurs. For this
reason, selecting a delimiter character that might commonly appear in the data fields is not recommended.
Setting the Escape Character
To set the escape character, in the batch file, simply provide the command line option switch setting “-e” value
to be the new escape character.
This escape character would precede any delimiter character that appears in all data fields. For example, if the
colon “:” has been set as the delimiter, every time a comma appeared in a data field it would be escaped by
placing the “/” character before it. In the example below, the course name includes a colon, so the colon in the
course name must be escaped like this:
External_Course_Key,Course_Name,Available_Ind,Start_Date,End_Date
001201Y:ECONOMICS 1/:00 PM (01):Y:08/01/2008:12/31/2008
DyKnow Version 5.3.34
Page 10
Data Integration Utility File Specifications and User Guide
May, 2011
Data Integration Tool Modes
Overview
The Data Integration Tool processes in one of three different modes, depending on the task it should perform.
The switch settings in the command line options of the Data Integration Tool help decide which mode the
process will be in. And these modes determine how the records in the feed file will be applied. This section
provides a description of each mode, and how to invoke them using the command line syntax.
Data Integration Tool Command Line Syntax
Overview
Actual data integration imports are performed via a command line executable file named DITO.exe (located in
the server’s ...DyKnow\Server\DITO folder). Commands issued to the Data Integration Tool must follow a
specific syntax in order to be processed correctly. Command line switch settings are used to pass in arguments
to DITO.exe during run time.
This section has the following topics
 Syntax for the DITO.exe command line
 Examples of the DITO.exe commands
Syntax for the DITO.exe command line
Typically DITO.exe is set up to run within a batch file. Below is a list of the command line switch settings.
Required?
Parameter
Description
Example
Note – as with all batch files, if there is a space in the parameter value, include the value in quotes. For
example, an import definition name might appear as “Classes Manual”.
√
Executable
If the batch file is in the same folder
as DITO.exe, then only DITO.exe is
required. If not, the entire path to
DITO.exe is required.
DITO.exe
√
-inst
and/or
-name
Either the Institution ID (-inst) and/or
the Institution Short Name (-name)
provided at the time of the DyKnow
server installation is required.
-inst 5050
-name SchoolName
√
-u
User Name with System
Administrator rights
-u InstAdmin
√
-p
Password of User in the –u
parameter
-p InstAdmin
√
-c
Import Definition Name
-c “Import Definition Name”
Note: Import Definitions are created using the
DyKnow Administration Console > Manage
DyKnow Version 5.3.34
Page 11
Data Integration Utility File Specifications and User Guide
Required?
Parameter
Description
May, 2011
Example
Data integration > Manage Import Definitions
√
-f
File path/name of the file to be
imported. If multiple files of the
same type and format are to be
imported, include each file
path/name with its own parameter (f, -f2, -f3, -f4, -f5) Supports up to 5
feed files in single run instance.
-f C:\DyKnow\DITO\students.txt
-f2 C:\DyKnow\DITO\instructors.txt
Note: using f1 does not work
Ensure that if the import definition
requires column headers that all files
used in the import batch file include
column headers.
Once
-e
Include the –e parameter if the feed
file contains escape characters. The
escape character should be listed in
quotes. If, by chance, the escape
character is a forward slash, do not
use the symbol, spell it out instead.
-m
Include the –m parameter only once
to migrate a DyKnow database
(implemented prior to release 5.2)
with existing classes and users
“|” or “Slash” (not “/”)
The following is an entire DITO.exe command syntax sample:
Dito.exe –inst [instid] –u [SysAdmin-Username] –p [SysAdmin-Password] –c
[Import Definition Name] -f [c:\location of feed file] {-f2 [optional
c:\location of 2nd feed file]} {-f3 [file]} {-f4 [file]} {-f5 [file]}
Sample User Batch File:
DITO.exe -inst 5050 -u InstAdmin -p InstAdmin -c Import_Users -f "c:\Program
Files\DyKnow\Server\DITO\Import Tests\Students to Import.txt" –f2 "c:\Program
Files\DyKnow\Server\DITO\Import Tests\Instructors to Import.txt"
Pause
NOTE - The above example batch file appears as though the first 3 lines before the “Pause” line are on separate
lines. However, lines 1, 2 and 3 in the sample above should really be on the same line in the batch file.
DyKnow Version 5.3.34
Page 12
Data Integration Utility File Specifications and User Guide
May, 2011
One to One Workstation Imports
Overview
Specially designed one to one (1:1) workstation imports enable DyKnow Monitor institutions to populate and
manage the database with the specific workstation/student assignments to be monitored. A workstation is
defined as one computer and is identified by the MAC Address (preferred), Computer Name or IPv4 Address.
The MAC address of the network adapter primarily used for network access is recommended as the single MAC
address to use in the workstation/student import, even though DyKnow Monitor will perform an identification
query against all MAC addresses on a single computer. It is imperative that only one MAC address for a single
computer be imported. Inserting two separate MAC addresses (i.e. the wireless and wired LAN adapter
addresses) for the same computer will cause an attempt to Monitor that computer to fail.
One to One imports are subject to the following requirements:

Users must exist in the DyKnow database prior to running 1:1 workstation imports; else that feed file
row will be rejected.

A single user may be assigned to multiple workstations.

A single workstation may be:
o
o
o
Used in the DyKnow database as a lab workstation or a 1:1 workstation, but not both.
Mapped to a user(s) as a 1:1 workstation by one of the following: MAC address (preferred), IPv4
address or Computer Name.
Included in the feed file only once.
File Format
Like the other import types, columns in the feed file may appear in any order and field names not recognized by
the Data Integration tool will be ignored. The minimum fields for a 1:1 workstation import feed file are in the
table below. Field names for the required columns must exactly match those shown (values in parenthesis are
acceptable alternate field labels):
Required
Field Label
Field Requirements
√
User_ID (UserID)
The student’s DyKnow User ID (not the External_Person_Key).
√
MAC_Address
IPv4_Address
Computer_Name
The workstation to be mapped to the User using either the MAC address, IPv4
address or computer name. The column label should, of course, correspond to
the data type of the data in the column.

Mac Addresses should be in the format: ##-##-##-##-##-##.

IP Addresses should be IPv4 format. ex(127.0.0.1)
As with the other import feed files, 1:1 import feed files may use any one of the following delimiters:







Comma
Pipe
Carat
Tilde
Colon
Semi-colon
Tab
DyKnow Version 5.3.34
,
|
^
~
:
;
Page 13
Data Integration Utility File Specifications and User Guide
May, 2011
Process Types
Like the other import types, 1:1 Workstation Imports may use any of the three Import Process Types. However,
the Snapshot mode import process works differently for 1:1 Workstation Imports.

Manual - inserts new and updates existing records.

Snapshot - inserts new and updates existing records like Manual mode. However, it also identifies
records in the DyKnow database that are not in the current feed file and deletes those rows. Unlike
other imports run in Snapshot mode, records not in the file are deleted instantly rather than using the
Institution’s purge settings.

Remove – instantly deletes any records in the DyKnow database that match rows in the import feed file.
Note: the import file must use the same workstation identifier (MAC Address, IPv4 Address or
Computer Name) to locate the record to remove as was originally used to import the record.
Default 1:1 Import Definitions
1:1 Workstation Imports
Import Definition Name:
1:1 Workstations Manual Default
1:1 Workstations Snapshot Default
Import Type
1:1 Workstations
1:1 Workstations
Process Type
Manual
Snapshot
Batch Name
1:1 Workstations Import
1:1 Workstations Snapshot Import
File Delimiter
Comma
Comma
File Includes Headers?
Yes
Yes
Machine Name Column Header
MAC_Address
MAC_Address
Show Advanced Settings?
No
No
Note: The default import definitions use the MAC address as the machine identifier. If the import file contains
either the Computer Name or the IPv4 Address as the machine identifier, be sure to edit the Import Definition
before running the import. Otherwise the import will reject with the following error since the MAC_Address
column header was expected: Error # 900007718: COLUMN_HEADERS_MISSING.
DyKnow Version 5.3.34
Page 14
Data Integration Utility File Specifications and User Guide
May, 2011
Appendix A: Importable Data Fields
The sample files above only include a subset of all the possible fields that can be imported into the DyKnow
database. The following table contains the complete list of importable fields for each import type. The custom
column header is used in the DyKnow import mapping utility to skip columns contained in the feed file which do
not match importable columns in the DyKnow database.
Users
Classes
ClassUsers
EXTERNAL_PERSON_KEY
USER_ID
EXTERNAL_COURSE_KEY
COURSE_NAME
EXTERNAL_COURSE_KEY
EXTERNAL_PERSON_KEY
FIRSTNAME
DESCRIPTION
ROLE
LASTNAME
ACTIVE
DCLASSUSERTYPEID
MIDDLE_INITIAL
START_DATE
BLOCKED
PASSWORD
END_DATE
Custom Column
EMAIL
CLOSED
STUDENT_ID
SYSTEM_ROLE
SEMESTERYEAR
SEMESTERID
DEPARTMENT
COURSE
INSTITUTION_ROLE
COURSE_SECTION
DUSERTYPEID
BLOCKED
PERIOD
GRADE
MUSTCHGPW
MONITOR_BY_CLASS
NEW_EXTERNAL_PERSON_KEY
INSTRUCTOR
LOCATION
DAYS_AND_TIMES
AVAILABLE_IND
Custom Column
TITLE
ATTENDANCE_DET
OE_DISABLE
NEW_EXTERNAL_COURSE_KEY
AVAILABLE_IND
ENROLL_OPTION
Custom Column
External Person/Course Keys
The EXTERNAL_PERSON_KEY and EXTERNAL_COURSE_KEY fields are used to link the DyKnow database records
to the source database records to facilitate updates of DyKnow data from the source. For example, the
EXTERNAL_COURSE_KEY is the field used by the source database to uniquely identify each instance of a class.
The DyKnow database then stores this unique value in each DyKnow class record to facilitate updates to the
class record from the source. The EXTERNAL_PERSON_KEY works the same way to link DyKnow users to the
source database user records.
Alternate Supported Field Names
For backwards compatibility, the following field names may be used.
Users
Classes

USERID (in lieu of USER_ID)

FIRST_NAME (in lieu of FIRSTNAME)

LAST_NAME (in lieu of LASTNAME
DyKnow Version 5.3.34

NAME (in lieu of COURSE_NAME)

Page 15
Appendix B: DyKnow Data Values
Overview
This section provides a series of tables that describe the fields in each feed file. There are three types of flat files
that can be input into the DyKnow server: User information, class information, and enrollments (class/users).
The following topics describe the layout of the data in the feed files:



User data fields
Class data fields
Enrollment (Class/User) data fields
Data tables
Each of the topics contains tables that describe each data field. The following columns appear in each table:
 Field name - the attribute name in the DyKnow server.
 Field description and data type – a description of the data field and the data type of that field.
The following are rules used when the Data Integration Tool handles data fields.
 When string field values exceed the maximum length, it will be truncated to the maximum length.
 Date fields can be expressed in yyyy/mm/dd or mm/dd/yyyy format.
 String values for Boolean fields are not case sensitive. And values from this set {“True”, “T”, “yes”, “y”,
“1”} will translate to TRUE. All other values will translate to FALSE.
 Integer fields allow any integer value.
 Unicode characters are not permitted. If used, the import will not fail; however, the class and/or user
name that included such characters will not be properly displayed within DyKnow.
User Data Fields
Required user data
Optional user data fields
The following fields must be present in a feed file with
user records for it to be successfully processed:
The following optional fields may be present, but are
not required for a user record to be successfully
processed:
 MIDDLE_INITIAL
 PASSWORD
 EMAIL
 CLOSED (true/false)
 STUDENT_ID
 SYSTEM_ROLE
 INSTITUTION_ROLE
 DUSERTYPEID (integer)
 BLOCKED (true/false)
 MUSTCHGPW (true/false)
 MONITOR_BY_CLASS (true/false)
 NEW_EXTERNAL_PERSON_KEY
 AVAILABLE_IND
 Custom Column





EXTERNAL_PERSON_KEY
USER_ID
INSTITUTION_ROLE
FIRSTNAME - suggested
LASTNAME - suggested
Data Integration Utility File Specifications and User Guide
May, 2011
Data Dictionary: User Data Fields
Field Name
Field Description and Data Type
EXTERNAL_PERSON_KEY
A unique identifier for a user at the institution. This ID is provided by the institution and it
must be a permanent, non-changing unique identifier for each user.
This field is required and its maximum string length is 64 characters.
USER_ID
The User ID must be unique and is used to log into the DyKnow product suite.
This field is required and its maximum string length is 128 characters. Space characters
are not allowed within a USER_ID.
FIRSTNAME
This is the first name of the user.
This field is required and its maximum string length is 64 characters.
LASTNAME
This is the last name of the user.
This field is required and its maximum string length is 64 characters.
INSTITUTION_ROLE
The user’s role, which controls the user’s level of DyKnow privileges. The default user
record mappings set the following Field Value(s) to the corresponding DyKnow Role.
Field Value
Student
Observer
Faculty
System Administrator
DyKnow Role
Student
Student
Faculty
Administrator
These default mappings can be changed or additional roles can be added in the
DyKnow Administration Console. In the Administration section, go to Manage Data
Integration > Manage User Mappings.
1. Click Edit to change the defaults or Add More to add additional role mappings.
2. Choose the Institution Role Group and provide the Role Field Value that will be in
the feed file in this field.
3. Next, select the appropriate User Type DyKnow Role value (Student, Faculty or
Administrator) that will be assigned to the user for each field value.
4. Click Update to save the changes.
There will be an entry for each expected INSTITUTION _ROLE field value in this
column in the feed file. Note: If this column is missing in the feed file, then the user role
will be set to student and the user will have student privileges in DyKnow.
This field is optional and its maximum string length is 128 characters.
MIDDLE_INITIAL
DyKnow Version 5.3.34
This is the Middle Initial of the user’s name. This field is optional and its maximum
string length is 1 character.
Page 17
Data Integration Utility File Specifications and User Guide
May, 2011
Field Name
Field Description and Data Type
PASSWORD
The value in the Password field enables the user to log in to the DyKnow product suite.

If a password is not provided, than the password defaults to the User ID.

If the password is provided, the default import definition settings are:
o The password is imported exactly as it appears in the file (aka “in the
clear”).
o When the user logs in the first time, a password change is not required.

The password field also supports password values as MD5 hashed. To change the
default password setting to support MD5 hashed passwords:
1.
In the Administration Console, go to Manage Data Integration > Manage
Import Definitions.
2. Find the import definition to be used for the user import (the default user
imports are USERS_MANUAL and USERS_SNAPSHOT) and click Edit.
3. Click NEXT to get to the second page of import definition properties.
Change the Password is Hashed? setting to Yes
4. Click Save Definition.
Note: Setting the Sync DyKnow Password value to Yes will always override the
DyKnow user password with the incoming feed file password.
This field is optional and its maximum string length is 128 characters
EMAIL
This is the user’s email address. This field is optional and its maximum string length is
128 characters.
CLOSED
If set to TRUE, this field sets the status of the user to closed.
The field is a Boolean, is optional and string values from the set {“True”, “T”, “yes”, “y”,
“1”} will translate to TRUE. All other values will translate to FALSE. Values in this field
are not case sensitive.
STUDENT_ID
This is the user’s Student ID and is a display only field
This field is optional and its maximum string length is 20 characters.
SYSTEM_ROLE
This field applies to administrative users only and describes the user’s level of system
administration privilege.
To use this field:
1. In the Administration Console, go to Manage Data Integration > Manage User
Mappings
2. Click Add More to add additional role mappings.
3. Choose the role group System and provide the Role value(s) that will be in the
feed file for this field.
4. Next, map the appropriate DyKnow User Type value (Student, Faculty, or
Administrator) that will be assigned to the user for each field value.
5. Click Update to save the changes.
This field is optional. Note: if this value is missing from the feed file, the
INSTITUTION_ROLE will be used to determine if the user is a student, faculty or
system administrator.
DyKnow Version 5.3.34
Page 18
Data Integration Utility File Specifications and User Guide
May, 2011
Field Name
Field Description and Data Type
DUSERTYPEID
This field integer value determines the DyKnow user role. The following integer values
map to the corresponding user role.
0 - Student
1 - Faculty
2 - Systems Administrator
Note: The best practice for this field is not to use it to set the user role. Use the
INSTITUTION_ROLE instead.
This field is optional and its maximum integer length is 1 digit. {0, 1, or 2}
BLOCKED
If TRUE, the user status is set to Blocked so that the user cannot log in to the DyKnow
suite.
This Boolean field is optional and string values from the set {“True”, “T”, “yes”, “y”, “1”}
will translate to TRUE. All other values will translate to FALSE. Values in this field are
not case sensitive.
MUSTCHGPW
If set to TRUE, the user is forced to change their password the next time they log in to
the DyKnow suite.
The value in this field is controlled one of two ways based on parameters set in the
Import Definition. To set the Import Definition parameter, in the Administration section
of the Administration Console:
1. In the Administration Console, go to Manage Data Integration > Manage Import
Definitions.
2. Find the import definition to be used for the user import.
3. Click NEXT to get to the second page of import definition properties. Set the
Require Password Change? value to:
a.
4.
Yes to always force the user to change their password, regardless of the value
in the feed file.
b. No to let the feed file determine whether a password change is required,
Click Save Definition to save the changes.
This Boolean field is optional and feed file string values from the set {“True”, “T”, “yes”,
“y”, “1”} will translate to TRUE. All other values will translate to FALSE. Values in this
field are not case sensitive.
MONITOR_BY_CLASS
If set to TRUE, any new instructor will be able to monitor "One to One" and "Ad Hoc"
User Workstations based on a Class Enrollment. If this value is not included in the
import, the Institution default value is used. To verify the default value, in the
Administration Console, go to the Institution Setup Wizard > Monitor Settings >
User-based Workstation Instructor Monitoring Default Permissions.
NEW_EXTERNAL_PERSON_KEY
This field is used only on the rare occasions when a user’s EXTERNAL_PERSON_KEY
changes. Typically, this situation only occurs when the primary source system
changes.
This field is optional and its maximum string length is 64 characters.
AVAILABLE_IND
NOTE: This field is not currently used by DyKnow.
Custom Column
Custom fields are used in the rare instance that a column in the feed file is needed to
create values for other fields. Please call DyKnow Support or your DyKnow CRM if you
believe there is a need to use custom fields.
DyKnow Version 5.3.34
Page 19
Data Integration Utility File Specifications and User Guide
May, 2011
Class Data Fields
Required class data
The following fields must be present in a feed file with class records for it to be successfully processed:


EXTERNAL_COURSE_KEY
COURSE_NAME - suggested
Optional class data fields
The following optional fields do not need to be present for a class record to be successfully processed:





















DESCRIPTION
ACTIVE (true/false)
START_DATE (date)
END_DATE
(date)
SEMESTERYEAR
SEMESTERID
DEPARTMENT
COURSE
COURSE_SECTION
PERIOD
GRADE
INSTRUCTOR
LOCATION
DAYS_AND_TIMES
TITLE
ATTENDANCE_DET
OE_DISABLE
NEW_EXTERNAL_COURSE_KEY
AVAILABLE_IND
ENROLL_OPTION
Custom Column
DyKnow Version 5.3.34
Page 20
Data Integration Utility File Specifications and User Guide
May, 2011
Data Dictionary: Class Data Fields
Field Name
Field Description and Data Type
EXTERNAL_COURSE_KEY
A unique identifier for a class at the institution. This ID is provided by the institution
and it must be a permanent, non-changing unique identifier for each class.
This field is required and its maximum string length is 64 characters.
COURSE_NAME
The name or title of the class.
This field is required and its maximum string length is 255 characters.
DESCRIPTION
The Description of the class.
This field is optional and its maximum string length is 255 characters.
ACTIVE
Flag to determine whether the class is active.
NOTE: This optional Boolean field is currently not used by DyKnow.
START_DATE
Start date of a class, if using date-based classes.
This field is optional and its maximum string length is 10 characters. Formats allowed
are yyyymmdd or mm/dd/yyyy or mm/dd/yyyy. Note: For a date-based institution,
if the Start Date is not provided, the Data Integration utility sets <Today> as the default
value.
END_DATE
End date of a class, if using date-based classes.
This field is optional and its maximum string length is 10 characters. Formats allowed
are yyyymmdd or mm/dd/yyyy or mm/dd/yyyy. Note: For a date-based institution,
if the End Date is not provided, the Data Integration utility sets <Today + 10 years> as
the default.
SEMESTERYEAR
Year of the class, if using semester-based classes.
This field is optional and it is an integer value. Format is yyyy.
SEMESTERID
Semester ID of the class, if using semester-based classes. The Semester ID maps to
a particular semester as previously set within the Administrators Console at screen
Set Grading Cycles in the Institution Setup Wizard.
This field is optional and its maximum string length is 2 digits. The default settings for
the Semester ID’s are as follows:
0 - None
1 - Spring
2 - Summer 1
3 - Summer 2
4 - Fall
5 – Winter
This field is required for Semester-based institutions and it is an integer.
DEPARTMENT
Department of the class.
This field is optional and its maximum string length is 255 characters.
COURSE
Course identifier of the class.
This field is optional and its maximum string length is 50 characters.
DyKnow Version 5.3.34
Page 21
Data Integration Utility File Specifications and User Guide
Field Name
Field Description and Data Type
COURSE_SECTION
Course section of the class.
May, 2011
This field is optional and its maximum string length is 255 characters.
PERIOD
Period of the class.
This field is optional and it is an integer value.
GRADE
Grade of the class.
This field is optional and it is an integer value.
INSTRUCTOR
User ID of the class instructor.
This field is optional and its maximum string length is 128 characters.
LOCATION
Location for the class.
This field is optional and its maximum string length is 128 characters.
DAYS_AND_TIMES
Days and Times the class meets.
This field is optional and its maximum string length is 128 characters.
TITLE
Title for the class.
This field is optional and its maximum string length is 128 characters.
ATTENDANCE_DET
Attendance Detail value of the class.
This field is optional and it is an integer value.
OE_DISABLE
Open enrollment for the class. If set to TRUE, then open enrollment will be enabled for
this class.
This Boolean field is optional and string values from the set {“True”, “T”, “yes”, “y”, “1”}
will translate to TRUE. All other values will translate to FALSE. Values in this field are
not case sensitive.
NEW_EXTERNAL_COURSE_KEY
This field is used only on the rare occasions when a course
EXTERNAL_COURSE_KEY changes. Typically, this situation only occurs when the
primary source system changes.
This field is optional and its maximum string length is 64 characters.
AVAILABLE_IND
Indicates whether the class is currently available. Default value is Y. If any character
other than “Y” is provided then the class will be considered Unavailable. In other
words, it will not appear in the list of available classes in MyDyKnow.
This field is optional and its maximum string length is 1 character.
ENROLL_OPTION
Enrollment option for a class.
NOTE: This optional string (32 characters) is currently not used by DyKnow.
Custom Column
DyKnow Version 5.3.34
Custom fields are used in the rare instance that a column in the feed file is needed to
create values for other fields. Please call your DyKnow Support or your CRM if you
believe there is a need to use custom fields.
Page 22
Data Integration Utility File Specifications and User Guide
May, 2011
Enrollment (Class/User) Data Fields
Required enrollment data
The following fields must be present in a feed file with class/user records for it to be successfully processed:



EXTERNAL_COURSE_KEY
EXTERNAL_PERSON_KEY
ROLE
Optional enrollment data fields
The following optional fields do not need to be present for a class/user record to be successfully processed:


BLOCKED
DCLASSUSERTYPEID
Enrollment (Class/User) data fields
Field Name
Field Description and Data Type
EXTERNAL_COURSE_KEY
A unique identifier for a class at the institution. This ID is provided by the institution and
it must be a permanent, non-changing unique identifier for each class.
This field is required and its maximum string length is 64 characters.
EXTERNAL_PERSON_KEY
A unique identifier for a user at the institution. This ID is provided by the institution and
it must be a permanent, non-changing unique identifier for each user.
This field is required and its maximum string length is 64 characters.
ROLE
Value that determines if the user is a moderator (instructor) or a participant (student).
Note: If a class is imported without an instructor, the Class/User import will insert the
first user found for the class with a role of either Instructor or Faculty as the primary
instructor.
This field is required and its maximum string length is 100 characters.
BLOCKED
If TRUE, the user is blocked from the class.
This Boolean field is optional and string values from the set {“True”, “T”, “yes”, “y”, “1”}
will translate to TRUE. All other values will translate to FALSE. Values in this field are
not case sensitive.
DCLASSUSERTYPEID
This field integer value is what determines the class/user role of moderator (instructor)
or participant (student).
0 – Participant
(student)
1 – Moderator
(instructor)
It is recommended that this field not be used to set the user role. The ROLE field should
be used to set the class/user role.
This field is optional and its maximum integer length is 1 digit. {0 or 1}
DyKnow Version 5.3.34
Page 23
Data Integration Utility File Specifications and User Guide
May, 2011
Appendix C: DyKnow Default Import Definitions
Class Imports
Import Definition Name:
Classes_Manual_Default
Classes_Snapshot_Default
Import Type
Classes
Classes
Process Type
Manual
Snapshot
Batch Name
Classes Import
Classes Import
File Delimiter
Comma
Comma
File Includes Headers?
Yes
Yes
Allow Purge?
n/a
Yes
Allow Block?
n/a
Yes
Show Advanced Settings?
No
No
ClassUser (Enrollment) Imports
Import Definition Name:
ClassUsers_Manual_Default
ClassUsers_Snapshot_Default
Import Type
ClassUsers
ClassUsers
Process Type
Manual
Snapshot
Batch Name
ClassUsers Import
ClassUsers Import
File Delimiter
Comma
Comma
File Includes Headers?
Yes
Yes
Allow Purge?
n/a
Yes
Allow Block?
n/a
Yes
Show Advanced Settings?
No
No
Import Definition Name:
ClassUsers_Manual_Default
ClassUsers_Snapshot_Default
Import Definition Name:
Users_Manual_Default
Users_Snapshot_Default
Import Type
Users
Users
Process Type
Manual
Snapshot
Batch Name
Users Import
Users Import
File Delimiter
Comma
Comma
File Includes Headers?
Yes
Yes
Allow Purge?
n/a
Yes
Block?
n/a
Yes
Password is Hashed?
No
No
Require Password Change?
No
No
User Imports
See the 1:1 Import Workstation section for the default import definitions.
DyKnow Version 5.3.34
Page 24
Data Integration Utility File Specifications and User Guide
May, 2011
Appendix D: Reasons for Rejected Records
Users
Classes
Class/Users
Import Type
X
X
X
900007723
This record (row) was rejected because there were not enough delimiters. The expected number of
delimiters is determined by either:
 The number of columns in the import file header row or
 The number of columns defined in the Import Definition in the Admin Console (Admin Console
> Manage Data Integration > Manage Import Definitions). In this case, make sure the columns
defined in the Import Definition match the actual columns in the feed-file.
X
X
X
900007724
This record (row) was rejected because there were too many delimiters. The expected number of
delimiters is determined by either:
 The number of columns in the import file header row or
 The number of columns defined in the Import Definition in the Admin Console (Admin Console
> Manage Data Integration > Manage Import Definitions). In this case, make sure the columns
defined in the Import Definition match the actual columns in the feed-file.
X
X
X
900007725
This record (row) was rejected for some reason that DITO could not determine. If you cannot see a
reason the row was rejected, contact DyKnow support for assistance.
X
X
900007726
This record (row) was rejected because the EXTERNAL_COURSE_KEY was missing. The
EXTERNAL_COURSE_KEY field must be in each Class or Class/Users feed-file record.
X
X
900007727
This record (row) was rejected because the EXTERNAL_PERSON KEY was missing. The
EXTERNAL_PERSON_KEY field must be in each Users or Class/Users feed-file record.
X
900007728
This record (row) was rejected because the USERID was missing. The USERID field is required in each
feed-file record.
X
X
900007729
This record (row) was rejected because the User Role was not missing. The User Role field is required in
each feed-file record.
For those import definitions using column headers in the feed-file:
 Users: The title required for the User Role column header is INSTITUTION_ROLE.
 Class/Users: The title required for the Class/User Role column header is ROLE.
DyKnow Version 5.3.34
Page 25
Data Integration Utility File Specifications and User Guide
May, 2011
X
Class/Users
Classes
Users
Import Type
900007730
This record (row) was rejected because the USERID included spaces within the USERID. The USERID field
may not contain spaces.
X
900007731
This record (row) was rejected because the same USERID exists for more than one
EXTERNAL_PERSON_KEY and this is not allowed in the DyKnow database.
Likely, a feed-file USERID already exists in the DyKnow database and the database USERID/
EXTERNAL_PERSON_KEY combination is different than the USERID/EXTERNAL_PERSON_KEY combination
in the feed-file.
X
900007732
This error only occurs in imports where EXTERNAL_PERSON_KEYS in the DyKnow database are being
updated to new values. In this case, the record (row) was rejected because the feed-file contains a
NEW_EXTERNAL_PERSON_KEY that is a duplicate of an EXTERNAL_PERSON_KEY that already exists in the
DyKnow database.
X
900007733
This error only occurs in imports where EXTERNAL_PERSON_KEYS in the DyKnow database are being
updated to new values. In this case, the record (row) was rejected because both the USERID and
EXTERNAL_PERSON_KEY cannot be changed using the same feed-file at the same time.
X
900007734
Multiple records (rows) exist in the feed-file with the same USERID but different
EXTERNAL_PERSON_KEYs. Therefore, each row was rejected since it is unclear which is the correct
EXTERNAL_PERSON_KEY.
Note: This error can occur in Migration Mode also.
X
900007735
This error only occurs in imports where EXTERNAL_PERSON_KEYS in the DyKnow database are being
updated to new values. In this case, the record (row) was rejected because duplicate
NEW_EXTERNAL_PERSON_KEYs cannot be in same feed-file.
X
900007736
This record (row) was rejected because there were duplicate EXTERNAL_PERSON_KEY values for different
USERIDs in the same feed-file.
Note: This error can occur in Migration Mode also.
X
900007737
This record (row) was rejected because there cannot be duplicate EXTERNAL_COURSE_KEY values in the
same feed-file.
Note: This error can also occur in Migration Mode.
DyKnow Version 5.3.34
Page 26
Data Integration Utility File Specifications and User Guide
May, 2011
Class/Users
Classes
Users
Import Type
X
900007738
This record (row) was rejected because there cannot be duplicate EXTERNAL_COURSE_KEY values in the
same feed-file.
X
900007739
This record was rejected because the User EXTERNAL_PERSON_KEY, the Class EXTERNAL_COURSE_KEY or
both external keys could not be found in the DyKnow database. Both the User EXTERNAL_PERSON_KEY
and the Class EXTERNAL_COURSE_KEY must exist before the Class/User (enrollment) record can be
inserted.
X
900007741
This error only occurs in imports where EXTERNAL_COURSE_KEYS in the DyKnow database are being
updated to new values. In this case, the record (row) was rejected because there are duplicate values
for the NEW_EXTERNAL_COURSE_KEY(s) in the feed-file.
X
900007742
This error only occurs in imports where EXTERNAL_COURSE_KEYS in the DyKnow database are being
updated to new values. In this case, the record (row) was rejected because a value specified for the
NEW_EXTERNAL_COURSE_KEY already exists as an EXTERNAL_COURSE_KEY in the in the DyKnow
database.
X
900007743
This error only occurs in imports where EXTERNAL_COURSE_KEYS in the DyKnow database are being
updated to new values. In this case, the record (row) was rejected because an EXTERNAL_COURSE_KEY
(about to be inserted) cannot be changed to a NEW_EXTERNAL_COURSE_KEY that already exists in the
DyKnow database.
X
900007744
This record (row) was rejected because it was trying to INSERT (aka create) a CLASS whose
COURSE_NAME already exists with an EXTERNAL_COURSE_KEY that is NULL. Generally the way to resolve
this is to run the CLASS feed-file first in Migration mode to set the NULL values with the
EXTERNAL_COURSE_KEY.
X
X
X
900007780
This record (row) was rejected because one of the following fields has an empty string, which is not
allowed.
USERS:
CLASSES:
CLASS/USERS:
EXTERNAL_PERSON_KEY
EXTERNAL_COURSE_KEY
EXTERNAL_COURSE_KEY
USERID
EXTERNAL_PERSON_KEY
INSTITUTION_ROLE
ROLE
X
900007781
This record (row) was rejected because USERID cannot be the instadmin.
DyKnow Version 5.3.34
Page 27
Data Integration Utility File Specifications and User Guide
May, 2011
Class/Users
Classes
Users
Import Type
X
900007782
This record (row) was rejected because EXTERNAL_PERSON_KEY cannot be the instadmin.
X
900007783
This record (row) was rejected because the NEW_EXTERNAL_PERSON_KEY cannot be the Instadmin nor
the DITO admin.
X
X
X
900007784
This record (row) was rejected because an imported column has single or double quotes around the
External Key or the UserID, which is not allowed.
X
900007785
This record (row) was rejected because USERID cannot be the DITO admin.
Migration
Mode Only
Users
These errors apply only to DITO imports run in Migration Mode (using the –m parameter in
the import batch file).
900007740
The feed-file contains a USERID that does not exist in the DyKnow database, therefore the row is
rejected.
Classes
900007752
This record (row) was rejected because it contains an EXTERNAL_COURSE_KEY value that already exists
in the DyKnow database.
Classes
900007753
This record (row) was rejected because there are duplicate Class Name(s) for different
EXTERNAL_COURSE_KEY values. Duplicate Class Name(s) cannot be in the same feed-file for different
EXTERNAL_COURSE_KEY(s).
Classes
900007754
This record (row) was rejected because it cannot update EXTERNAL_COURSE_KEY for more than one
Class Name(s) that exist in the DyKnow database. Class Name must be unique in order to update
EXTERNAL_COURSE_KEY(s).
Classes
900007755
The feed-file contains a class name that does not exist in the DyKnow database. Therefore, the record
(row) in the feed-file is rejected since there is no match in the database.
Users
900007762
This record (row) was rejected because the feed-file contains an EXTERNAL_PERSON_KEY that already
exists in the DyKnow database for a different USERID.
DyKnow Version 5.3.34
Page 28
Data Integration Utility File Specifications and User Guide
1 to 1
Workstations
1 to 1
May, 2011
These errors apply only to DITO One to One Workstation imports.
900007756
This row was rejected because the User Workstation Identifier is missing.
1 to 1
900007758
This row was rejected because it contains an invalid MAC_Address .
1 to 1
900007759
This row was rejected because it contains an invalid IPv4_Address.
1 to 1
900007790
The feed-file contains the same Workstation name in multiple rows.
1 to 1
900007791
This record (row) was rejected because the User ID specified does not exist in the DyKnow database.
1 to 1
900007792
This record (row) was rejected because the Workstation name has already been specified as a lab
workstation in the DyKnow database.
DyKnow Version 5.3.34
Page 29
Data Integration Utility File Specifications and User Guide
May, 2011
Appendix E: DITO.exe errors
In some instances, a failure occurs when the DITO.exe processing begins and an import does not occur.
In these cases, a DITO.log file is created in the same directory where DITO.exe is located. The DITO.log
file will provide an error number to indicate the problem. The following is a list of the potential errors
that may appear in the DITO.log file.
900007701
ERR_DITO_PARM_INSTID_MISSING
Missing the command line parameter -inst. When running DITO.exe, a command line
option -inst #### is required where #### is the institution ID to be populated by the flat
files.
900007702
ERR_DITO_PARM_COMMAND_MISSING
Missing the command line parameter -c. When running DITO.exe, a command line
option -c XXXX is required where XXXX is the Import Definition name created in the
Admin Console > Manage Data Integration > Manage Import Definitions. This Import
Definition includes the complete set of parameters to be used for this import process.
900007703
ERR_DITO_PARM_USERNAME_MISSING
Missing the command line parameter –u. When running DITO.exe, a command line
option -u XXXX is required where XXXX is the user ID running the import. This user must
have system administrator privileges.
900007704
ERR_DITO_PARM_PASSWORD_MISSING
Missing the command line parameter –p. When running DITO.exe, a command line
option -p XXXX is required where XXXX is the password of the system administrator user
identified with the –u parameter.
900007705
ERR_DITO_PARM_FILENAME_MISSING
Missing the command line option –f. When running DITO.exe, a command line
parameter –f FFFFFFFF where FFFFFFFF is the name of the feed-file containing the
records to import.
900007706
ERR_DITO_VALIDATE_USER_FAILED
The user ID provided in the command line option -u failed to validate for some reason.
Try again using a different system administrator. If the same error occurs, contact
DyKnow system support.
900007707
ERR_DITO_AUTHENTICATE_USER_ FAILED
The user ID provided in the command line option -u failed to authenticate. Check the
user ID or password – one or both may be incorrect. If they are valid, verify this user is
not currently logged in. DITO will not run within the context of a user ID while the user is
also logged in somewhere else. Log out this user before running DITO with the same user
ID.
900007708
ERR_DITO_NOT_SYSTEM_ADMINISTRATOR
The user ID provided in the command line parameter -u is not a system administrator.
DITO will only run using the credentials of a system administrator.
DyKnow Version 5.3.34
Page 30
Data Integration Utility File Specifications and User Guide
May, 2011
900007709
ERR_DITO_DB_GET_PARAMETERS_ FAILED
DITO failed when getting the parameters associated with the Import Definition name
provide in the –c option in the command line. Go to Admin Console > Manage Data
Integration > Manage Import Definitions and double-check the Import Definition name
to ensure it exists for that institution ID.
900007710
ERR_DITO_READING_PARAMETERS_FAILED
While reading the parameters defined in the Import Definition name used with the -c
option in the command line, DITO failed in the routine GetOptions(). One reason this can
happen is when the feed-file delimiter is the same as Esc character. The Esc character
cannot be the same as the feed-file delimiter.
900007711
ERR_DITO_DB_GET_BATCH_NAME_ID_FAILED
DITO failed in the routine GetBatchNameID() when trying to retreive the BatchNameID.
Please contact DyKnow technical support to resolve this issue.
900007712
ERR_DITO_DB_GET_FILE_ID_FAILED
DITO failed in the routine GetFileID() when trying to retreive the FeedFileID. Please
contact DyKnow technical support to resolve this issue.
900007713
ERR_DITO_DB_BATCH_INSERT_STEP1_FAILED
DITO failed in the routine BatchInsertStep1() when trying to set things up to begin the
importing of data from the provided feed-file. Please contact DyKnow technical support
to resolve this issue.
900007714
ERR_DITO_DB_BATCH_INSERT_STEP2_FAILED
DITO failed in the routine BatchInsertStep2() when trying to summarize import feed-file
load totals, and when trying to determine if the feed-files loaded successfully. Please
contact DyKnow technical support to resolve this issue.
900007715
ERR_DITO_DB_SIS_TRANSFER_FAILED
DITO failed in the routine BatchSISTransfer() when trying to complete the import feedfile process. This is the routine that actually updates the production files. Please contact
DyKnow technical support to resolve this issue.
900007716
ERR_DITO_INCOLUMN_MISSING_FOR_OUTCOLUMN
DITO failed in the routine SetColumnsIndex() when trying to determine columns of data
in the feed-files. Please contact DyKnow technical support to resolve this issue.
900007717
ERR_DITO_BULK_IMPORT_FILES_FAILED
DITO failed in the routine BulkImportFiles() when trying to load the feed-file(s) in to the
DyKnow server for processing. Please contact DyKnow technical support to resolve this
issue.
900007718
ERR_DITO_GET_COLUMN_HEADERS_FAILED
DITO failed in the routine GetColumnHeaders() when trying to bulk import the feed-files.
Likely, a column header is either missing or misspelled. Please contact DyKnow technical
support to resolve this issue.
900007719
ERR_DITO_SET_COLUMN_NDX_NO_OUTFILE_FAILED
DITO failed in the routine SetColumnsIndex_NoOutFile() when trying to bulk import the
feed-files after having retreived the column headers. Please contact DyKnow technical
support to resolve this issue.
DyKnow Version 5.3.34
Page 31
Data Integration Utility File Specifications and User Guide
May, 2011
900007720
ERR_DITO_READ_BULK_IMPORT_USERS_FAILED
DITO failed in the routine ReadBulkImportUsers() when trying to read a User feed-file
record (row) to import into the DyKnow server. Please contact DyKnow technical support
to resolve this issue. Note: this error code identifies errors that occurred outside the
control of the data integration process. For example, a SQL Server error would result in
this error code.
900007721
ERR_DITO_READ_BULK_IMPORT_CLASSES_FAILED
DITO failed in the routine ReadBulkImportClasses() when trying to read a Class feed-file
record (row) to import into the DyKnow server. Please contact DyKnow technical support
to resolve this issue. Note: this error code identifies errors that occurred outside the
control of the data integration process. For example, a SQL Server error would result in
this error code.
900007722
ERR_DITO_READ_BULK_IMPORT_CLASS_USERS_FAILED
DITO failed in the routine ReadBulkImportClassUsers() when trying to read a Class/User
feed-file record (row) to import into the DyKnow server. Please contact DyKnow
technical support to resolve this issue. Note: this error code identifies errors that
occurred outside the control of the data integration process. For example, a SQL Server
error would result in this error code.
900007770
ERR_DITO_MIGRATION_FAILS_WITH_CURRENT_SETTINGS
DITO failed because Migration mode is only allowed for Users and Classes data types
when in Manual mode.
900007771
ERR_DITO_READ_BULK_IMPORT_CLASSES_FAILED
DITO failed in the routine ReadBulkImportClasses() when trying to read a Class feed-file
record (row) to import into the DyKnow server. Please contact DyKnow technical support
to resolve this issue. Note: this error code identifies errors that occurred outside the
control of the data integration process. For example, a SQL Server error would result in
this error code.
900007795
ERR_DITO_INST_NAME_NOT_FOUND
The institution name supplied as the –name command line parameter is not found in the
DyKnow database.
900007796
ERR_DITO_INST_AND_SHORTNAME_INSTID_MISMATCH
The combination of the command line parameters supplied for –inst and –name do not
match any combination stored in the DyKnow database.
900007797
ERR_DITO_PARMS_MISSING_FOR_INSTID
Missing the command line parameter -name. When running DITO.exe, a command line
option -inst (Institution ID) and/or –name (Institution Short Name) is required to identify
the institution to be populated by the flat files. The value of –inst is the institution ID
and the value of –name is the short name stored in the DyKnow database.
DyKnow Version 5.3.34
Page 32