CUSTOMER - replaced with Company Acronym Schema. This is the same Company code used in the URL provided by ARCOS to access the Customer web interface. (e.g. AUSS.rostermonster.com, where AUSS is the Company Acronym Schema.)
TYPE - replaced with the file type you are attempting to load. This includes HRI, HRI1, OTI, OTI2, and others identified in the Loader section of this document.

This file naming convention automatically populates the file type and confirms the company schema matches the customer ARCOS Platform. When loading the flat file without this naming convention the Type drop down menu will be used to select the file type on the Load Data page of the front-end Web Interface. Load files can be Comma Delimited (.csv), Pipe Delimited (.dat), or Excel 97-2003 Workbook (.xls).

Record Format Standards

All ARCOS Flat File specifications adhere to the following set of standards.

Field values are variable length. Fixed length data should not be sent in any field.
- I.e. if a field accepts a maximum length of seven (7) and your data value is four (4) long, the file does not include three (3) additional spaces. This applies to all record types, including all header & data records, when transmitted via API uploadFile method and Web UI Loader tool.
- The Web UI Loader tool may accept fixed-length data values, but this is not a supported feature
- Certain legacy and deprecated sFTP services may use fixed length data values, this is no longer supported
- The API uploadFile method will not accept fixed-length data values
Delimited by the Pipe Symbol “|” or the Comma Symbol “,”
New Line between records without a Carriage Return
File must be encoded with UTF-8

If generating test files using Excel spreadsheets, certain Excel formats will drop leading zeros and may also change the encoding of the file from the required UTF-8.

Field Type Key for all support file standards:

Type N(X,X) = Numeric (Max Length, Max Decimal Length, if applicable)

Type X(X) = Alphanumeric and Special Characters (Max Length)

HRI (Human Resources / Employee Data)

The HRI file type allows the loading and modification of Employee data such as Name, Location, Class, and Contact Devices. HRI stands for Human Resources Information. HRI and HRI1 file types contain employee information and are used to add/update employee data.

HRI files only contain 100 and 200 row records while HRI1 contains additional record types as described in the HRI1 File Specification. Additionally, please note the format of 200 records is different between HRI and HRI1 files.

Record Numbers

The only two record types/numbers are 100 (Header) and 200 (Basic Employee Data) records.

Record Number	Data represented in the record(s)
100	Header
200	Basic Employee Data

Record Descriptions

100 – Header/Trailer Record

The Header Record will be used by ARCOS for data integrity checking. ARCOS will make a first pass through the file counting the records and will then verify that the Header / Trailer record count is correct prior to processing the file. If the actual number of records in the file does not match the count stored in the header record, the file will not be processed at all and an error report will be created.

Field Description and Type	Format and Notes
Record Type – Type N(3)	100 (Header Record) – REQUIRED See description above.
Company Identifier – Type X	[Company Code] ARCOS Customer Company Acronym (Company SCHEMA)
Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS, Hours (HH) are 24-hour clock. Export date cannot be more than 6.75 days from load date. Seconds are optional.
Overtime Effective Date– Type N(14)	Format MMDDYYYYHHMMSS, The date which OT Hours come into effect. Hours (HH) are 24-hour clock. Seconds are optional.
Export Record Count – Type N(5)	Total records not including header rows

200 - Data Record

Field Description and Type	Format and Notes
Record – Type N(3)	200 Data Record - REQUIRED
Employee Number – Type N	This is used to provide the employee's Web ID and VRU ID. It adds an xwalk value for the employee (which functions as the Employee ID) - REQUIRED
First Name – Type X(30)	REQUIRED
Middle Initial – Type X(1)
Last Name – Type X(30)	REQUIRED
Department Number– Type N	This is used to identify the department the employee is assigned to (this is not directly represented in ARCOS) - REQUIRED
Job Class Number – Type X	This is the xwalk value for the employee's primary class - REQUIRED
Primary Phone Number – Type N(10)	The phone number with Sequence 1.
Union Seniority Date – Type N(8)	Format MMDDYYYY
Service Date – Type N(8)	Format MMDDYYYY
Reporting Location– Type X	This is used to identify the reporting location the employee is assigned to (this is not directly represented in ARCOS) - REQUIRED
Overtime Hours – Type N(10,2)	IF USED – would contain the number of overtime hours which employee has. Hours can be entered with a whole number (e.g. 350) or with two decimal places (e.g. 154.74)
Storm Code – Type X(9)	IF USED – would identify the unique ARCOS Event ‘Storm Code’ to associate this employee record to
Storm Company – Type X(30)	IF USED – would identify the name of the organization the employee resource reports to

The Department Number and Report Location do not actually correspond to any locations in ARCOS directly. Employees are assigned to locations using a combination of these values and Job Class Number. When ARCOS attempts to place the employee in a location, it will attempt to match a location's xwalk value to the string [Reporting Location]-[Department Number]-[Job Class Number].

There is no firm limit on length of department numbers and reporting locations. Xwalk values are limited to 50 characters and the format of the xwalk which ARCOS attempts to match the multi-part xwalk to contains two hyphens, meaning that the department number, job class number, and reporting location cannot exceed a combined length of 48 characters.

During an HRI update to an employee that already exists - If an optional field is left blank or null, ARCOS will not overwrite any data in that field in the ARCOS database with the blank/null.

Above: Example diagram of mapping HRI fields into the CSV file format.[GB1]

HRI1 (Human Resources / Employee Data, Extended)

HRI files only contain 100 and 200 row records while HRI1 contains additional record types as described below. Additionally, please note the format of 200 records is different between HRI and HRI1 files.

Record Numbers

The only two required record types/numbers are 100 (Header) and 200 (Basic Employee Data) records. Other record numbers may be used when additional data is sent to ARCOS.

Record Number	Data represented in the record(s)
100	Header
200	Basic Employee Data
201	Employee Email Addresses Data
202	Telephone Device Data
203	Pager Device Data
204	Transfer-To-Device Data
205	Extended Employee Attributes

Record Descriptions

In the Notes section, each field is identified as REQUIRED or N/A. N/A fields must be included in the file structure as a blank column. Optional fields are assumed when not indicated as REQUIRED or N/A.

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	100 (Header Record) – REQUIRED See description above
	Company Identifier – Type X	ARCOS Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS (Seconds are optional)Hours (HH) are 24-hour clock. Export date cannot be more than 6.75 days from load date. – REQUIRED
	Export Record Count – Type N	Total records not including 100 header/trailer record – REQUIRED

200 - Data Record

Ref	Field Description and Type		Format and Notes
	Record – Type N(3)		200 Data Record - REQUIRED
	Emp_Id – Type X(11)		REQUIRED
	WEB Login ID – Type X(40)		REQUIRED
	VRU-ID – Type N(15)		REQUIRED
	First Name – Type X(30)		REQUIRED
	Middle Initial – Type X(1)
	Last Name – Type X(30)		REQUIRED
	Nick Name – Type X(30)
	Union Seniority Date – Type N(8)		Format MMDDYYYY
	Service Date – Type N(8)		Format MMDDYYYY
	Job Classification Code – Type X(50)		Xwalk job class ID – REQUIRED
	Street 1 Address – Type X(55)		***Warning: the address information included here will be automatically overwritten by the load. This update will also cause a “look up” of Lat/Long data for the address, if your company has Closest-To-Trouble (‘CTT’) Add-On.
	Street 2 Address – Type X(55)		***See HRI/CTT warning above
	City – Type X(30)		***See HRI/CTT warning above
	State – Type X(6)		***See HRI/CTT warning above
	Postal Zip Code – Type X(12)		***See HRI/CTT warning above
	Location Code – Type X(10)		Location Name or XWalk ID - REQUIRED
	Phone #1 number – Type N(10)		Extra characters and spaces in the phone numbers do NOT cause a problem. ARCOS will strip all of them out during the load. CUSTOMER should send phone numbers *sequentially*. Example: If an employee has two phone numbers DO NOT send phone 1 in field 18 and send phone two in field 22 (Do not skip fields 20 and 21). You cannot populate phone 3 and not phone 1 and 2. During the load, if there is not a phone 1 it will skip the phone section all together
	Phone #1 type – Type X(3)		R=Regular Phone; C=Cell Phone; P=Pager; When Duty Phone functionality is turned on: R-D=Regular/Duty Phone; C-D=Cell/Duty Phone; P-D=Pager/Duty. Hyphen separates device abbreviation from Duty Flag. Duty phone is option and “-“(Field) is only used when indicating a duty phone flag. Additionally, Phone Type can be customer defined in Device Types Admin Page
	Phone #2 number – Type N(10)		Extra characters and spaces in the phone numbers do NOT cause a problem. ARCOS will strip all of them out during the load.
	Phone #2 type – Type X(3)		R=Regular Phone; C=Cell Phone; P=Pager; When Duty Phone functionality is turned on: R-D=Regular/Duty Phone; C-D=Cell/Duty Phone; P-D=Pager/Duty. Hyphen separates device abbreviation from Duty Flag. Duty phone is option and “-“(Field) is only used when indicating a duty phone flag. Additionally, Phone Type can be customer defined in Device Types Admin Page
	Phone #3 number – Type N(10)
	Phone #3 type – Type X(3)		R=Regular Phone; C=Cell Phone; P=Pager; When Duty Phone functionality is turned on: R-D=Regular/Duty Phone; C-D=Cell/Duty Phone; P-D=Pager/Duty. Hyphen separates device abbreviation from Duty Flag. Duty phone is option and “-“(Field) is only used when indicating a duty phone flag. Additionally, Phone Type can be customer defined in Device Types Admin Page
	YTD OT Hours – Type N(10,2)		Hours can be entered with a whole number (e.g. 350) or with two decimal places (e.g. 154.74)
	Effective Date of Hours – Type N(14)		Format MMDDYYYYHH24MMSS (Seconds are optional) Even though each ‘200’ record will have an effective date of hours, ARCOS will only read the first date encountered. ARCOS will change all effective date of hours fields for all subsequent records to the first date encountered in the HRI file. A single effective date is recommended for all ‘200’ records.
	Birthday – Type X(8)		Format MMDDYYYY
	Employee Status – Type X(1)		A = Active, I = Inactive, D = Deleted First time employee record load will default to Active status. Null value on existing employee records will not change current status setting.
	Schedule “code” (n/a)[GB2]
	Primary Email – Type X(100)		If more than one email address is to be provided via HRI1+ Load, use 201 type Records.
	Notify Only – Type X(1)		Acceptable input: null, 0, 1 NULL input (blank) or 0 = NOT Notify Only 1 = Notify Only Any input deviating from the above will cause the loading of the contact record to fail.
	Radio – Type X(100)
	Vacation Days – Hrs Entitled – Type N(10,2)		IF USED – Requires the number of vacation hours to which employee is entitled for the period – for use with Vacation Management Add-On. All Hrs Entitled and Hrs Used Vac Mgt fields must be populated with a numeric value. Zero (0.00) is REQUIRED as a valid numeric value and will overwrite existing entry in the ARCOS Employee Vacation Management Page.
	Personal Days – Hrs Entitled – Type N(10,2)		IF USED – Requires the number of personal-day hours to which employee is entitled for the period – for use with Vacation Management Add-On. All Hrs Entitled and Hrs Used Vac Mgt fields must be populated with a numeric value. Zero (0.00) is REQUIRED as a valid numeric value and will overwrite existing entry in the ARCOS Employee Vacation Management Page.
	Vacation Days – Hrs Used – Type N(10,2)		IF USED – Requires the number of vacation hours which employee has used for the period – for use with Vacation Management Add-On. All Hrs Entitled and Hrs Used Vac Mgt fields must be populated with a numeric value. Zero (0.00) is REQUIRED as a valid numeric value and will overwrite existing entry in the ARCOS Employee Vacation Management Page.
	Personal Days – Hrs Used – Type N(10,2)		IF USED – Requires the number of personal-day hours which employee has used for the period – for use with Vacation Management Add-On. All Hrs Entitled and Hrs Used Vac Mgt fields must be populated with a numeric value. Zero (0.00) is REQUIRED as a valid numeric value and will overwrite existing entry in the ARCOS Employee Vacation Management Page.
	Vacation Mgt – Effective Date – Type N(8)		IF USED – would contain the effective date of any hours loaded to ARCOS for use with Vacation Management Add-On. Format: MMDDYYYY
		Phone #4 – Type X(10)	IF USED – would identify a 4^th employee phone number
		Phone #4 Type – Type X(1)	IF USED – would identify the device type of the employee’s 4^th device
		Phone #5 – Type X(10)	IF USED – would identify a 5^th employee phone number
		Phone #5 Type – Type X(1)	IF USED – would identify the device type of the employee’s 5^th device
		Storm Code – Type X(9)	IF USED – would identify the unique ARCOS Event ‘Storm Code’ to associate this employee record
		Storm Company – Type X(30)	IF USED – would identify the name of the organization the employee resource reports

ADDITIONAL NOTES

During an HRI1 update to an employee that already exists - If an optional field is left blank or null, ARCOS will not overwrite any data in that field in the ARCOS database with the blank/null. That is, ARCOS will not blank out data based on the HRI1 load.

Please consider if some fields need to be “Protected” from further HRI1 updates. This requirement should be discussed with your ARCOS Implementation Manager or Professional Services Consultant, who will further review the request with ARCOS Engineering team. Not all fields are eligible for protection.

201 - Employee Email Addresses Data

If employee record has only 1 email address with no qualifiers (additional fields being sent), there is no need to send 201-level records; field 29 in 200-record above can be used.

Ref	Field Description and Type		Format and Notes
		Record Type – Type N(3)	201 Email Address Record - REQUIRED See description above.
		VRU-ID – Type N(11)	REQUIRED – Numeric with NO Alphabetic characters
		Email – Type X(100)	The email address provided in this field must be in the format name@something.com or .net, otherwise ARCOS will not load it.
		Display Order – Type N(4)	Identifies the order to display the email address. The only options for Display Order is, 1, 2, or 3.
		Email – Description – Type X(100)
		Email – Enabled? – Type X(1)	1 = yes, 0/null = no
		Email – Condensed? – Type X(1)	1 = yes, 0/null = no

*** Repeat record for additional email addresses.

202 - Additional Telephone Device Data Record

This record should be used only if additional device information – beyond phone number and device type - is needed.

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	202 Phone Device Record - REQUIRED See description above.
	VRU-ID – Type N(11)	REQUIRED – Non-numeric characters will not validate.[GB3]
	Phone Number – Type N(10)	extra characters and spaces in the phone numbers do NOT cause a problem. ARCOS will strip all of them out during the load.
	Display Order – Type N(4)	This is the device display order in the employee record to (e.g. Phone 1, Phone 3, Phone 4)
	PIN Req – Type X(1)	1 = yes, 0/null = no
	Call Order Seq – Type X(1)	Valid values include 1,2, etc. up to maximum number of devices allowed, and S for Standby. Order of devices in the file determines the display order, but the information in this field will set the sequence (in which ARCOS would call them). Sequence CAN be null indicating that a device is NOT active. If duplicate sequence #s occur in the file, only the later-added device will get the sequence number. The end result will be that only one device may have sequence 1, for example.
	Phone On Duty? – Type N (1)	1 = yes, 0/null = no
	Phone Trusted Device? – Type N(1)	1 = yes, 0/null = no NOTE: ARCOS will validate that the number here has NOT already been identified as “Trusted” by another employee. If the number has been “Trusted” by another employee, ARCOS will NOT load it here.
	Phone Type – Type X (1)	R=Regular Phone, C=Cell Phone, P=Pager, or customer defined in Device Types Admin Page
	Phone – Pause first – Type N(1)	(Delay 1)
	Phone – Touch Tone first – Type N(10)	(Touchtone 1)
	Phone – Pause second – Type N(1)	(Delay 2)
	Phone – Touch Tone second – Type N(10)	(Touchtone 2)
	Phone – Comments – Type X(1000)	(Device Comments)
15.	SMS Enabled – Type N(1)	1 = enabled, 0 = disabled

***Repeat this record for additional devices.

203 - Pager Device Data Record

This record should be used only if additional pager device information – beyond number and device type - is needed.

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	203 Pager Device Data Record – REQUIRED - See description above.
	VRU-ID – Type N(11)	REQUIRED – Non-numeric characters will not validate.[GB4]
	Pager Number – Type N(10)
	Display Order – Type (4)	This is NOT Call Order Seq. This is the device display order in the employee record (e.g. Phone 1, Phone 3, Phone 4)[GB5]
	Sequence – Type N(1)	Call Order Seq number set by customer to identify order phone numbers are called in a Callout.
	Pager On Duty? – Type N(1)	1 = yes, 0/null = no
	Pager Type – Type X(10)	Must exactly match a pager type defined for the customer system
	Pager PIN – Type N(4)	Expected numeric PIN, if required by pager

***One record per pager device.

204 - Transfer Number Data Record

This record should be used only if transfer device is used.

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	204 Transfer-To Number - REQUIRED See description above.
	VRU-ID – Type N(11)	REQUIRED – Non-numeric characters will not validate.[GB6]
	Transfer to Phone Number – Type N(10)
	Transfer to Phone Type – Type X(1)
	Transfer to Phone Pause first – Type N(3)
	Transfer to Phone Touch Tone first – Type N(10)
	Transfer to Phone Pause second – Type N(3)
	Transfer to Phone Touch Tone second – Type N(10)
	Transfer to Phone Comments – Type X(1000)

***One record per Transfer-To device.

205 - Extended Employee Attributes Data

The Name field, below, must be an exact match to the Name of the attribute in the ARCOS System, otherwise, ARCOS may create a new Attribute.

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	205 Extended Employee Attribute Record - REQUIRED See description above.
	VRU-ID – Type N(11)	REQUIRED – NO Alphabetic characters
	Name of Qualification or Attribute – Type X(50)	Required; may come from the HR system
4.	Attr_Type – Type X(20)	Valid values: TEXT, VALUES, MULTIVALUES, NUMBER, DATE, TIME, CHECKBOX (these titles must be capitalized as in the examples above)
5.	Attr_Category – Type X(10)	Valid values: Std, Quals, Storm Role, etc.
6.	VALUE of the attribute – Type X(100)	The data value of the attribute named in (3) above. If the value is Yes or No only use Y or N.

***Use multiple records to provide ARCOS with multiple attributes for an employee.

SEA (System Emergency Attributes Data)

SEA stands for System Emergency Attributes. This file type is used to update employee extended attributes.

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	100 (Header Record) – REQUIRED See description above.
	Company Identifier – Type X(10)	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24 hour clock. Export date cannot be more than 6.75 days from load date. Seconds are optional.” in the 100 – Header/Trailer Record table field description and format sections
	Export Record Count – Type N	Total records not including headers

200 - Data Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N	REQUIRED: 200
	Employee ID – Type X	REQUIRED
	Employee First Name – Type X	REQUIRED
	Employee Last Name – Type X	REQUIRED
	SOS Target Device – Phone Number Home, Type N
	SOS Target Device – Phone Number Work, Type N
	SOS Target Device – Phone # Work Cell, Type N
	SOS Target Device – Phone # Personal Cell, Type N
	Email 1 Type X
	Email 2 Type X
	Email 3 Type X
	Extended Attribute – Type X	REQUIRED: Column 12 must be the first extended attribute. If not target devices are used, those columns will be blank and the first extended attribute will still be listed here. The data listed here MUST correspond with the first attribute listed in the Extended Attribute list in system admin.
	Extended Attribute – Type X	Optional: The data here MUST correspond to the second attribute listed in the Extended Attribute list in system admin.
	Extended Attribute – Type X	Optional: The data here MUST correspond to the third attribute listed in the Extended Attribute list in system admin.
	Extended Attribute – Type X	Optional: The data here MUST correspond to the fourth attribute listed in the Extended Attribute list in system admin.
	Extended Attribute – Type X	To load additional extended attributes, follow the model as outlined above.

ADDITIONAL NOTES:

There is no limit to the number of extended attributes that can be loaded.

Each new attribute column added file, must correspond to the order in which it is listed in the Extended Attribute list in system admin

The 100 record can be listed at the top or bottom. ARCOS will look for the 100 record type as the first or last record and process it correctly. It cannot be mixed within the 200 record rows.

If employees listed in the file do not exist in the ARCOS database, they will be added.

If the email is set to condensed mode, the extended attribute load removed the check box for condensed mode. The email will not receive the standard template. (The email is not disabled)

If an employee record has an email address that is not active, it will be set as active by the loader.

STARS (Employee Data, OT)

This file type is used by limited customers and is not recommended for implementation in any new instances. This file contains Employee Overtime data and is used to update overtime accruals.

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N	100 (Header Record) – REQUIRED See description above.
	Company Identifier – Type X	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24 hour clock.
	ARCOS Effective Date – Type N(14)	Format: MMDDYYYYHHMMSS (Seconds are optional) (24 Hr Clock in Eastern Time) *. Date / Time for hours to take effect in ARCOS
	Export Record Count – Type N(5)	Total records not including headers
	Pay Period Number – Type N(2)	This will vary from 1 to 26 during the year. When pay period 1 is received, all adjusted hours will be reset to 0.

200 - Data Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	REQUIRED: 200
	Employee ID – Type X(11)	REQUIRED
	Pay Code (Earnings Type) – Type X(3)	REQUIRED – Varies per company and OpCo
	Year to Date Hours – Type N(6)	REQUIRED Format 9999.99

ADDITIONAL NOTES: The 100 record can be listed at the top or bottom. ARCOS will look for the 100 record type as the first or last record and process it correctly. It cannot be mixed within the 200 record rows.

SHIPS (Employee Data, Demographics / Users)

This file type is used by limited customers and is not recommended for implementation in any new instances. This file contains Employee Overtime data and is used to update overtime accruals.

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N	100 (Header Record) – REQUIRED See description above.
	Company Identifier – Type X	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24 hour clock. – REQUIRED
	ARCOS Effective Date – Date / Time for hours to take effect in ARCOS – Type N(14)	NOT USED – Send a blank field to conform to the specification
	Export Record Count – Type N(5)	Total records not including headers – REQUIRED
	Pay Period Number – Type N(2)	This will vary from 1 to 26 during the year. When pay period 1 is received, all adjusted hours will be reset to 0. – REQUIRED

200 - Data Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	200 – REQUIRED
	Employee ID – Type X(11)	REQUIRED
	Emp_Net_Id – Type X(15)	REQUIRED – Referred to as NT ID
	Social Security Number – Type N(9)	Numeric No Dashes
	First Name – Type X(30)	REQUIRED – Names are stored in SHIPS in the format Last name Comma Space First name space middle name E.G. Smith, Tom Will need to parse SHIPS name into separate fields.
	Middle Initial – Type X(1)
	Last Name – Type X(30)	REQUIRED
	Nick Name – Type X(10)	Nick Name X(10)
	Union Seniority Date – Type N(8)	Format MMDDYYYY
	Service Date – Type N(8)	Format MMDDYYYY
	Job Classification Code – Type X(6)	REQUIRED
	Street 1 Address – Type X(55)
	Street 2 Address – Type X(55)
	City – Type X(30)
	State – Type X(6)
	Postal Zip Code – Type X(12)
	Location Code – Type X(10)	Only the first 7 characters will be used until we upgrade SHIPS. Then it is a possibility that all 10 characters can be used. – REQUIRED
	Birth Date – Type N(8)	Format MMDDYYYY

OTI (Overtime, YTD Hours)

OTI stands for Overtime Interface. OTI and OTI2 file types add and update overtime hours for employees. These file types are used to indicate that ARCOS would treat the hours in the file as a Year to Date (YTD) vs Daily hours, respectively.

ARCOS will calculate the number of OT hours which are effective by the effective date of the hours in the file.

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record – Type N(3)	100 (Header Record) See description above. – REQUIRED
	Company Identifier – Type X(3)	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24 hour clock. Export date cannot be more than 6.75 days from load date. – REQUIRED
	ARCOS Effective Date – Date / Time for hours to take effect in ARCOS – Type N(14)	Format: MMDDYYYYHHMMSS (Seconds are optional) (24 Hr Clock) – REQUIRED
	Export Record Count – Type N(5)	REQUIRED DOES NOT INCLUDE HEADER ROW IN COUNT TOTAL

200 - Data Record

Ref	Field Description and Type	Format and Notes
	Record – Type X(3)	200 Data Record – REQUIRED
	Emp_Id – Type X(11)	Usually 5 in length. Alpha Numeric. – REQUIRED
	Pay Code – Type X(can be of any length)	Typically ‘CUM HRS’ or ‘HRS Worked’ and ‘HRS Refused’ (with space in between words). If you will be using multiple paycodes please speak with your ARCOS Professional Services contact to verify. – REQUIRED
	Year to Date Hours – Type (10,2)	Summation of hours by earnings type. Format 9999.99 – REQUIRED

OTI2 (Overtime, Daily Hours)

ARCOS will calculate the number of OT hours which are effective by the effective date of the hours in the file.

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	100 (Header Record) See description above. – REQUIRED
	Company Identifier – Type X(3)	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24 hour clock. Export date cannot be more than 6.75 days from load date. – REQUIRED
	ARCOS Effective Date – Date / Time for hours to take effect in ARCOS – Type N(14)	Format: MMDDYYYYHHMMSS (Seconds are optional) (24 Hr Clock) – REQUIRED
	Export Record Count – Type N(5)	REQUIRED DOES NOT INCLUDE HEADER ROW IN COUNT TOTAL

201 - Data Record (YTD OT Values)

Ref	Field Description and Type	Format and Notes
	Record Type – Type X(3)	201 Data Record – REQUIRED
	Emp_Id – Type X(11)	Usually 5 in length. Alpha Numeric. – REQUIRED
	Pay Code – Type X(can be of any length)	Typically ‘CUM HRS’ or ‘HRS Worked’ and ‘HRS Refused’ (with space in between words). If you will be using multiple paycodes please speak with your ARCOS Professional Services contact to verify. – REQUIRED
	Daily Hours – Type N(10,2)	Hours for day for paycode. Format 9999.99 – REQUIRED
	Date of Daily Hours – Type N(8)	Format: MMDDYYYY – REQUIRED

202 - Data Record (YTD OT Values)

Ref	Field Description and Type	Format and Notes
	Record Type – Type X(3)	202 Data Record – REQUIRED
	Emp_Id – Type X(11)	Usually 5 in length. Alpha Numeric. – REQUIRED
	Pay Code – Type X(can be of any length)	Typically ‘CUM HRS’ or ‘HRS Worked’ and ‘HRS Refused’ (with space in between words). If you will be using multiple paycodes please speak with your ARCOS Professional Services contact to verify. – REQUIRED
	Year to Date Hours – Type (10,2)	Summation of hours by earnings type. Format 9999.99 – REQUIRED

SDI (Schedule Data)

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record – Type N(3)	100 (Header Record) See description above. – REQUIRED
	Company Identifier – Type X(3)	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type X(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24 hour clock. – REQUIRED
	Effective Date – Type X(8)	Format MMDDYYYY – REQUIRED
	Export Record Count – Type N(5)	Count of type 200 records – REQUIRED

ADDITIONAL NOTES:

Any Field not indicated as REQUIRED is be Optional.

Fields marked as “N/A” or ‘IF USED’ are either features currently not used by the customer or fields that have no bearing on this project. These fields should be left null in the load file. If data exists in these fields in the load file, it will be ignored during the load process.

At the start of each data load, ARCOS schedule data for the 14-day period starting with “Effective Date” will be purged from the ARCOS system, EXCEPT for any “protected” events. Speak with your ARCOS Representative if you need further information on your event configuration.

ARCOS will find records in the window based strictly on the START date/time of the record. I.e.: If an existing record starts yesterday and crosses midnight into today (or beyond), it will NOT be purged during the load.

ARCOS will ignore (and report as an error) any record with a start date prior to the effective date, or beyond the 14-day window end date.

For normal shift records – the TreatAs date in ARCOS will be determined using the Start Date/Time of the schedule record (only matters for shift records crossing midnight).

Field 6 of type ‘200’ rows will be stored in ARCOS as the Shift ReferAs value for the shift definition on the ARCOS Scheduler which will allow for visual representation of normal weekly shift assignments for employees. Only one value per week (Monday – Sunday) can be stored. If different shift names are sent in the ULT file for an employee that occur within the same effective week, errors will be logged and a ReferAs value will not be populated.

If a shift recorded is loaded in ARCOS by the ULT file and it lands on a day defined as a Holiday in ARCOS, by default that shift will be masked and the employee will be considered available for callout. Web Application users will have the responsibility of flagging the shift record in ARCOS as “Working Holiday” directly in ARCOS, if necessary.

200 – Data Record

Ref	Field Description and Type	Format and Notes
	Record – Type N(3)	200 Data Record - REQUIRED
	Emp_ID – Type X(11)	Alpha numeric - REQUIRED
	Event Start Date – Type X(12)	Format MMDDYYYYHHMM - REQUIRED
	Event End Date – Type X(12)	Format MMDDYYYYHHMM - REQUIRED
	Event Type – Type X(11)	Event type identifier – REQUIRED
	Shift Name – Type X(15)	ShiftID from database - To be used as ARCOS Shift ReferAs value if provided
	Shift Treat As – Type X(8)	Format MMDDYYYY

The field named ‘Shift TreatAs’ which exists at the end of the file will be used to indicate what the ‘Treat As’ date should be in ARCOS for the purpose of displaying the shift on the schedule. Currently, the ‘Treat As’ value is determined using the start date/time of each schedule record, as determined by the ‘Event Start Date’ field.

Examples to illustrate how the data will be depicted in the ARCOS schedule:

If this data is sent:

Ref	Field Description and Type	Value
	Record – Type N(3)	200
	Emp_Id – Type X(11)	123456
	Event Start Date – Type X(12)	090120142300
	Event End Date – Type X(14)	09022014070000
	Event Type – Type X(11)	1008
	Shift Name – Type X(15)
	Shift Treat As – Type X(8)	No data OR Treat As = Event Start Date

The shift will appear on the schedule as: (This is how the interface currently behaves)

If this data is sent:

Ref	Field Description and Type	Value
	Record – Type N(3)	200
	Emp_Id – Type X(11)	123456
	Event Start Date – Type X(14)	09012014230000
	Event End Date – Type X(14)	09022014070000
	Event Type – Type X(11)	108
	Shift Name – Type X(15)
	Shift TreatAs – Type X(8)	09022014

The shift will appear on the schedule as:

The ‘P’ indicates that the start time is actually on the previous date, which is 9/1 in this example.

Caveats

If the ‘Treat As’ field is not populated, the ‘Treat As’ date will be determined based on the start date/time of the schedule record as determined by the ‘Event Start Date’ field.
If the ‘Treat As’ field is populated, the ‘Treat As’ date cannot be more than 1 day in the future or 1 day in the past from the Event Start Date field in the schedule record.
If the date is invalid due to improper format or being more than 1 day removed from the Event Start Date, then the record will fail and be written into the failure file.

ULT (Schedule Data, Ultipro)

The ULT file type was developed to update ARCOS schedule records with information from the Ultipro scheduling system.

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	100 (Header Record) See description above. – REQUIRED
	Company Identifier – Type X(3)	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type X(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24-hour clock. – REQUIRED
	Effective Date – Type X(8)	Format MMDDYYYY – REQUIRED
	Export Record Count – Type N(5)	Count of type 200 records – REQUIRED

200 – Data Record

Ref	Field Description and Type	Format and Notes
	Record – Type N(3)	200 Data Record – REQUIRED
	Emp_Id – Type X(11)	REQUIRED
	Event Start Date – Type X(12)	Format MMDDYYYYHHMM – REQUIRED
	Event End Date – Type X(12)	Format MMDDYYYYHHMM – REQUIRED
	Event Type – Type X(11)	Event type identifier – REQUIRED
	Shift Name – Type X(15)	ShiftID from UltiPro To be used as ARCOS Shift ReferAs value

Notes: At the start of each data load, ARCOS schedule data for the 14-day period starting with “Effective Date” will be purged from the ARCOS system, EXCEPT for any “protected” events. Speak with your ARCOS Representative if you need further information on your event configuration.

ARCOS will ignore (and report as an error) any record with a start date prior to the effective date, or beyond the 14-day window end date.

For normal shift records – the TreatAs date in ARCOS will be determined using the Start Date/Time of the schedule record (only matters for shift records crossing midnight).

CML1 (Crew Manager Lodging)

The CM file types are for Crew Manager file loads through the Data Loader. These files are not used in the Data Import functionality within Crew Manager. These files need to be loaded using the Sys Admin > Loader functionality or Loader API methods.

The CML1 file is used to load Lodging data including the name, identified lodging attribute values, and capacity/room availability of each Hotel.

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	100 (Header Record) – REQUIRED See description above.
	Company Identifier – Type X(10)	[Customer Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS (Seconds are optional) Hours (HH) are 24 hour clock and seconds are optional. – REQUIRED
	Export Record Count – Type N	Total records not including headers – REQUIRED
	Logic Indicator – Type N	100 – This field is a place holder and must be populated with 100 at this time. – REQUIRED

ADDITIONAL NOTES:

Any Field not indicated as REQUIRED should be Optional.

101 – Column Names Record

The Column Names should be written as the second to the last record in the file; it will be used by ARCOS to match values provided the file with pre-configured attributes in Crew Manager. ARCOS will make a pass through the 101 record, and will validate that matching Crew Manager Work attributes have been configured. IF the 101 record and the number of values in the 200 record do not match, ARCOS will reject the file.

If the number of columns in the 101 and the 200 records match, but ARCOS does not find a matching Crew Manager Work attribute it will load the file, but will ignore any attributes that do not match configured Crew Manager Work attributes.

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	101 (Header Record) – REQUIRED See description above.
	Column Name – Type X	name (Must be entered in all lowercase to identify the Work Order name) – REQUIRED
	Column Name – Type X	[Crew Manager Attribute Name] – REQUIRED
	Column Name – Type X	[Crew Manager Attribute Name] – REQUIRED
	Column Name – Type X	Column names will continue until each Crew Manager attribute name to be included has been identified Column names must match the Crew Manager attribute name exactly. Case sensitive – REQUIRED

CMR1 (Crew Manager Resource Types)

The CMR1 file is used to upload Resource Types and the identified resource types' attribute values.

Record Descriptions

100 – Header/Trailer Record

The Header Record will be used by ARCOS for data integrity checking. ARCOS will make a first pass through the file counting the records and will then verify that the Header / Trailer record count is correct prior to processing the file. If the actual number of records in the file does not match the count stored in the header record, the file will not be processed and an error report will be created.

Ref	Field Description and Type	Format and Notes
	Record Type – Type N(3)	100 (Header Record) – REQUIRED See description above.
	Company Identifier – Type X	[Company Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(12)	Format MMDDYYYYHHMMSS Seconds are Optional Hours (HH) are 24 hour clock. – REQUIRED
	Export Record Count – Type N	Total records not including headers – REQUIRED
	Logic Indicator – Type N	100 – This field is a place holder and must be populated with 100 at this time. – REQUIRED
	Resource Name – Type X	This field must match the resource name exactly. Case sensitive. Example: If resource section called Vehicle, field must also contain Vehicle, If field input is vehicle or VEHICLE file load would fail. – REQUIRED

ADDITIONAL NOTES:

Any Field not indicated as REQUIRED should be Optional.

101 – Column Names Record

The Column Names should be written as the second to the last record in the file; it will be used by ARCOS to match values provided the file with pre-configured attributes in Crew Manager [GB7] . ARCOS will make a pass through the 101 record and will validate that matching attributes in the Crew Manager Resource Type (identified in 100 Record) have been created. IF the 101 record row attributes identified and the number of values separated by a delimiter in the 200 record do not match, ARCOS will reject the file.

If the number of columns in the 101 and the 200 records match, but ARCOS does not find a matching Crew Manager Resource Type attribute it will load the file, but will ignore any attributes that do not match configured Crew Manager Resource Type attributes.

The 101 record is limited to only identify thirty (30) values including the 101 record identifier and the Resource Type name

Ref	Field Description and Type	Format and Notes
	Record Type – Type N	101 (Header Record) – REQUIRED See description above.
	Resource Type Name – Type X	name (Must be entered in all lowercase to identify the Work Order name) – REQUIRED
	Resource Type Attribute Name – Type X	[Crew Manager Attribute Name] – REQUIRED
	Resource Type Attribute Name – Type X	[Crew Manager Attribute Name] – REQUIRED
	Resource Type Attribute Name – Type X	Column names will continue until each Crew Manager attribute name to be included has been identified Column names must match the Crew Manager attribute name exactly. Case sensitive – REQUIRED

CMW1 (Crew Manager Workorders)

The CMW1 file is used to add, update, or delete WorkOrder Resources and the identified WorkOrder attribute values in Crew Manager.

Record Descriptions

100 – Header/Trailer Record

Ref	Field Description and Type	Format and Notes
	Record Type – Type N	100 (Header Record) – REQUIRED See description above.
	Company Identifier – Type X	[Company Code] ARCOS Customer Company Acronym (Company SCHEMA) – REQUIRED
	Export Date and Time – Type N(14)	Format MMDDYYYYHHMMSS Seconds are Optional Hours (HH) are 24 hour clock. – REQUIRED
	Export Record Count – Type N	Total records not including headers – REQUIRED
	Logic Indicator – Type N	100 – REQUIRED Notes: This will be a numeric indicator of both the field mapping logic, as well as the logic for ADD, UPDATE and DELETE for the customer. ARCOS will overwrite ALL Workorder information if a WO ID already exists in ARCOS, and it is in the OPEN Status. ARCOS will not update anything if WO ID STATUS is = ASSIGNED, IN-PROGRESS, CLOSED

ADDITIONAL NOTES:

Any Field not indicated as REQUIRED should be Optional.

Fields marked as “N/A” or ‘IF USED’ are either features currently not used by [CUSTOMER] or fields that have no bearing on this project. These fields should be left null in the load file. If data exists in these fields in the load file, it will be ignored during the load process.[GB8]

Logic Indicator – your ARCOS Implementation Manager or Professional Services consultant will work with you on the logic indicator required for your file load. The Logic indicator provides ARCOS with information as to how your file is loaded, which fields are “Protected” from further CMW1 updates, which fields are updated, when records are added, when records are deleted, etc… Please note that the details of this requirement should be discussed with your ARCOS Implementation Manager or Professional Services Consultant, who may further review the request with ARCOS Engineering team.

101 – Column Names Record

The Column Names should be written as the second to the last record in the file; it will be used by ARCOS to match values provided the file with pre-configured attributes in Crew Manager. [GB9] ARCOS will make a pass through the 101 record, and will validate that matching Crew Manager Work attributes have been configured. IF the 101 record and the number of values in the 200 record do not match, ARCOS will reject the file.

Ref	Field Description and Type	Format and Notes
	Record Type – Type N	101 (Header Record) – REQUIRED See description above.
	Work Order Name – Type X	name (Must be entered in all lowercase to identify the Work Order name) – REQUIRED
	Column Name – Type X	[Crew Manager Attribute Name] – REQUIRED
	Column Name – Type X	[Crew Manager Attribute Name] – REQUIRED
	Column Name – Type X	Column names will continue until each Crew Manager Work Order attribute name to be included has been identified Column names must match the Crew Manager Work Order attribute name exactly. Case sensitive – REQUIRED

IEX (IEX Scheduling System)

The IEX file type was developed to update ARCOS schedule records with information from the IEX scheduling system. IEX files update schedule data and are primarily used by a single customer.

Please speak with an ARCOS Representative for this specification.

XML Schema Definitions (XSD)

The XSD provided in this section represents the data structures available within ARCOS. The entire XSD for your environment can be obtained by following the instructions in the Application – Supported Operations section.

Common Data Structures

statusList

<xs:complexType name="statusList">

<xs:sequence>

<xs:element name="status" type="opStatus" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

opStatus

<xs:complexType name="opStatus">

<xs:sequence />

<xs:attribute name="id" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="code" type="xs:int" use="required" />

<xs:attribute name="message" type="xs:string" />

</xs:complexType>

Description

The statusList of opStatus provides status information about the outcome of any data modification request.

Notes

The id attribute value will be set to the ID of the entity that was created or updated.

The code attribute value will typically be a ‘1’ on success and any other value to indicate an error or other information.

The message attribute value will provide feedback on the status of the operation. If an error occurred, this attribute value will usually contain a description of the problem. Example XML response indicating a malformed request was provided by the client:

Loader / Extract Data Structures

Extract

<xs:complexType name="extract">

<xs:sequence />

<xs:attribute name="name" type="xs:string" />

</xs:complexType>

<xs:complexType name="extractConfiguration">

<xs:sequence>

<xs:element name="schedule" type="extractSchedule" minOccurs="0" />

<xs:element name="properties" type="mapElementArray" minOccurs="0" />

</xs:sequence>

</xs:complexType>

extractSchedule

<xs:complexType name="extractSchedule">

<xs:sequence />

<xs:attribute name="minute" type="xs:int" use="required" />

<xs:attribute name="hour" type="xs:int" use="required" />

<xs:attribute name="dayOfMonth" type="xs:string" />

<xs:attribute name="month" type="xs:string" />

<xs:attribute name="dayOfWeek" type="xs:string" />

<xs:attribute name="nextRun" type="xs:string" />

</xs:complexType>

Row

<xs:complexType name="row">

<xs:sequence>

<xs:element ref="warning" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="type" type="xs:int" use="required" />

</xs:complexType>

Warning

<xs:complexType name="warning">

<xs:sequence />

<xs:attribute name="message" type="xs:string" />

<xs:attribute name="value" type="xs:string" />

<xs:attribute name="severity" type="xs:string" />

<xs:attribute name="columnId" type="xs:int" />

<xs:attribute name="title" type="xs:string" />

</xs:complexType>

loadDetail

<xs:complexType name="loadDetail">

<xs:sequence>

<xs:element name="data" type="xs:string" minOccurs="0" />

<xs:element name="warnings" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="warning" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="type" type="xs:string" />

<xs:attribute name="result" type="xs:string" />

</xs:complexType>

loadRequest

<xs:complexType name="loadRequest">

<xs:sequence>

<xs:element name="warnings" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="row" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="loadId" type="xs:int" use="required" />

<xs:attribute name="filename" type="xs:string" />

<xs:attribute name="type" type="xs:string" />

<xs:attribute name="runDate" type="xs:string" />

<xs:attribute name="dataRows" type="xs:int" use="required" />

<xs:attribute name="loadStatus" type="xs:string" />

</xs:complexType>

loadResult

<xs:complexType name="loadResult">

<xs:sequence />

<xs:attribute name="loadId" type="xs:int" use="required" />

<xs:attribute name="filename" type="xs:string" />

<xs:attribute name="type" type="xs:string" />

<xs:attribute name="date" type="xs:string" />

<xs:attribute name="loadedBy" type="xs:string" />

<xs:attribute name="dataRows" type="xs:int" use="required" />

<xs:attribute name="success" type="xs:int" use="required" />

<xs:attribute name="warning" type="xs:int" use="required" />

<xs:attribute name="failure" type="xs:int" use="required" />

<xs:attribute name="result" type="xs:string" />

</xs:complexType>

Callout Data Structures

Attempt

<xs:complexType name="attempt">

<xs:sequence>

<xs:element name="sequences" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="sequence" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="attempt" type="xs:int" />

</xs:complexType>

Roster

<xs:complexType name="roster">

<xs:sequence>

<xs:element name="location" type="attribute" minOccurs="0" />

<xs:element name="classification" type="attribute" minOccurs="0" />

<xs:element name="listStatus" type="attribute" minOccurs="0" />

<xs:element name="employees" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="employee" type="calloutEmployee" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

Attribute

<xs:complexType name="attribute">

<xs:sequence />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="value" type="xs:string" />

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="key" type="xs:string" />

<xs:attribute name="xwalk" type="xs:string" />

</xs:complexType>

Sequence

<xs:complexType name="sequence">

<xs:sequence>

<xs:element name="chainDelay" type="xs:int" minOccurs="0" />

<xs:element name="manualPopup" type="xs:boolean" />

<xs:element name="multiPosChunk" type="xs:int" minOccurs="0" />

<xs:element ref="roster" minOccurs="0" />

<xs:element name="displayName" type="xs:string" minOccurs="0" />

<xs:element name="callResults" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="callResult" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="seqDelays" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="seqDelay" type="callResult" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="sequence" type="xs:int" />

</xs:complexType>

calloutEmployee

<xs:complexType name="calloutEmployee">

<xs:sequence>

<xs:element name="callOrder" type="xs:int" />

<xs:element name="id" type="employeeId" minOccurs="0" />

<xs:element name="hriData" type="employee" minOccurs="0" />

<xs:element name="positionData" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="positionData" type="jsonObject" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

employeeId

<xs:complexType name="employeeId">

<xs:sequence>

<xs:element name="webId" type="xs:string" minOccurs="0" />

<xs:element name="vruId" type="xs:string" minOccurs="0" />

<xs:element name="emplId" type="xs:string" minOccurs="0" />

<xs:element name="name" type="xs:string" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" />

</xs:complexType>

callResult

<xs:complexType name="callResult">

<xs:sequence>

<xs:element name="resultName" type="xs:string" minOccurs="0" />

<xs:element name="userName" type="xs:string" minOccurs="0" />

<xs:element name="reason" type="xs:string" minOccurs="0" />

<xs:element name="primLocName" type="xs:string" minOccurs="0" />

<xs:element name="primClassName" type="xs:string" minOccurs="0" />

<xs:element name="contact" type="employeeId" minOccurs="0" />

<xs:element name="exceptionId" type="xs:int" minOccurs="0" />

<xs:element name="attemptSourceName" type="xs:string" minOccurs="0" />

<xs:element name="attemptDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="resultDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="coCallId" type="xs:int" minOccurs="0" />

<xs:element name="phoneNumber" type="xs:string" minOccurs="0" />

<xs:element name="callStart" type="xs:dateTime" minOccurs="0" />

<xs:element name="callEnd" type="xs:dateTime" minOccurs="0" />

<xs:element name="manualBypass" type="xs:string" minOccurs="0" />

<xs:element name="failed" type="xs:boolean" />

<xs:element name="contactOverride" type="xs:boolean" />

<xs:element name="cttInfo" type="xs:string" minOccurs="0" />

<xs:element name="inUseLabel" type="xs:string" minOccurs="0" />

<xs:element name="expDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="nonResponse" type="xs:boolean" />

<xs:element name="finalResult" type="xs:boolean" />

<xs:element name="addDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="coTypeName" type="xs:string" minOccurs="0" />

<xs:element name="amountName" type="xs:string" minOccurs="0" />

<xs:element name="ccResultName" type="xs:string" minOccurs="0" />

<xs:element name="chargeStatus" type="xs:string" minOccurs="0" />

<xs:element name="chargeDate" type="xs:dateTime" minOccurs="0" />

</xs:sequence>

<xs:attribute name="resultId" type="xs:int" />

<xs:attribute name="subCalloutId" type="xs:int" />

<xs:attribute name="attemptNumber" type="xs:int" />

<xs:attribute name="sequenceNumber" type="xs:int" />

<xs:attribute name="callOrder" type="xs:int" />

<xs:attribute name="subAttemptNumber" type="xs:string" />

</xs:complexType>

callDetail

<xs:complexType name="callDetail">

<xs:sequence>

<xs:element name="contactName" type="xs:string" minOccurs="0" />

<xs:element name="type" type="xs:string" minOccurs="0" />

<xs:element name="callStart" type="xs:string" minOccurs="0" />

<xs:element name="callEnd" type="xs:string" minOccurs="0" />

<xs:element name="duration" type="xs:string" minOccurs="0" />

<xs:element name="phoneNumber" type="xs:string" minOccurs="0" />

<xs:element name="host" type="xs:string" minOccurs="0" />

<xs:element name="channel" type="xs:string" minOccurs="0" />

<xs:element name="result" type="xs:string" minOccurs="0" />

<xs:element name="additionalDigits" type="xs:string" minOccurs="0" />

<xs:element name="callDial" type="xs:string" minOccurs="0" />

<xs:element name="timeRinging" type="xs:string" minOccurs="0" />

<xs:element name="recordingFound" type="xs:boolean" />

<xs:element name="failed" type="xs:boolean" />

<xs:element name="recordingURL" type="xs:string" minOccurs="0" />

<xs:element name="recordingURLWav" type="xs:string" minOccurs="0" />

<xs:element name="transferCallIds" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="transferCalls" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="digitsList" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="digits" type="digitsReceived" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="cloudStorage" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="cloudStorageInfo" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="callId" type="xs:int" />

</xs:complexType>

Callout

<xs:complexType name="callout">

<xs:sequence>

<xs:element name="calloutType" type="attribute" minOccurs="0" />

<xs:element name="description" type="xs:string" minOccurs="0" />

<xs:element name="location" type="attribute" minOccurs="0" />

<xs:element name="workStartDate" type="xs:string" minOccurs="0" />

<xs:element name="workEndDate" type="xs:string" minOccurs="0" />

<xs:element name="calloutReason" type="attribute" minOccurs="0" />

<xs:element name="troubleLoc" type="attribute" minOccurs="0" />

<xs:element name="creator" type="employeeId" minOccurs="0" />

<xs:element name="numberRequired" type="xs:int" minOccurs="0" />

<xs:element name="numberFilled" type="xs:int" minOccurs="0" />

<xs:element name="numberOfCalls" type="xs:int" minOccurs="0" />

<xs:element name="numberOfPeopleCalled" type="xs:int" minOccurs="0" />

<xs:element name="percentFilled" type="xs:int" minOccurs="0" />

<xs:element name="percentResponse" type="xs:int" minOccurs="0" />

<xs:element name="elapsedTime" type="xs:string" minOccurs="0" />

<xs:element name="owner" type="employeeId" minOccurs="0" />

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="overrides" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="override" type="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="qualifications" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="qualification" type="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="subCallouts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="subCallout" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="initiate" type="xs:boolean" />

</xs:complexType>

subCallout

<xs:complexType name="subCallout">

<xs:sequence>

<xs:element name="location" type="attribute" minOccurs="0" />

<xs:element name="classification" type="attribute" minOccurs="0" />

<xs:element name="currAtt" type="xs:int" minOccurs="0" />

<xs:element name="beingCalled" type="xs:int" minOccurs="0" />

<xs:element name="status" type="xs:int" minOccurs="0" />

<xs:element name="statusName" type="xs:string" minOccurs="0" />

<xs:element name="numberRequired" type="xs:int" minOccurs="0" />

<xs:element name="numberFilled" type="xs:int" minOccurs="0" />

<xs:element name="numberOfCalls" type="xs:int" minOccurs="0" />

<xs:element name="numberOfPeopleCalled" type="xs:int" minOccurs="0" />

<xs:element name="percentFilled" type="xs:int" minOccurs="0" />

<xs:element name="percentResponse" type="xs:int" minOccurs="0" />

<xs:element name="elapsedTime" type="xs:string" minOccurs="0" />

<xs:element name="defaultAction" type="xs:string" minOccurs="0" />

<xs:element name="alternateActions" type="xs:string" minOccurs="0" />

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="positions" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="position" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="attempts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="attempt" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="quantity" type="xs:int" use="required" />

</xs:complexType>

digitsReceived

<xs:complexType name="digitsReceived">

<xs:sequence />

<xs:attribute name="runningTime" type="xs:string" />

<xs:attribute name="digits" type="xs:string" />

</xs:complexType>

Position

<xs:complexType name="position">

<xs:sequence>

<xs:element name="additionalData">

<xs:complexType>

<xs:sequence>

<xs:element name="entry" minOccurs="0" maxOccurs="unbounded">

<xs:complexType>

<xs:sequence>

<xs:element name="key" minOccurs="0" type="xs:anyType" />

<xs:element name="value" minOccurs="0" type="xs:anyType" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="customerPositionId" type="xs:string" />

<xs:attribute name="positionTitle" type="xs:string" />

<xs:attribute name="quantity" type="xs:int" />

<xs:attribute name="workStartDate" type="xs:string" />

<xs:attribute name="workEndDate" type="xs:string" />

</xs:complexType>

calloutActivation

<xs:complexType name="calloutActivation">

<xs:sequence>

<xs:element name="calloutType" type="attribute" minOccurs="0" />

<xs:element name="status" type="attribute" minOccurs="0" />

<xs:element name="location" type="attribute" minOccurs="0" />

<xs:element name="positions" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="positions" type="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="activationLevel" type="xs:int" use="required" />

<xs:attribute name="calloutId" type="xs:int" use="required" />

</xs:complexType>

calloutAttribute

<xs:complexType name="calloutAttribute">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="attributeType" type="xs:string" />

<xs:attribute name="modifierType" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="fullDescription" type="xs:string" />

<xs:attribute name="activeDescription" type="xs:string" />

<xs:attribute name="valueDescription" type="xs:string" />

</xs:complexType>

calloutAttributeValue

<xs:complexType name="calloutAttributeValue">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="active" type="xs:string" />

<xs:attribute name="value" type="xs:string" />

</xs:complexType>

calloutResult

<xs:complexType name="calloutResult">

<xs:sequence>

<xs:element ref="callResult" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="coMainId" type="xs:int" />

</xs:complexType>

calloutSearchResult

<xs:complexType name="calloutSearchResult">

<xs:sequence>

<xs:element name="calloutType" type="attribute" minOccurs="0" />

<xs:element name="calloutReason" type="attribute" minOccurs="0" />

<xs:element name="workStartDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="strWorkStartDate" type="xs:string" minOccurs="0" />

<xs:element name="location" type="attribute" minOccurs="0" />

<xs:element name="subCallouts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="subCallout" type="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="createdBy" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

</xs:complexType>

calloutStat

<xs:complexType name="calloutStat">

<xs:sequence>

<xs:element name="coNumber" type="xs:int" minOccurs="0" />

<xs:element name="requestedNumber" type="xs:int" minOccurs="0" />

<xs:element name="filledNumber" type="xs:int" minOccurs="0" />

<xs:element name="callsNumber" type="xs:int" minOccurs="0" />

<xs:element name="peopleNumber" type="xs:int" minOccurs="0" />

<xs:element name="elapsed" type="xs:int" minOccurs="0" />

<xs:element name="elapsedRunning" type="xs:int" minOccurs="0" />

<xs:element name="arriveSec" type="xs:int" minOccurs="0" />

<xs:element name="arriveAcc" type="xs:int" minOccurs="0" />

<xs:element name="startTime" type="xs:string" minOccurs="0" />

<xs:element name="endTime" type="xs:string" minOccurs="0" />

<xs:element name="dispatchTime" type="xs:string" minOccurs="0" />

<xs:element name="enrouteTime" type="xs:string" minOccurs="0" />

<xs:element name="arrivalTime" type="xs:string" minOccurs="0" />

<xs:element name="updateResult" type="xs:string" minOccurs="0" />

</xs:sequence>

<xs:attribute name="coMainId" type="xs:int" />

<xs:attribute name="ticketId" type="xs:string" />

</xs:complexType>

Override

<xs:complexType name="override">

<xs:sequence>

<xs:element name="event" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="value" type="xs:string" />

</xs:complexType>

classReq

<xs:complexType name="classReq">

<xs:sequence />

<xs:attribute name="classId" type="xs:int" use="required" />

<xs:attribute name="className" type="xs:string" />

<xs:attribute name="quantity" type="xs:int" use="required" />

</xs:complexType>

coCrew

<xs:complexType name="coCrew">

<xs:sequence>

<xs:element name="requiredClasses" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="crewComponent" type="classReq" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

</xs:complexType>

calloutType

<xs:complexType name="calloutType">

<xs:sequence>

<xs:element name="category" type="attribute" minOccurs="0" />

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="attribute" type="calloutAttributeValue" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="overrides" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="override" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="templates" type="xs:int" />

<xs:element name="recording" type="xs:int" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

</xs:complexType>

coLookup

<xs:complexType name="coLookup">

<xs:sequence>

<xs:element name="classification" type="attribute" minOccurs="0" />

<xs:element name="location" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="order" type="xs:int" use="required" />

<xs:attribute name="enabled" type="xs:boolean" use="required" />

</xs:complexType>

Reason

<xs:complexType name="reason">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

</xs:complexType>

coRoster

<xs:complexType name="coRoster">

<xs:sequence>

<xs:element name="rosterSequences" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="sequence" type="rosterSequence" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="coLookupId" type="xs:int" use="required" />

<xs:attribute name="rosterId" type="xs:int" use="required" />

<xs:attribute name="rosterName" type="xs:string" />

<xs:attribute name="locationId" type="xs:int" use="required" />

<xs:attribute name="classId" type="xs:int" use="required" />

<xs:attribute name="className" type="xs:string" />

<xs:attribute name="listType" type="xs:string" />

<xs:attribute name="userId" type="xs:int" use="required" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

<xs:attribute name="listId" type="xs:int" use="required" />

</xs:complexType>

rosterSequence

<xs:complexType name="rosterSequence">

<xs:sequence>

<xs:element name="member" type="rosterEmployee" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="sequenceNumber" type="xs:int" use="required" />

</xs:complexType>

rosterEmployee

<xs:complexType name="rosterEmployee">

<xs:sequence />

<xs:attribute name="callOrder" type="xs:int" use="required" />

<xs:attribute name="contactName" type="xs:string" />

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="locationName" type="xs:string" />

<xs:attribute name="locationId" type="xs:int" use="required" />

</xs:complexType>

listStatus

<xs:complexType name="listStatus">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="restrict" type="xs:string" />

<xs:attribute name="exclusive" type="xs:string" />

<xs:attribute name="rank" type="xs:int" use="required" />

<xs:attribute name="primary" type="xs:boolean" use="required" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

</xs:complexType>

rosterList

<xs:complexType name="rosterList">

<xs:sequence>

<xs:element name="archives" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="archive" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

rosterPreference

<xs:complexType name="rosterPreference">

<xs:sequence>

<xs:element name="category" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="useStringValue" type="xs:boolean" use="required" />

<xs:attribute name="value" type="xs:string" />

<xs:attribute name="multiplier" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

</xs:complexType>

runRosterRulesRequest

<xs:complexType name="runRosterRulesRequest">

<xs:sequence>

<xs:element name="contactIds" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="contactId" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="rosterIds" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="rosterId" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="attrIds" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="attrId" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="runTest" type="xs:int" />

</xs:sequence>

</xs:complexType>

coContact

<xs:complexType name="coContact">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="order" type="xs:int" use="required" />

<xs:attribute name="previewId" type="xs:int" use="required" />

<xs:attribute name="processCoId" type="xs:int" use="required" />

</xs:complexType>

contactInfo

<xs:complexType name="contactInfo">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="nodeId" type="xs:int" use="required" />

<xs:attribute name="start" type="xs:string" />

<xs:attribute name="end" type="xs:string" />

<xs:attribute name="coId" type="xs:int" use="required" />

</xs:complexType>

Articles in this section

ARCOS API Documentation - Appendix

Appendix

Flat File Specifications

HRI (Human Resources / Employee Data)

HRI1 (Human Resources / Employee Data, Extended)

SEA (System Emergency Attributes Data)

STARS (Employee Data, OT)

SHIPS (Employee Data, Demographics / Users)

OTI (Overtime, YTD Hours)

OTI2 (Overtime, Daily Hours)

SDI (Schedule Data)

ULT (Schedule Data, Ultipro)

CML1 (Crew Manager Lodging)

CMR1 (Crew Manager Resource Types)

CMW1 (Crew Manager Workorders)

XML Schema Definitions (XSD)

Common Data Structures

Loader / Extract Data Structures

Callout Data Structures

Comments

Articles in this section

Appendix

Flat File Specifications

HRI (Human Resources / Employee Data)

HRI1 (Human Resources / Employee Data, Extended)

SEA (System Emergency Attributes Data)

STARS (Employee Data, OT)

SHIPS (Employee Data, Demographics / Users)

OTI (Overtime, YTD Hours)

OTI2 (Overtime, Daily Hours)

SDI (Schedule Data)

ULT (Schedule Data, Ultipro)

CML1 (Crew Manager Lodging)

CMR1 (Crew Manager Resource Types)

CMW1 (Crew Manager Workorders)

XML Schema Definitions (XSD)

Common Data Structures

Loader / Extract Data Structures

Callout Data Structures

Related articles