Accrual (INTERFACE_ACCRUAL) | |
---|---|
Type | 2000 |
Description | Interface event used to load Accrual data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1033 - Interface Accrual Validation |
Accrual (INTERFACE_ACCRUAL) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Balance Code | FI_BALANCE_CODE | yes | 0 | 40 | PERSON_BALANCE.BALANCE_CODE | Valid Values are those balance codes that exist in balance code table. | This is used to determine the balance code type of the record. This value must be provided or no record will be created. | |
Balance Year | FI_BALANCE_YEAR | yes | 0 | 40 | PERSON_BALANCE.BALANCE_YEAR | Format is yyyy. An example is 2010. | The Year of the balance value. | |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_BALANCE.PERSON_ID | This value must map to a valid person in the Person Table or no record will be created. | The person number. This value must be supplied or a record will not be created. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record is deleted from the database on passing the value as 'D'. | |
Applicable Date | FI_APPLICABLE_DATE | no | 0 | 20 | Current Date | Format is yyyyMMdd. For example, 99991231. This value only applies if smart update is set to 'Y' | This is used to find the record that needs to be updated based on the applicable date. | |
Balance Load Type | FI_BALANCE_LOAD_TYPE | no | 0 | 10 | The default value is blank. | Valid values are AVAILABLE, ALL | If set to ALL or blank the standard behavior applies. If set to AVAILABLE, then Set Earned Hours = Available balance sent from HR/Accrual system, Used Paid Hours = All the hours in the person_balance_transaction that have not yet been exported via payroll export. Used Unpaid_hours = Set to zero. | |
Balance Value | FI_BALANCE_VALUE | no | 0 | PERSON_BALANCE.BALANCE_VALUE | PERSON_BALANCE.CARRY_OVER_VALUE + PERSON_BALANCE.EARN_VALUE - PERSON_BALANCE.USED_PAID_VALUE - PERSON_BALANCE.USED_UNPAID_VALUE | Decimal value | The Amount of the balance value. The value is expected in Hours. | |
Carry Over Value | FI_CARRY_OVER_VALUE | no | 0 | PERSON_BALANCE.CARRY_OVER_VALUE | 0.0 | Decimal value | The Amount of the carry over value. The value is expected in Hours. | |
Create Balance Code | FI_CREATE_BALANCE_CODE | no | 0 | 1 | N | Valid values are 'Y' (Yes), or 'N' (No) | This is used to determine whether we create balance code or not, it is set to 'Y' in BCOMMPS. | |
Earn Value | FI_EARN_VALUE | no | 0 | PERSON_BALANCE.EARN_VALUE | 0.0 | Decimal value | The value of the earned amount. The value is expected in Hours. | |
End Date | FI_END_DATE | no | 0 | PERSON_BALANCE.END_DATE | 99991131 | Format is yyyyMMdd. For example, 20101231 | Person Balance End Date | |
Prior Period Only | FI_PRIOR_PERIOD_ONLY | no | 0 | 1 | Product specific, for Autotime, the default will be 'F'(False), for COSTPOINTSF, the default will be 'T'(True) | Valid values are 'F' (False), or 'T' (True) | ||
Process Name | FI_PROCESS_NAME | no | 0 | 40 | Product specific, for Autotime, the process name is PAYROLL_EXPORT, for COSTPOINTSF, the process name is LDMTIME_EXPORT, not required for BCOMM. | Valid values are based on process status definition | This value is used in the calculation of the accumulated used paid value when FI_BALANCE_LOAD_TYPE is set to AVAILABLE. For Autotime, it is PAYROLL_EXPORT. For CostpointSF, it is LDMTIME_EXPORT. | |
Rcd Num | FI_RCD_NUM | no | 0 | 40 | PERSON.RCD_NUM | This value must map to a valid person in the person table. | Used to identify the person. | |
Sender Name | FI_SENDER_NAME | no | 0 | 40 | The default value is whatever is specified for the sender name of the service parameter. | The name of the ERP | The sender name. | |
Start Date | FI_START_DATE | no | 0 | PERSON_BALANCE.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Person Balance Start Date | |
Unit | FI_UNIT | no | 0 | 6 | Hour. Only in PS the default is set to Second | Valid values are Hour, Minute or Second | Unit for the values. For the Balance Code when the Stored UOM is 'D' then the value is always stored in seconds by considering the unit. When the Stored UOM is 'O' then the value is stored without any conversion based on Unit. | |
Used Paid Value | FI_USED_PAID_VALUE | no | 0 | PERSON_BALANCE.USED_PAID_VALUE | 0.0 | Decimal value | The value of the used paid amount. The value is expected in Hours. | |
Used Unpaid Value | FI_USED_UNPAID_VALUE | no | 0 | PERSON_BALANCE.USED_UNPAID_VALUE | 0.0 | Decimal value | The value of the used unpaid amount. The value is expected in Hours. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Action (INTERFACE_ACTION) | |
---|---|
Type | 2000 |
Description | Interface event used to load Action data. |
Action (INTERFACE_ACTION) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Post Event Name | FI_POST_EVENT_NAME | yes | 0 | 40 | ACTION.EVENT_NAME | The event must be a valid event on the Event Form | Event to post | |
Badge Group | FI_BADGE_GROUP | no | 0 | 40 | ACTION.BADGE_NUM | Badge Group used to post the event | ||
Badge Num | FI_BADGE_NUM | no | 0 | 40 | ACTION.BADGE_NUM | Either the person num or the badge num is required | Badge Num used to post the event | |
Did | FI_DID | no | 0 | 40 | ACTION.DID | 8000 | Must be a valid terminal DID | DID used to post the event |
Gid | FI_GID | no | 0 | 40 | ACTION.GID | 8000 | Must be a valid terminal GID | GID used to post the event |
Hours | FI_HOURS | no | 0 | 40 | Hours used to post the event | |||
Interface Offline | FI_INTERFACE_OFFLINE | no | 0 | 40 | false | Valid Values are 'true' or 'false' | Used to determine if the interface has received an online or offline transaction | |
Is Offline Transaction | FI_IS_OFFLINE_TRANSACTION | no | 0 | 40 | N | Valid values are 'Y' (Yes), or 'N' (No) | Should event be posted in offline | |
Person Num | FI_PERSON_NUM | no | 0 | 40 | ACTION.PERSON_NUM | Either the person num or the badge num is required | Person Num used to post the event | |
Posting Type | FI_POSTING_TYPE | no | 0 | 40 | If no set or invalid, defaults to punched | Valid values are ELAPSED or PUNCHED | Posting Type used to post the event | |
Post Date | FI_POST_DATE | no | 0 | 40 | Defaults to new date | Datetime format yyyyMMddHHmmss | Post date used to post the event | |
Stage | FI_STAGE | no | 0 | 40 | ACTION.STAGE | Valid values are 'S' (Start), 'E' (End), 'N' (No Stage) or 'P' (Elapsed) | Stage used to post the event | |
Timestamp | FI_TIMESTAMP | no | 0 | 40 | ACTION.TIMESTAMP | Defaults to FI_POST_DATE | Datetime format yyyyMMddHHmmss | Timestamp used to post the event |
Timezone | FI_TIMEZONE | no | 0 | 40 | ACTION.TIMEZONE | Defaults to System Setting Timezone | Timezone used to post the event |
Activity (INTERFACE_ACTIVITY) | |
---|---|
Type | 2000 |
Description | Interface event used to load Activity data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1018 - Insert/Update Charge Element records |
Activity (INTERFACE_ACTIVITY) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Activity Num | FI_ACTIVITY_NUM | yes | 0 | 80 | CHARGE_ELEMENT_ACTIVITY.ACTIVITY_NUM | Activity Value | ||
Activity Type | FI_ACTIVITY_TYPE | yes | 0 | 40 | CHARGE_ELEMENT_ACTIVITY.ACTIVITY_TYPE | Activity types like PERSON, MACHINE etc. | ||
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_ELEMENT.CHARGE_TYPE | The default value will be derived from the specified level number. | This value must be a valid and active charge type in the Charge Type table or no record will be created | This value is used to map the charge type to the level number and element name supplied. This value must be supplied for charge element filtration purposes. |
Element Name | FI_ELEMENT_NAME | yes | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The default value will be derived from the specified charge type. | This value must be a valid element name in the Charge Type table or no record will be created | The Level is determined and set to 3 for element name of Activity. This value is used to map the element name to the charge type. This value must be supplied for a record to be created. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_VALUE | Each activity element must have a parent's level operation/order. | This value must be supplied for a record to be created. | |
Charge Element End Date | FI_CHARGE_ELEMENT_END_DATE | no | 0 | CHARGE_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Charge Element End Date | |
Charge Element Start Date | FI_CHARGE_ELEMENT_START_DATE | no | 0 | CHARGE_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Charge Element Start Date | |
Charge Filtration Group1 | FI_CHARGE_FILTRATION_GROUP1 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group2 | FI_CHARGE_FILTRATION_GROUP2 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group3 | FI_CHARGE_FILTRATION_GROUP3 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group4 | FI_CHARGE_FILTRATION_GROUP4 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group5 | FI_CHARGE_FILTRATION_GROUP5 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group End Date1 | FI_CHARGE_FILTRATION_GROUP_END_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date2 | FI_CHARGE_FILTRATION_GROUP_END_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date3 | FI_CHARGE_FILTRATION_GROUP_END_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date4 | FI_CHARGE_FILTRATION_GROUP_END_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date5 | FI_CHARGE_FILTRATION_GROUP_END_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group Start Date1 | FI_CHARGE_FILTRATION_GROUP_START_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date2 | FI_CHARGE_FILTRATION_GROUP_START_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date3 | FI_CHARGE_FILTRATION_GROUP_START_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date4 | FI_CHARGE_FILTRATION_GROUP_START_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date5 | FI_CHARGE_FILTRATION_GROUP_START_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | CHARGE_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Description | FI_DESCRIPTION | no | 0 | 80 | CHARGE_ELEMENT.DESCRIPTION | Description of the Activity | ||
Flex Field Name1 | FI_FLEX_FIELD_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name10 | FI_FLEX_FIELD_NAME10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME10 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name11 | FI_FLEX_FIELD_NAME11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME11 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name12 | FI_FLEX_FIELD_NAME12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME12 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name13 | FI_FLEX_FIELD_NAME13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME13 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name14 | FI_FLEX_FIELD_NAME14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME14 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name15 | FI_FLEX_FIELD_NAME15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME15 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name2 | FI_FLEX_FIELD_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name3 | FI_FLEX_FIELD_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name4 | FI_FLEX_FIELD_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name5 | FI_FLEX_FIELD_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name6 | FI_FLEX_FIELD_NAME6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name7 | FI_FLEX_FIELD_NAME7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME7 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name8 | FI_FLEX_FIELD_NAME8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME8 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name9 | FI_FLEX_FIELD_NAME9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME9 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Value1 | FI_FLEX_FIELD_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value10 | FI_FLEX_FIELD_VALUE10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE10 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value11 | FI_FLEX_FIELD_VALUE11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE11 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value12 | FI_FLEX_FIELD_VALUE12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE12 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value13 | FI_FLEX_FIELD_VALUE13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE13 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value14 | FI_FLEX_FIELD_VALUE14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE14 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value15 | FI_FLEX_FIELD_VALUE15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE15 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value2 | FI_FLEX_FIELD_VALUE2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value3 | FI_FLEX_FIELD_VALUE3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value4 | FI_FLEX_FIELD_VALUE4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value5 | FI_FLEX_FIELD_VALUE5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value6 | FI_FLEX_FIELD_VALUE6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value7 | FI_FLEX_FIELD_VALUE7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE7 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value8 | FI_FLEX_FIELD_VALUE8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE8 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value9 | FI_FLEX_FIELD_VALUE9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE9 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Hierarchy Name | FI_HIERARCHY_NAME | no | 0 | 40 | This value must be a valid hierarchy name in the Hierarchy table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Hierarchy Type | FI_HIERARCHY_TYPE | no | 0 | 40 | This must be a valid hierarchy type in the Hierarchy Type table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Labor Standard Basis | FI_LABOR_STANDARD_BASIS | no | 0 | 1 | Labor standard basis. Number of pieces that the standard references. Has to be >= 1.0 | |||
Labor Standard Hours | FI_LABOR_STANDARD_HOURS | no | 0 | 0 or Standard Amount if available | Labor standard for the operation activity which is stored in hours | |||
Labor Standard Per Piece | FI_LABOR_STANDARD_PER_PIECE | no | 0 | 0 | The time taken in hours to produce one piece based on the primary UOM | |||
Location Element Name | FI_LOCATION_ELEMENT_NAME | no | 0 | 80 | This value must be a valid element name in the Hierarchy Group Definition table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Location Element Value | FI_LOCATION_ELEMENT_VALUE | no | 0 | 80 | This value must be a valid element value in the Hierarchy Element table. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Parent Element Name | FI_PARENT_ELEMENT_NAME | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | OPERATION | Valid value is required for charge element that is higher than level 1. The valid element name of the operation that is the parent of the activity. | This value is used to specify the name of the parent of the charge element. In this case the parent is an operation. |
Parent Element Name1 | FI_PARENT_ELEMENT_NAME1 | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | ORDER | The valid parent name of the order that is the parent of the operation which in turn is the parent of the activity. | This value is used to specify the name of the parent of the charge element which is the parent of the activity. In this case refer to the operation. |
Parent Element Value | FI_PARENT_ELEMENT_VALUE | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.OPERATION_NUM | Valid value is required for charge element that is higher than level 1. The valid element value of the operation that is the parent of the activity. | This prompt is used to specify the value of the parent of the charge element. In this case the parent is an operation. | |
Parent Element Value1 | FI_PARENT_ELEMENT_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_ORDER.ORDER_NUM | The valid parent value of the order that is the parent of the operation which in turn is the parent of the activity. | This prompt is used to specify the name of the parent of the charge element which is the parent of the activity. In this case refer to the order. | |
Planned Hours | FI_PLANNED_HOURS | no | 0 | CHARGE_ELEMENT.PLANNED_HOURS | Planned hours for a charge element which is stored in hours | |||
Sender Name | FI_SENDER_NAME | no | 0 | 40 | CHARGE_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. | |
Setup Standard Hours | FI_SETUP_STANDARD_HOURS | no | 0 | 0 or Standard Amount if available | Setup standard for the operation which is stored in hours. It is the standard time it takes to setup the operation activity | |||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record status is set to Inactive on passing the value as 'D'. | |
Charge Filter Description1 | FI_CHARGE_FILTER_DESCRIPTION1 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description2 | FI_CHARGE_FILTER_DESCRIPTION2 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description3 | FI_CHARGE_FILTER_DESCRIPTION3 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description4 | FI_CHARGE_FILTER_DESCRIPTION4 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description5 | FI_CHARGE_FILTER_DESCRIPTION5 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Group Type1 | FI_CHARGE_FILTER_GROUP_TYPE1 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type2 | FI_CHARGE_FILTER_GROUP_TYPE2 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type3 | FI_CHARGE_FILTER_GROUP_TYPE3 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type4 | FI_CHARGE_FILTER_GROUP_TYPE4 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type5 | FI_CHARGE_FILTER_GROUP_TYPE5 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filtration Default Flag | FI_CHARGE_FILTRATION_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge filter element based on parent. |
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge element based on parent. |
Element Id | FI_ELEMENT_ID | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_ID | This is used to store the id of the element possibly from the ERP. | ||
Location Source | FI_LOCATION_SOURCE | no | 0 | 40 | CHARGE_ELEMENT.LOCATION_SOURCE | Valid Values are 'ADHOC' or 'HIERARCHY' | This is used to specify the source of the charge location. | |
Location Value | FI_LOCATION_VALUE | no | 0 | 80 | CHARGE_ELEMENT.LOCATION_VALUE | Value is required for Location Source of ADHOC. This is used to specify the location associated with the charge element. | ||
Organization Id | FI_ORGANIZATION_ID | no | 0 | This prompt is used to specify the organization Id | ||||
Record Status | FI_RECORD_STATUS | no | 0 | 1 | CHARGE_ELEMENT.RECORD_STATUS | If not supplied the default value is 'A'. | Valid values are 'A' (Active) and 'I' (Inactive). | The status of the charge element record. Cannot be used if inactive. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current charge element record. | |
Standards Flag | FI_STANDARDS_FLAG | no | 0 | 1 | ||||
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Points (INTERFACE_ATTENDANCE_POINTS) | |
---|---|
Type | 2000 |
Description | Interface event used to load Person Attendance Points. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1095 - Interface Attendance Points Validation |
Person Points (INTERFACE_ATTENDANCE_POINTS) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_POINTS.PERSON_NUM | This value must map to a valid person in the Person Table or no record will be created. | The person number. This value must be supplied or a record will not be created. | |
Points | FI_POINTS | yes | 0 | 10 | PERSON_POINTS.NET_POINTS | Numeric | Can be positive or negative. | |
Post Date | FI_POST_DATE | yes | 0 | PERSON_POINTS.POST_DATE | Format is yyyyMMdd | The post date of the transaction or manual change that posted the points. | ||
Event Name | FI_EVENT_NAME | no | 0 | 40 | PERSON_POINTS.EVENT_NAME | This value must map to a valid event when present. | Only present if it was a transaction that posted the points. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Charge Element (INTERFACE_CHARGE_ELEMENT) | |
---|---|
Type | 2000 |
Description | Interface event used to load Charge Element data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1018 - Insert/Update Charge Element records |
Charge Element (INTERFACE_CHARGE_ELEMENT) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_ELEMENT.CHARGE_TYPE | The default value will be derived from the specified level number. | This value must be a valid and active charge type in the Charge Type table or no record will be created | This value is used to map the charge type to the level number and element name supplied. This value must be supplied for charge element filtration purposes. |
Element Name | FI_ELEMENT_NAME | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_NAME | The default value will be derived from the specified charge type. | This value must be a valid element name in the Charge Type table or no record will be created | This value is used to map the element name to the charge type. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_VALUE | This value must be supplied for a record to be created. | ||
Sender Name | FI_SENDER_NAME | yes | 0 | 40 | CHARGE_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. | |
Certification | FI_CERTIFICATION | no | 0 | 40 | CHARGE_ELEMENT.CERTIFICATION | This value is used to determine if a person is certified to use the Charge Element, based on the person's 'CERTIFIED' person assignment. | ||
Charge Element End Date | FI_CHARGE_ELEMENT_END_DATE | no | 0 | CHARGE_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Charge Element End Date | |
Charge Element Group Name1 | FI_CHARGE_ELEMENT_GROUP_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_GROUP.DATA_GROUP_NAME | Charge Element Group Data Group Name. | ||
Charge Element Group Name2 | FI_CHARGE_ELEMENT_GROUP_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_GROUP.DATA_GROUP_NAME | Charge Element Group Data Group Name. | ||
Charge Element Group Name3 | FI_CHARGE_ELEMENT_GROUP_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_GROUP.DATA_GROUP_NAME | Charge Element Group Data Group Name. | ||
Charge Element Group Name4 | FI_CHARGE_ELEMENT_GROUP_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_GROUP.DATA_GROUP_NAME | Charge Element Group Data Group Name. | ||
Charge Element Group Name5 | FI_CHARGE_ELEMENT_GROUP_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_GROUP.DATA_GROUP_NAME | Charge Element Group Data Group Name. | ||
Charge Element Group Value1 | FI_CHARGE_ELEMENT_GROUP_VALUE1 | no | 0 | 80 | CHARGE_ELEMENT_GROUP.DATA_GROUP_VALUE | Charge Element Group Data Group Value. | ||
Charge Element Start Date | FI_CHARGE_ELEMENT_START_DATE | no | 0 | CHARGE_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Charge Element Start Date | |
Charge Filtration Group1 | FI_CHARGE_FILTRATION_GROUP1 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group2 | FI_CHARGE_FILTRATION_GROUP2 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group3 | FI_CHARGE_FILTRATION_GROUP3 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group4 | FI_CHARGE_FILTRATION_GROUP4 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group5 | FI_CHARGE_FILTRATION_GROUP5 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group End Date1 | FI_CHARGE_FILTRATION_GROUP_END_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date2 | FI_CHARGE_FILTRATION_GROUP_END_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date3 | FI_CHARGE_FILTRATION_GROUP_END_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date4 | FI_CHARGE_FILTRATION_GROUP_END_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date5 | FI_CHARGE_FILTRATION_GROUP_END_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group Start Date1 | FI_CHARGE_FILTRATION_GROUP_START_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date2 | FI_CHARGE_FILTRATION_GROUP_START_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date3 | FI_CHARGE_FILTRATION_GROUP_START_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date4 | FI_CHARGE_FILTRATION_GROUP_START_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date5 | FI_CHARGE_FILTRATION_GROUP_START_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | CHARGE_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Element Premium Amount1 | FI_ELEMENT_PREMIUM_AMOUNT1 | no | 0 | 40 | This value must be greater than or equal to zero | Premium amount, value is required for adding or modifying a Premium Type to the premium code represented by this charge element. | ||
Element Premium Amount2 | FI_ELEMENT_PREMIUM_AMOUNT2 | no | 0 | 40 | This value must be greater than or equal to zero | Premium amount, value is required for adding or modifying a Premium Type to the premium code represented by this charge element. | ||
Element Premium Amount3 | FI_ELEMENT_PREMIUM_AMOUNT3 | no | 0 | 40 | This value must be greater than or equal to zero | Premium amount, value is required for adding or modifying a Premium Type to the premium code represented by this charge element. | ||
Element Premium Amount4 | FI_ELEMENT_PREMIUM_AMOUNT4 | no | 0 | 40 | This value must be greater than or equal to zero | Premium amount, value is required for adding or modifying a Premium Type to the premium code represented by this charge element. | ||
Element Premium Amount5 | FI_ELEMENT_PREMIUM_AMOUNT5 | no | 0 | 40 | This value must be greater than or equal to zero | Premium amount, value is required for adding or modifying a Premium Type to the premium code represented by this charge element. | ||
Element Premium End Date1 | FI_ELEMENT_PREMIUM_END_DATE1 | no | 0 | If not supplied the default is the infinity date. | This value must be equal to or after the start date | Premium End Date | ||
Element Premium End Date2 | FI_ELEMENT_PREMIUM_END_DATE2 | no | 0 | If not supplied the default is the infinity date. | This value must be equal to or after the start date | Premium End Date | ||
Element Premium End Date3 | FI_ELEMENT_PREMIUM_END_DATE3 | no | 0 | If not supplied the default is the infinity date. | This value must be equal to or after the start date | Premium End Date | ||
Element Premium End Date4 | FI_ELEMENT_PREMIUM_END_DATE4 | no | 0 | If not supplied the default is the infinity date. | This value must be equal to or after the start date | Premium End Date | ||
Element Premium End Date5 | FI_ELEMENT_PREMIUM_END_DATE5 | no | 0 | If not supplied the default is the infinity date. | This value must be equal to or after the start date | Premium End Date | ||
Element Premium Rate Name1 | FI_ELEMENT_PREMIUM_RATE_NAME1 | no | 0 | 40 | This value must be a valid premium name(permium type) or a valid job code(rate type) in the Charge Element Premium Type table | Used to add/update 1st rate in charge element premium rate Table for the charge element. Premium Name, value is required for adding or modifying a premium code/job code represented by this charge element. For a Job code if the value is empty then no record is added | ||
Element Premium Rate Name2 | FI_ELEMENT_PREMIUM_RATE_NAME2 | no | 0 | 40 | This value must be a valid premium name(permium type) or a valid job code(rate type) in the Charge Element Premium Type table | Used to add/update 2nd rate in charge element premium rate Table for the charge element. For a Premium code/Job code if the value is empty then no record is added | ||
Element Premium Rate Name3 | FI_ELEMENT_PREMIUM_RATE_NAME3 | no | 0 | 40 | This value must be a valid premium name(permium type) or a valid job code(rate type) in the Charge Element Premium Type table | Used to add/update 3nd rate in charge element premium rate Table for the charge element. For a Premium code/Job code if the value is empty then no record is added | ||
Element Premium Rate Name4 | FI_ELEMENT_PREMIUM_RATE_NAME4 | no | 0 | 40 | This value must be a valid premium name(permium type) or a valid job code(rate type) in the Charge Element Premium Type table | Used to add/update 4th rate in charge element premium rate Table for the charge element. For a Premium code/Job code if the value is empty then no record is added | ||
Element Premium Rate Name5 | FI_ELEMENT_PREMIUM_RATE_NAME5 | no | 0 | 40 | This value must be a valid premium name(permium type) or a valid job code(rate type) in the Charge Element Premium Type table | Used to add/update 5th rate in charge element premium rate Table for the charge element. For a Premium code/Job code if the value is empty then no record is added | ||
Element Premium Start Date1 | FI_ELEMENT_PREMIUM_START_DATE1 | no | 0 | If not supplied the default is today. | This value must be before or equal to the end date | Premium Start Date | ||
Element Premium Start Date2 | FI_ELEMENT_PREMIUM_START_DATE2 | no | 0 | If not supplied the default is today. | This value must be before or equal to the end date | Premium Start Date | ||
Element Premium Start Date3 | FI_ELEMENT_PREMIUM_START_DATE3 | no | 0 | If not supplied the default is today. | This value must be before or equal to the end date | Premium Start Date | ||
Element Premium Start Date4 | FI_ELEMENT_PREMIUM_START_DATE4 | no | 0 | If not supplied the default is today. | This value must be before or equal to the end date | Premium Start Date | ||
Element Premium Start Date5 | FI_ELEMENT_PREMIUM_START_DATE5 | no | 0 | If not supplied the default is today. | This value must be before or equal to the end date | Premium Start Date | ||
Flex Field Name1 | FI_FLEX_FIELD_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name10 | FI_FLEX_FIELD_NAME10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME10 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name11 | FI_FLEX_FIELD_NAME11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME11 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name12 | FI_FLEX_FIELD_NAME12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME12 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name13 | FI_FLEX_FIELD_NAME13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME13 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name14 | FI_FLEX_FIELD_NAME14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME14 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name15 | FI_FLEX_FIELD_NAME15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME15 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name2 | FI_FLEX_FIELD_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name3 | FI_FLEX_FIELD_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name4 | FI_FLEX_FIELD_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name5 | FI_FLEX_FIELD_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name6 | FI_FLEX_FIELD_NAME6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name7 | FI_FLEX_FIELD_NAME7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME7 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name8 | FI_FLEX_FIELD_NAME8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME8 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name9 | FI_FLEX_FIELD_NAME9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME9 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Value1 | FI_FLEX_FIELD_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value10 | FI_FLEX_FIELD_VALUE10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE10 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value11 | FI_FLEX_FIELD_VALUE11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE11 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value12 | FI_FLEX_FIELD_VALUE12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE12 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value13 | FI_FLEX_FIELD_VALUE13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE13 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value14 | FI_FLEX_FIELD_VALUE14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE14 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value15 | FI_FLEX_FIELD_VALUE15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE15 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value2 | FI_FLEX_FIELD_VALUE2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value3 | FI_FLEX_FIELD_VALUE3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value4 | FI_FLEX_FIELD_VALUE4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value5 | FI_FLEX_FIELD_VALUE5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value6 | FI_FLEX_FIELD_VALUE6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value7 | FI_FLEX_FIELD_VALUE7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE7 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value8 | FI_FLEX_FIELD_VALUE8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE8 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value9 | FI_FLEX_FIELD_VALUE9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE9 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Hierarchy Name | FI_HIERARCHY_NAME | no | 0 | 40 | This value must be a valid hierarchy name in the Hierarchy table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Hierarchy Type | FI_HIERARCHY_TYPE | no | 0 | 40 | This must be a valid hierarchy type in the Hierarchy Type table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Level Num | FI_LEVEL_NUM | no | 0 | CHARGE_ELEMENT_TYPE.LEVEL_NUM | 0 | This value must be a valid level number in the Charge Element Type table or no record will be created | This is used to specify the level of the element. This value will only be used for charge elements with the charge_type.dynamic_element_flag value set to 1 | |
Location Element Name | FI_LOCATION_ELEMENT_NAME | no | 0 | 80 | This value must be a valid element name in the Hierarchy Group Definition table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Location Element Value | FI_LOCATION_ELEMENT_VALUE | no | 0 | 80 | This value must be a valid element value in the Hierarchy Element table. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Operation Quantity Planned | FI_OPERATION_QUANTITY_PLANNED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_PLANNED | Quantity that is planned for the operation. | |||
Order Quantity Planned | FI_ORDER_QUANTITY_PLANNED | no | 0 | CHARGE_ELEMENT_ORDER.QUANTITY_PLANNED | Quantity planned to be produced for the order. Equivalent to order quantity or scheduled quantity | |||
Planned Hours | FI_PLANNED_HOURS | no | 0 | CHARGE_ELEMENT.PLANNED_HOURS | Planned hours for a charge element which is stored in hours | |||
Start Date1 | FI_START_DATE1 | no | 0 | CHARGE_ELEMENT_GROUP.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Element Group Start Date | |
Start Date2 | FI_START_DATE2 | no | 0 | CHARGE_ELEMENT_GROUP.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Element Group Start Date | |
Start Date3 | FI_START_DATE3 | no | 0 | CHARGE_ELEMENT_GROUP.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Element Group Start Date | |
Start Date4 | FI_START_DATE4 | no | 0 | CHARGE_ELEMENT_GROUP.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Element Group Start Date | |
Start Date5 | FI_START_DATE5 | no | 0 | CHARGE_ELEMENT_GROUP.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Element Group Start Date | |
Work Center | FI_WORK_CENTER | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.WORK_CENTER | The department code or work center. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record status is set to Inactive on passing the value as 'D'. | |
Charge Element Group Value2 | FI_CHARGE_ELEMENT_GROUP_VALUE2 | no | 0 | 80 | CHARGE_ELEMENT_GROUP.DATA_GROUP_VALUE | Charge Element Group Data Group Value. | ||
Charge Element Group Value3 | FI_CHARGE_ELEMENT_GROUP_VALUE3 | no | 0 | 80 | CHARGE_ELEMENT_GROUP.DATA_GROUP_VALUE | Charge Element Group Data Group Value. | ||
Charge Element Group Value4 | FI_CHARGE_ELEMENT_GROUP_VALUE4 | no | 0 | 80 | CHARGE_ELEMENT_GROUP.DATA_GROUP_VALUE | Charge Element Group Data Group Value. | ||
Charge Element Group Value5 | FI_CHARGE_ELEMENT_GROUP_VALUE5 | no | 0 | 80 | CHARGE_ELEMENT_GROUP.DATA_GROUP_VALUE | Charge Element Group Data Group Value. | ||
Charge Element Operation Flag | FI_CHARGE_ELEMENT_OPERATION_FLAG | no | 0 | |||||
Charge Filter Description1 | FI_CHARGE_FILTER_DESCRIPTION1 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description2 | FI_CHARGE_FILTER_DESCRIPTION2 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description3 | FI_CHARGE_FILTER_DESCRIPTION3 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description4 | FI_CHARGE_FILTER_DESCRIPTION4 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description5 | FI_CHARGE_FILTER_DESCRIPTION5 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Group Type1 | FI_CHARGE_FILTER_GROUP_TYPE1 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type2 | FI_CHARGE_FILTER_GROUP_TYPE2 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type3 | FI_CHARGE_FILTER_GROUP_TYPE3 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type4 | FI_CHARGE_FILTER_GROUP_TYPE4 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type5 | FI_CHARGE_FILTER_GROUP_TYPE5 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filtration Default Flag | FI_CHARGE_FILTRATION_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge filter element based on parent. |
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge element based on parent. |
Description | FI_DESCRIPTION | no | 0 | 80 | CHARGE_ELEMENT.DESCRIPTION | Description of the Charge Element | ||
Element Id | FI_ELEMENT_ID | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_ID | This is used to store the id of the element possibly from the ERP. | ||
Location Source | FI_LOCATION_SOURCE | no | 0 | 40 | CHARGE_ELEMENT.LOCATION_SOURCE | Valid Values are 'ADHOC' or 'HIERARCHY' | This is used to specify the source of the charge location. | |
Location Value | FI_LOCATION_VALUE | no | 0 | 80 | CHARGE_ELEMENT.LOCATION_VALUE | Value is required for Location Source of ADHOC. This is used to specify the location associated with the charge element. | ||
Parent Element Name | FI_PARENT_ELEMENT_NAME | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The name of the charge element at the specific level | ||
Parent Element Name1 | FI_PARENT_ELEMENT_NAME1 | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The name of the charge element at the specific level | ||
Parent Element Name2 | FI_PARENT_ELEMENT_NAME2 | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The name of the charge element at the specific level | ||
Parent Element Name3 | FI_PARENT_ELEMENT_NAME3 | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The name of the charge element at the specific level | ||
Parent Element Name4 | FI_PARENT_ELEMENT_NAME4 | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The name of the charge element at the specific level | ||
Parent Element Value | FI_PARENT_ELEMENT_VALUE | no | 0 | 80 | CHARGE_ELEMENT_ELEMENT_VALUE | The value of the charge element at the specific level | ||
Parent Element Value1 | FI_PARENT_ELEMENT_VALUE1 | no | 0 | CHARGE_ELEMENT_ELEMENT_VALUE | The value of the charge element at the specific level | |||
Parent Element Value2 | FI_PARENT_ELEMENT_VALUE2 | no | 0 | 80 | CHARGE_ELEMENT_ELEMENT_VALUE | The value of the charge element at the specific level | ||
Parent Element Value3 | FI_PARENT_ELEMENT_VALUE3 | no | 0 | 80 | CHARGE_ELEMENT_ELEMENT_VALUE | The value of the charge element at the specific level | ||
Parent Element Value4 | FI_PARENT_ELEMENT_VALUE4 | no | 0 | 80 | CHARGE_ELEMENT_ELEMENT_VALUE | The value of the charge element at the specific level | ||
Quantity Available | FI_QUANTITY_AVAILABLE | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_AVAILABLE | The quantity that is available to move | |||
Record Status | FI_RECORD_STATUS | no | 0 | 1 | CHARGE_ELEMENT.RECORD_STATUS | If not supplied the default value is 'A'. | Valid values are 'A' (Active) and 'I' (Inactive). | The status of the charge element record. Cannot be used if inactive. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current charge element record. | |
Work Center Group | FI_WORK_CENTER_GROUP | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.WORK_CENTER_GROUP | The department or work center group. | ||
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Charge Filtration (INTERFACE_CHARGE_FILTRATION) | |
---|---|
Type | 2000 |
Description | This interface populate Charge Filtration. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1092 - Insert/Update Charge Filtration records |
Charge Filtration (INTERFACE_CHARGE_FILTRATION) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Charge Filter Name | FI_CHARGE_FILTER_NAME | yes | 0 | 80 | CHARGE_FILTER.CHARGE_FILTER_NAME | Used to add the charge filter name in charge filter and charge filter element type tables. | ||
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_TYPE | Description of the charge filter | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the charge filtration. The only values that are updated are default flag, start date and end date. The record is deleted from the database on passing the value as 'D' for charge filter, charge filter element type and charge filter element tables. | |
All Charge Filter Element Flag | FI_ALL_CHARGE_FILTER_ELEMENT_FLAG | no | 0 | 1 | 0 | Valid values are '0' or '1' | This prompt value of 1 indicates to consider all the parent charge types for the given charge type. | |
All Charge Filter Element Type Flag | FI_ALL_CHARGE_FILTER_ELEMENT_TYPE_FLAG | no | 0 | 1 | 0 | Valid values are '0' or '1' | This prompt value of 1 indicates to consider all the charge types for the given charge type. | |
Charge Filter Description | FI_CHARGE_FILTER_DESCRIPTION | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Group Type | FI_CHARGE_FILTER_GROUP_TYPE | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Create Filter Flag | FI_CREATE_FILTER_FLAG | no | 0 | 1 | 0 | Valid values are '0' or '1' | This field value of 1 indicates to create a charge filter if it does not exist. If the value is 0 and no charge filter exists then it errors out | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | SYSTEM | This prompt is used to specify the Data Group Name. It is used to determine the Element Value for Charge Filter Element. | ||
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | 0 | Valid values are '0' or '1' | This prompt value is used to represent if the record is the default record. |
Element Name | FI_ELEMENT_NAME | no | 0 | 40 | Value should be a valid element in Charge Type Element. Should be a valid Element Name in Charge Element | Value is required when the FI_ALL_CHARGE_FILTER_ELEMENT_TYPE_FLAG value is set to 0 (Not ALL). It is used to determine/store the Element Value for Charge Filter Element and Element Name in Charge Filter Element Type. | ||
Element Value | FI_ELEMENT_VALUE | no | 0 | 80 | Should be a valid Element Value in Charge Element | Value is required when the FI_ALL_CHARGE_FILTER_ELEMENT_FLAG value is set to 0 (Not ALL). It is used to determine/store the Element Value for Charge Filter Element. | ||
End Date | FI_END_DATE | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 99991231 | This prompt value is used to populate the end date for Charge Filter Element. | |
Level Diff | FI_LEVEL_DIFF | no | 0 | 1 | CHARGE_FILTER_ELEMENT.LEVEL_DIFF | 0 | Valid values are '0' or '1' | Value is stored in Charge Filter Element. |
Parent Element Name | FI_PARENT_ELEMENT_NAME | no | 0 | 40 | Should be a valid Element Name in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Name1 | FI_PARENT_ELEMENT_NAME1 | no | 0 | 40 | Should be a valid Element Name in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Name2 | FI_PARENT_ELEMENT_NAME2 | no | 0 | 40 | Should be a valid Element Name in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Name3 | FI_PARENT_ELEMENT_NAME3 | no | 0 | 40 | Should be a valid Element Name in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Name4 | FI_PARENT_ELEMENT_NAME4 | no | 0 | 40 | Should be a valid Element Name in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Value | FI_PARENT_ELEMENT_VALUE | no | 0 | 80 | Should be a valid Element Value in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Value1 | FI_PARENT_ELEMENT_VALUE1 | no | 0 | 80 | Should be a valid Element Value in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Value2 | FI_PARENT_ELEMENT_VALUE2 | no | 0 | 80 | Should be a valid Element Value in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Value3 | FI_PARENT_ELEMENT_VALUE3 | no | 0 | 80 | Should be a valid Element Value in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Parent Element Value4 | FI_PARENT_ELEMENT_VALUE4 | no | 0 | 80 | Should be a valid Element Value in Charge Element at the specified level | The value of the charge element at the specific level. It is used to determine the Element Value for Charge Filter Element. | ||
Sender Name | FI_SENDER_NAME | no | 0 | 40 | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. It is used to determine the Element Value for Charge Filter Element. | ||
Start Date | FI_START_DATE | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 19700101 | This prompt value is used to populate the start date for Charge Filter Element. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Delegation (INTERFACE_DELEGATION) | |
---|---|
Type | 2000 |
Description | Interface event used to load Delegation data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 100016 - Insert/Update Delegation records |
Delegation (INTERFACE_DELEGATION) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Delegated Manager Num | FI_DELEGATED_MANAGER_NUM | yes | 0 | 40 | DELEGATION.DELEGATED_MANAGER_ID | This must be a valid person in Person table or no record will be created. | This value must be provided or a record will not be created. | |
Delegation Type | FI_DELEGATION_TYPE | yes | 0 | 40 | DELEGATION.DELEGATION_TYPE | ALL | Valid Values are 'ALL','DIRECT','GROUP','HIERARCHY','PERSON' | For DIRECT - the Person Group has to be an existing group of Direct Manager Type, GROUP - the Person Group has to be an existing group of Supervisor Manager Type, HIERARCHY - the Person Group has to be an existing group of Hierarchy Type, PERSON - Existing Person. |
Manager Num | FI_MANAGER_NUM | yes | 0 | 40 | DELEGATION.MANAGER_ID | This must be a valid person in Person table or no record will be created. | Person who gets the responsibility to manage the group. This value must be provided or a record will not be created. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record is deleted from the database on passing the value as 'D'. Only future delegations(greater than current date) can be deleted. On Update Enabled Flag is the only field value that can be modified. | |
Enabled Flag | FI_ENABLED_FLAG | no | 0 | 1 | DELEGATION.ENABLED_FLAG | 1 | Valid Values are '0' for Disabled and '1' for Enabled. | This field indicates the record status of Enabled/Disabled. The field is updated only when value is set. |
End Date | FI_END_DATE | no | 0 | DELEGATION.END_DATE | Current Date | Format is yyyyMMdd. For example, 19700101 | Effective end date for delegation | |
Hierarchy Name | FI_HIERARCHY_NAME | no | 0 | 40 | DELEGATION.HIERARCHY_NAME | This must be a valid hierarchy name or no record will be created. | This value must be provided or a record will not be created. | |
Hierarchy Type | FI_HIERARCHY_TYPE | no | 0 | 40 | DELEGATION.HIERARCHY_TYPE | This must be a valid hierarchy type or no record will be created. | Value is required only for Delegation Type Hierarchy. | |
Parent Element Value1 | FI_PARENT_ELEMENT_VALUE1 | no | 0 | 40 | If the level number of the hierarchy element is 1 then this field should be supplied specifying the parent at level 0 for the Hierarchy managed by Manager Num. | Value is required only for Delegation Type - Hierarchy. This value is used to specify the value of the parent of the hierarchy element of level 1. Value is not required if there is no parent element for that level. | ||
Parent Element Value2 | FI_PARENT_ELEMENT_VALUE2 | no | 0 | 40 | If the level number of the hierarchy element is 2 then this field should be supplied specifying the parent at level 1 for the Hierarchy managed by Manager Num. | Value is required only for Delegation Type - Hierarchy. This value is used to specify the value of the parent of the hierarchy element of level 2. Value is not required if there is no parent element for that level. | ||
Parent Element Value3 | FI_PARENT_ELEMENT_VALUE3 | no | 0 | 40 | If the level number of the hierarchy element is 3 then this field should be supplied specifying the parent at level 2 for the Hierarchy managed by Manager Num. | Value is required only for Delegation Type - Hierarchy. This value is used to specify the value of the parent of the hierarchy element of level 3. Value is not required if there is no parent element for that level. | ||
Parent Element Value4 | FI_PARENT_ELEMENT_VALUE4 | no | 0 | 40 | If the level number of the hierarchy element is 4 then this field should be supplied specifying the parent at level 3 for the Hierarchy managed by Manager Num. | Value is required only for Delegation Type - Hierarchy. This value is used to specify the value of the parent of the hierarchy element of level 4. Value is not required if there is no parent element for that level. | ||
Person Group Name | FI_PERSON_GROUP_NAME | no | 0 | 40 | DELEGATION.PERSON_GROUP_ID | Value is required for Delegation Type - GROUP, HIERARCHY. If supplied it should map to a valid person group id. | The person group that will be delegated. | |
Person Num | FI_PERSON_NUM | no | 0 | 40 | DELEGATION.PERSON_ID | Person Num should be a valid Person and the corresponding Person ID will be stored. | Person Number value is required only for the Delegation Type of Person. | |
Start Date | FI_START_DATE | no | 0 | DELEGATION.START_DATE | Current Date | Format is yyyyMMdd. For example, 19700101 | Effective start date for delegation |
Department (INTERFACE_DEPARTMENT) | |
---|---|
Type | 2000 |
Description | Interface event used to load Department data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1018 - Insert/Update Charge Element records |
Department (INTERFACE_DEPARTMENT) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_ELEMENT.CHARGE_TYPE | The default value will be derived from the specified level number. | This value must be a valid and active charge type in the Charge Type table or no record will be created | This value is used to map the charge type to the level number and element name supplied. This value must be supplied for charge element filtration purposes. |
Element Name | FI_ELEMENT_NAME | yes | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The default value will be derived from the specified charge type. | This value must be a valid element name in the Charge Type table or no record will be created | This value is used to map the element name to the charge type. This value must be supplied for a record to be created. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_VALUE | Each new element must have a parent's lev | This value must be supplied for a record to be created. | |
Charge Element End Date | FI_CHARGE_ELEMENT_END_DATE | no | 0 | CHARGE_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Charge Element End Date | |
Charge Element Start Date | FI_CHARGE_ELEMENT_START_DATE | no | 0 | CHARGE_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Charge Element Start Date | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | CHARGE_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Department Code | FI_DEPARTMENT_CODE | no | 0 | 40 | ||||
Description | FI_DESCRIPTION | no | 0 | 80 | CHARGE_ELEMENT.DESCRIPTION | Description of the Department | ||
Flex Field Name1 | FI_FLEX_FIELD_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name10 | FI_FLEX_FIELD_NAME10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME10 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name11 | FI_FLEX_FIELD_NAME11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME11 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name12 | FI_FLEX_FIELD_NAME12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME12 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name13 | FI_FLEX_FIELD_NAME13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME13 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name14 | FI_FLEX_FIELD_NAME14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME14 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name15 | FI_FLEX_FIELD_NAME15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME15 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name2 | FI_FLEX_FIELD_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name3 | FI_FLEX_FIELD_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name4 | FI_FLEX_FIELD_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name5 | FI_FLEX_FIELD_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name6 | FI_FLEX_FIELD_NAME6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name7 | FI_FLEX_FIELD_NAME7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME7 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name8 | FI_FLEX_FIELD_NAME8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME8 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name9 | FI_FLEX_FIELD_NAME9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME9 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Value1 | FI_FLEX_FIELD_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value10 | FI_FLEX_FIELD_VALUE10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE10 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value11 | FI_FLEX_FIELD_VALUE11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE11 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value12 | FI_FLEX_FIELD_VALUE12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE12 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value13 | FI_FLEX_FIELD_VALUE13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE13 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value14 | FI_FLEX_FIELD_VALUE14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE14 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value15 | FI_FLEX_FIELD_VALUE15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE15 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value2 | FI_FLEX_FIELD_VALUE2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value3 | FI_FLEX_FIELD_VALUE3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value4 | FI_FLEX_FIELD_VALUE4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value5 | FI_FLEX_FIELD_VALUE5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value6 | FI_FLEX_FIELD_VALUE6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value7 | FI_FLEX_FIELD_VALUE7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE7 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value8 | FI_FLEX_FIELD_VALUE8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE8 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value9 | FI_FLEX_FIELD_VALUE9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE9 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Hierarchy Name | FI_HIERARCHY_NAME | no | 0 | 40 | This value must be a valid hierarchy name in the Hierarchy table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Hierarchy Type | FI_HIERARCHY_TYPE | no | 0 | 40 | This must be a valid hierarchy type in the Hierarchy Type table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Location Element Name | FI_LOCATION_ELEMENT_NAME | no | 0 | 80 | This value must be a valid element name in the Hierarchy Group Definition table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Location Element Value | FI_LOCATION_ELEMENT_VALUE | no | 0 | 80 | This value must be a valid element value in the Hierarchy Element table. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Sender Name | FI_SENDER_NAME | no | 0 | 40 | CHARGE_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record status is set to Inactive on passing the value as 'D'. | |
Charge Filtration Default Flag | FI_CHARGE_FILTRATION_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge filter element based on parent. |
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge element based on parent. |
Element Id | FI_ELEMENT_ID | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_ID | This is used to store the id of the element possibly from the ERP. | ||
Location Source | FI_LOCATION_SOURCE | no | 0 | 40 | CHARGE_ELEMENT.LOCATION_SOURCE | Valid Values are 'ADHOC' or 'HIERARCHY' | This is used to specify the source of the charge location. | |
Location Value | FI_LOCATION_VALUE | no | 0 | 80 | CHARGE_ELEMENT.LOCATION_VALUE | Value is required for Location Source of ADHOC. This is used to specify the location associated with the charge element. | ||
Record Status | FI_RECORD_STATUS | no | 0 | 1 | CHARGE_ELEMENT.RECORD_STATUS | If not supplied the default value is 'A'. | Valid values are 'A' (Active) and 'I' (Inactive). | The status of the charge element record. Cannot be used if inactive. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current charge element record. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Dictionary (INTERFACE_DICTIONARY) | |
---|---|
Type | 2000 |
Description | This interface populates Dictionary Records. |
Validation | 1112 - Checks prompt values for escaped XML characters and unescapes them |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1111 - Insert/Update/Delete Dictionary and Dictionary Label records |
Dictionary (INTERFACE_DICTIONARY) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Dictionary Name | FI_DICTIONARY_NAME | yes | 0 | 40 | DICTIONARY.DICTIONARY_NAME | This value must be a valid Dictionary Name or no record will be created | This is used to determine the name of the dictionary. This value must be supplied for a record to be created. | |
Label Name | FI_LABEL_NAME | yes | 0 | 80 | DICTIONARY_LABEL.LABEL_NAME | This is required to determine which dictionary label is being modified. It must be an existing label name. | Label name of the dictionary label | |
Label Type | FI_LABEL_TYPE | yes | 0 | 40 | DICTIONARY_LABEL.LABEL_TYPE | This is required to determine which dictionary label is being modified. It must be an existing label type. | Label type of the dictionary label | |
Module Name | FI_MODULE_NAME | yes | 0 | 40 | DICTIONARY_LABEL.MODULE_NAME | This is required to determine which dictionary label is being modified. It must be an existing module name. | Module name of the dictionary label | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the dictionary records. | |
Alternate Dictionary Name | FI_ALTERNATE_DICTIONARY_NAME | no | 0 | 40 | DICTIONARY.ALTERNATE_DICTIONARY_NAME | If provided, this must be a valid dictionary name that already exists | Alternate dictionary name of the dictionary | |
Base Dictionary Name | FI_BASE_DICTIONARY_NAME | no | 0 | 40 | DICTIONARY.BASE_DICTIONARY_NAME | If the FI_DICTIONARY_NAME provided does not exist, this prompt cannot be null and must be a valid dictionary name. | This value is used to specify the base dictionary name of the dictionary. | |
Description | FI_DESCRIPTION | no | 0 | 80 | DICTIONARY.DESCRIPTION | Description of the dictionary | ||
Locale | FI_LOCALE | no | 0 | 40 | DICTIONARY.LOCALE | If provided, this must be a valid locale that already exists | Locale of the dictionary | |
Long Label | FI_LONG_LABEL | no | 0 | 2000 | DICTIONARY_LABEL.LONG_LABEL | Long label of the dictionary label | ||
Short Label | FI_SHORT_LABEL | no | 0 | 20 | DICTIONARY_LABEL.SHORT_LABEL | Short label of the dictionary label | ||
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current dictionary record. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Hierarchy (INTERFACE_HIERARCHY) | |
---|---|
Type | 2000 |
Description | Interface event used to load hierarchy data along with person group members and person group managers. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1028 - Interface Hierarchy Validation |
Hierarchy (INTERFACE_HIERARCHY) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Element Name | FI_ELEMENT_NAME | yes | 0 | 80 | HIERARCHY_GROUP_DEFINITION.ELEMENT_NAME | The default value will be derived from the specified hierarchy type, hierarchy name and level number combination. | This value must be a valid element name in the Hierarchy Group Definition table or no record will be created | This value is used to map the respective element name to the hierarchy type, hierarchy name, level number combination in hierarchy group definition table. This value must be supplied for a record to be created. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | HIERARCHY_ELEMENT.ELEMENT_VALUE | Each new element must have a parent's lev | This value is used to map the respective element name to the hierarchy type, hierarchy name, level number combination in hierarchy group definition table. This value must be supplied for a record to be created. | |
Hierarchy Name | FI_HIERARCHY_NAME | yes | 0 | 40 | HIERARCHY.HIERARCHY_NAME | This value must be a valid hierarchy name in the Hierarchy table or no record will be created | This is used to name the hierarchy. This value must be supplied for a record to be created. | |
Hierarchy Type | FI_HIERARCHY_TYPE | yes | 0 | 40 | HIERARCHY_TYPE.HIERARCHY_TYPE | This value must be a valid hierarchy type in the Hierarchy Type table or no record will be created | This is used to determine the type of the hierarchy. This value must be supplied for a record to be created. | |
Level Num | FI_LEVEL_NUM | yes | 0 | HIERARCHY_ELEMENT.LEVEL_NUM | This value must be a valid level number in the Hierarchy Group Definition table or no record will be created | This is used to specify the level of the element. This value must be supplied for a record to be created. | ||
Hierarchy Flex Field Name1 | FI_HIERARCHY_FLEX_FIELD_NAME1 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with hierarchy elements. | ||
Hierarchy Flex Field Name2 | FI_HIERARCHY_FLEX_FIELD_NAME2 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with hierarchy elements. | ||
Hierarchy Flex Field Name3 | FI_HIERARCHY_FLEX_FIELD_NAME3 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with hierarchy elements. | ||
Hierarchy Flex Field Name4 | FI_HIERARCHY_FLEX_FIELD_NAME4 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with hierarchy elements. | ||
Hierarchy Flex Field Name5 | FI_HIERARCHY_FLEX_FIELD_NAME5 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with hierarchy elements. | ||
Hierarchy Flex Field Name6 | FI_HIERARCHY_FLEX_FIELD_NAME6 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with hierarchy elements. | ||
Hierarchy Flex Field Value1 | FI_HIERARCHY_FLEX_FIELD_VALUE1 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with hierarchy elements. | ||
Hierarchy Flex Field Value2 | FI_HIERARCHY_FLEX_FIELD_VALUE2 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with hierarchy elements. | ||
Hierarchy Flex Field Value3 | FI_HIERARCHY_FLEX_FIELD_VALUE3 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with hierarchy elements. | ||
Hierarchy Flex Field Value4 | FI_HIERARCHY_FLEX_FIELD_VALUE4 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with hierarchy elements. | ||
Hierarchy Flex Field Value5 | FI_HIERARCHY_FLEX_FIELD_VALUE5 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with hierarchy elements. | ||
Hierarchy Flex Field Value6 | FI_HIERARCHY_FLEX_FIELD_VALUE6 | no | 0 | 40 | HIERARCHY_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with hierarchy elements. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the hierarchy data. The record is deleted from the database on passing the value as 'D'. | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | HIERARCHY_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Description | FI_DESCRIPTION | no | 0 | 80 | HIERARCHY_ELEMENT.DESCRIPTION | Description of the Hierarchy Element | ||
Is Manager | FI_IS_MANAGER | no | 0 | 1 | N | Valid values are 'Y' or 'N' | This prompt is used to defined whether the person is a manager or an employee type in order to create the person member and person manager record accordingly. | |
Parent Element Value1 | FI_PARENT_ELEMENT_VALUE1 | no | 0 | If the level number of the hierarchy element is 1 then this value should not be populated. | This value is used to specify the top of the hierarchy and the value of the ancestor at level 1 for hierarchy elements at level 2 or greater. | |||
Parent Element Value2 | FI_PARENT_ELEMENT_VALUE2 | no | 0 | If the level number of the hierarchy element is 2 then the FI_PARENT_ELEMENT_VALUE1 field should be populated with the level 1 parent that the level 2 element belongs to. | This value is used to specify the value of the ancestor at level 2 for hierarchy elements at level 3 or greater. | |||
Parent Element Value3 | FI_PARENT_ELEMENT_VALUE3 | no | 0 | If the level number of the hierarchy element is 3 then the FI_PARENT_ELEMENT_VALUE2 field should be populated with the level 2 parent that the level 3 element belongs to. | This value is used to specify the value of the ancestor at level 3 for hierarchy elements at level 4 or greater. | |||
Parent Element Value4 | FI_PARENT_ELEMENT_VALUE4 | no | 0 | If the level number of the hierarchy element is 4 then the FI_PARENT_ELEMENT_VALUE3 field should be populated with the level 3 parent that the level 4 element belongs to. | This value is used to specify the value of the ancestor at level 4 for hierarchy elements at level 5 or greater. | |||
Person End Date | FI_PERSON_END_DATE | no | 0 | PERSON_GROUP_MEMBER.END_DATE, PERSON_GROUP_MANAGER.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Used for effective end date of person membership and management in the group | |
Person Num | FI_PERSON_NUM | no | 0 | 40 | PERSON_GROUP_MEMBER.PERSON_ID, PERSON_GROUP_MANAGER.PERSON_ID | If this is supplied, must be a valid person or the group will not get created. | If populated, person (based on person number), becomes a member of the group. If the 'Is Manager' is set with a value of 'Y', the person becomes a manager of the group. 'Person Start Date' and 'Person End Date' are used for effectivity of both membership and management. | |
Person Start Date | FI_PERSON_START_DATE | no | 0 | PERSON_GROUP_MEMBER.START_DATE, PERSON_GROUP_MANAGER.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Used for effective start date of person membership and management in the group | |
Sender Name | FI_SENDER_NAME | no | 0 | 40 | HIERARCHY_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | If this value is not supplied and the action type is 'U' no update will be done. | This value is used to specify the sender name. |
Supervisor Role Name | FI_SUPERVISOR_ROLE_NAME | no | 0 | 40 | PERSON_GROUP_MANAGER.MANAGER_ROLE_NAME | Role name for a given person. | ||
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Message (INTERFACE_MESSAGE) | |
---|---|
Type | 2000 |
Description | Interface event used to load Messages data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1034 - Interface Message Validation |
Message (INTERFACE_MESSAGE) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
End Date | FI_END_DATE | yes | 0 | MESSAGE.END_DATE | 99991131 | Format is yyyyMMdd. For example, 20101231 | Message End Date | |
Message | FI_MESSAGE | yes | 0 | 2000 | MESSAGE.MESSAGE | Actual text message after formatting. | ||
Message Type | FI_MESSAGE_TYPE | yes | 0 | 40 | MESSAGE.MESSAGE_TYPE | Valid values are '1' (BUSINESS_EVENT_MESSAGE), '2' (SYSTEM_ALERT_MESSAGE), '3' (BROADCAST_MESSAGE) and '4' (WORKFLOW_MESSAGE) and '5'(DIALOG_MESSAGE) | The message type | |
Reciever Num | FI_RECIEVER_NUM | yes | 0 | 40 | MESSAGE.RECEIVER_ID | This value must map to a valid person in Person table or no record will be created. | The person number of the reciever. | |
Sender Name | FI_SENDER_NAME | yes | 0 | PERSON.SENDER_NAME | The name of the ERP. | The sender name. | ||
Sender Num | FI_SENDER_NUM | yes | 0 | MESSAGE.SENDER_ID | The default value is whatever is specified for the sender name of the service parameter. | This value must map to a valid person in Person table or no record will be created. | The person number of the sender. | |
Start Date | FI_START_DATE | yes | 0 | MESSAGE.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Message Start Date | |
Acknowledgement Flag | FI_ACKNOWLEDGEMENT_FLAG | no | 0 | 1 | MESSAGE.ACKNOWLEDGEMENT_FLAG | 0 | Valid Values are '0' for no Acknowledgement required and '1' for Acknowledgment required. | Enable acknowledge and/or Agree/Disagree |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record is deleted from the database on passing the value as 'D'. | |
Agree Disagree Flag | FI_AGREE_DISAGREE_FLAG | no | 0 | 1 | MESSAGE.AGREE_DISAGREE_FLAG | 0 | Valid Values are '0' for no Agre/Disagree option and '1' for Agree/Disagree option | Enable Agree/Disagree |
Consolidate Email Messages Flag | FI_CONSOLIDATE_EMAIL_MESSAGES_FLAG | no | 0 | 1 | MESSAGE.CONSOLIDATE_EMAIL_MESSAGES_FLAG | 1 | Valid Values are '0' for do not consolidation option and '1' for consolidate email messages. | Message level email message consolidation flag |
Delete Immediately Flag | FI_DELETE_IMMEDIATELY_FLAG | no | 0 | 1 | MESSAGE.DELETE_IMMEDIATELY_FLAG | 0 | Valid Values are '0' for not delete immediately and '1' for delete immediately. | Message level delete immediately flag |
Dialog Message Name | FI_DIALOG_MESSAGE_NAME | no | 0 | 40 | MESSAGE.DIALOG_MESSAGE_NAME | Name/Key of the message in the dialog | ||
Dialog Name | FI_DIALOG_NAME | no | 0 | 40 | MESSAGE.DIALOG_NAME | Name of the dialog | ||
Dispose On Read Flag | FI_DISPOSE_ON_READ_FLAG | no | 0 | 1 | MESSAGE.DISPOSE_ON_READ_FLAG | 1 | Valid Values are '0' for don't dispose on read and '1' for dispose on read. | Message level dispose on read flag |
Do Not Purge Flag | FI_DO_NOT_PURGE_FLAG | no | 0 | 1 | MESSAGE.DO_NOT_PURGE_FLAG | 0 | Valid Values are '0' for do purge and '1' for do not purge. | Message level do not purge flag |
External Document Num | FI_EXTERNAL_DOCUMENT_NUM | no | 0 | MESSAGE.EXTERNAL_DOCUMENT_NUM | Identifier for group of messages that belong to a particular Dialog | |||
Header | FI_HEADER | no | 0 | 200 | MESSAGE.HEADER | The header of the email message | ||
Message Level Ind | FI_MESSAGE_LEVEL_IND | no | 0 | 1 | MESSAGE.MESSAGE_MESSAGE_LEVEL_IND | Valid values are E(rror), W(arning), I(nfo) | The level of the message | |
Message Medium | FI_MESSAGE_MEDIUM | no | 0 | 40 | MESSAGE.MESSAGE_MEDIUM | Valid Values are APPLICATION and EMAIL | The medium of the mesage can be terminal or email | |
Message Name | FI_MESSAGE_NAME | no | 0 | 40 | MESSAGE.MESSAGE_NAME | Valid values are Message Definitions | The message name of the message definition which generate the message | |
Message Trigger Name | FI_MESSAGE_TRIGGER_NAME | no | 0 | 40 | MESSAGE.MESSAGE_TRIGGER_NAME | Valid values are Message Trigger Definitions | The event trigger that generated the message | |
Priority | FI_PRIORITY | no | 0 | 1 | MESSAGE.PRIORITY | 1 | Valid Values are '1' (HIGH), '2' (MEDIUM) and 3 (LOW). | The priority of the Message. |
Reciever Rcd Num | FI_RECIEVER_RCD_NUM | no | 0 | PERSON.RCD_NUM | If supplied, this value must map to a valid person in Person Table or no record will be created. | The reciever record number is used to match the reciever number to the receiver. | ||
Reference Id | FI_REFERENCE_ID | no | 0 | MESSAGE.MESSAGE_REFERENCE_ID | Valid values are The reference id based on reference_type | The reference id based on reference_type | ||
Reference Type | FI_REFERENCE_TYPE | no | 0 | 40 | MESSAGE.MESSAGE_REFERENCE_TYPE | Valid values are the table names of the reference id | The type of reference Id | |
Sender Rcd Num | FI_SENDER_RCD_NUM | no | 0 | PERSON.RCD_NUM | If supplied, this value must map to a valid person in Person table or no record will be created. | The sender record number is used to match the sender number to the sender id. | ||
Subject | FI_SUBJECT | no | 0 | 200 | MESSAGE.SUBJECT | The subject of the email message | ||
Trailer | FI_TRAILER | no | 0 | 200 | MESSAGE.TRAILER | The trailer of the email message | ||
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Operation (INTERFACE_OPERATION) | |
---|---|
Type | 2000 |
Description | Interface event used to load Operation data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1083 - Insert/Update Charge Element Operation records |
Operation (INTERFACE_OPERATION) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_ELEMENT.CHARGE_TYPE | The default value will be derived from the specified level number. | This value must be a valid and active charge type in the Charge Type table or no record will be created | This value is used to map the charge type to the level number and element name supplied. This value must be supplied for charge element filtration purposes. |
Element Name | FI_ELEMENT_NAME | yes | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The default value will be derived from the specified charge element type. The Level is determined and set to 2 for element name of Operation. | This value must be a valid element name in the Charge Element Type table or no record will be created | This value is used to map the element name to the charge type. This value must be supplied for a record to be created. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_VALUE | Each new element must have a parent's lev | This value must be supplied for a record to be created. | |
Operation Num | FI_OPERATION_NUM | yes | 0 | 40 | CHARGE_ELEMENT_OPERATION.OPERATION_NUM | This prompt is used to identify the operation. | ||
Allow Labor Flag | FI_ALLOW_LABOR_FLAG | no | 0 | 1 | CHARGE_ELEMENT_OPERATION.ALLOW_LABOR_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | Determine whether labor charging is allowed on the operation. |
Allow Qc Flag | FI_ALLOW_QC_FLAG | no | 0 | 1 | CHARGE_ELEMENT_OPERATION.ALLOW_QC_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | Determine whether quality control charging is allowed on the operation. |
Alternate Operation | FI_ALTERNATE_OPERATION | no | 0 | 20 | CHARGE_ELEMENT_OPERATION.ALTERNATE_OPERATION_NUM | If not supplied the default value is 'N'. | alternative step. | |
Charge Element End Date | FI_CHARGE_ELEMENT_END_DATE | no | 0 | CHARGE_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Charge Element End Date | |
Charge Element Start Date | FI_CHARGE_ELEMENT_START_DATE | no | 0 | CHARGE_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Charge Element Start Date | |
Charge Filtration Group1 | FI_CHARGE_FILTRATION_GROUP1 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group2 | FI_CHARGE_FILTRATION_GROUP2 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group3 | FI_CHARGE_FILTRATION_GROUP3 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group4 | FI_CHARGE_FILTRATION_GROUP4 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group5 | FI_CHARGE_FILTRATION_GROUP5 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group End Date1 | FI_CHARGE_FILTRATION_GROUP_END_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date2 | FI_CHARGE_FILTRATION_GROUP_END_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date3 | FI_CHARGE_FILTRATION_GROUP_END_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date4 | FI_CHARGE_FILTRATION_GROUP_END_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date5 | FI_CHARGE_FILTRATION_GROUP_END_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group Start Date1 | FI_CHARGE_FILTRATION_GROUP_START_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date2 | FI_CHARGE_FILTRATION_GROUP_START_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date3 | FI_CHARGE_FILTRATION_GROUP_START_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date4 | FI_CHARGE_FILTRATION_GROUP_START_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date5 | FI_CHARGE_FILTRATION_GROUP_START_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Count Point Flag | FI_COUNT_POINT_FLAG | no | 0 | 1 | CHARGE_ELEMENT_OPERATION.COUNT_POINT_FLAG | 0 | Indicates if it is a milestone or count point operation | |
Current Plant | FI_CURRENT_PLANT | no | 0 | CHARGE_ELEMENT_OPERATION.CURRENT_PLANT | The current plant for the operation | |||
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | CHARGE_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Description | FI_DESCRIPTION | no | 0 | 80 | CHARGE_ELEMENT.DESCRIPTION | Description of the Operation | ||
Flex Field Name1 | FI_FLEX_FIELD_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name10 | FI_FLEX_FIELD_NAME10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME10 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name11 | FI_FLEX_FIELD_NAME11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME11 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name12 | FI_FLEX_FIELD_NAME12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME12 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name13 | FI_FLEX_FIELD_NAME13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME13 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name14 | FI_FLEX_FIELD_NAME14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME14 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name15 | FI_FLEX_FIELD_NAME15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME15 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name2 | FI_FLEX_FIELD_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name3 | FI_FLEX_FIELD_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name4 | FI_FLEX_FIELD_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name5 | FI_FLEX_FIELD_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name6 | FI_FLEX_FIELD_NAME6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name7 | FI_FLEX_FIELD_NAME7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME7 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name8 | FI_FLEX_FIELD_NAME8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME8 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name9 | FI_FLEX_FIELD_NAME9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME9 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Value1 | FI_FLEX_FIELD_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value10 | FI_FLEX_FIELD_VALUE10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE10 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value11 | FI_FLEX_FIELD_VALUE11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE11 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value12 | FI_FLEX_FIELD_VALUE12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE12 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value13 | FI_FLEX_FIELD_VALUE13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE13 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value14 | FI_FLEX_FIELD_VALUE14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE14 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value15 | FI_FLEX_FIELD_VALUE15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE15 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value2 | FI_FLEX_FIELD_VALUE2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value3 | FI_FLEX_FIELD_VALUE3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value4 | FI_FLEX_FIELD_VALUE4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value5 | FI_FLEX_FIELD_VALUE5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value6 | FI_FLEX_FIELD_VALUE6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value7 | FI_FLEX_FIELD_VALUE7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE7 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value8 | FI_FLEX_FIELD_VALUE8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE8 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value9 | FI_FLEX_FIELD_VALUE9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE9 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Hierarchy Name | FI_HIERARCHY_NAME | no | 0 | 40 | This value must be a valid hierarchy name in the Hierarchy table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Hierarchy Type | FI_HIERARCHY_TYPE | no | 0 | 40 | This must be a valid hierarchy type in the Hierarchy Type table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Location Element Name | FI_LOCATION_ELEMENT_NAME | no | 0 | 80 | This value must be a valid element name in the Hierarchy Group Definition table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Location Element Value | FI_LOCATION_ELEMENT_VALUE | no | 0 | 80 | This value must be a valid element value in the Hierarchy Element table. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Machine Standard Hours | FI_MACHINE_STANDARD_HOURS | no | 0 | CHARGE_ELEMENT_OPERATION.MACHINE_STANDARD_HOURS | Machine standard hours for the operation. | |||
Next Operation Num | FI_NEXT_OPERATION_NUM | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.NEXT_OPERATION_NUM | This prompt is used to specify the next operation in the order. | ||
Operation Labor Standard Basis | FI_OPERATION_LABOR_STANDARD_BASIS | no | 0 | CHARGE_ELEMENT_OPERATION.OPERATION_LABOR_STANDARD_BASIS | Labor standard basis for the operation. | |||
Operation Labor Standard Hours | FI_OPERATION_LABOR_STANDARD_HOURS | no | 0 | CHARGE_ELEMENT_OPERATION.OPERATION_LABOR_STANDARD_HOURS | Labor standard hours for the operation. | |||
Operation Labor Standard Per Piece | FI_OPERATION_LABOR_STANDARD_PER_PIECE | no | 0 | CHARGE_ELEMENT_OPERATION.OPERATION_LABOR_STANDARD_PER_PIECE | Labor standard per piece for the operation. | |||
Operation Labor Type | FI_OPERATION_LABOR_TYPE | no | 0 | CHARGE_ELEMENT_OPERATION.OPERATION_LABOR_TYPE | The Operation type. | |||
Operation Quantity Planned | FI_OPERATION_QUANTITY_PLANNED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_PLANNED | 0 | Quantity that is planned for the operation. | ||
Operation Setup Standard Hours | FI_OPERATION_SETUP_STANDARD_HOURS | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.OPERATION_SETUP_STANDARD_HOURS | Setup standard hours for the operation. | ||
Operation Stage | FI_OPERATION_STAGE | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.OPERATION_STAGE | The stage of the operation. | ||
Operation Status | FI_OPERATION_STATUS | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.OPERATION_STATUS | OPEN | Valid values are 'OPEN' and 'COMPLETE'. | The status of the operation. Cannot be use if complete unless over-completion is allowed. |
Operation Step | FI_OPERATION_STEP | no | 0 | 20 | CHARGE_ELEMENT_OPERATION.OPERATION_STEP | operation step. | ||
Parent Element Name | FI_PARENT_ELEMENT_NAME | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | ORDER | Valid value is required for charge element that is higher than level 1. The element name of the order that is the parent of the operation. | This value is used to specify the name of the parent of the charge element. In this case the parent is an order. |
Parent Element Value | FI_PARENT_ELEMENT_VALUE | no | 0 | 40 | CHARGE_ELEMENT_ORDER.ORDER_NUM | Valid value is required for charge element that is higher than level 1. The element value of the order that is the parent of the operation. | This value is used to specify the value of the parent of the charge element. In this case the parent is an order. | |
Planned Hours | FI_PLANNED_HOURS | no | 0 | CHARGE_ELEMENT.PLANNED_HOURS | Planned hours for a charge element which is stored in hours | |||
Planned Plant | FI_PLANNED_PLANT | no | 0 | CHARGE_ELEMENT_OPERATION.PLANNED_PLANT | The planned plant for the operation | |||
Planned Work Center | FI_PLANNED_WORK_CENTER | no | 0 | CHARGE_ELEMENT_OPERATION.PLANNED_WORK_CENTER | The planned work center for the operation | |||
Previous Operation Num | FI_PREVIOUS_OPERATION_NUM | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.PREVIOUS_OPERATION_NUM | This prompt is used to specify the previous operation in the order. | ||
Quantity Available | FI_QUANTITY_AVAILABLE | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_AVAILABLE | 0 | The quantity that is available to move | ||
Quantity Completed | FI_QUANTITY_COMPLETED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_COMPLETED | 0 | The quantity that is completed. | ||
Quantity Moved | FI_QUANTITY_MOVED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_MOVED | 0 | The quantity that is moved. | ||
Quantity Rejected | FI_QUANTITY_REJECTED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_REJECTED | 0 | The quantity that is rejected. | ||
Quantity Reworked | FI_QUANTITY_REWORKED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_REWORKED | 0 | The quantity that is reworked. | ||
Quantity Scrapped | FI_QUANTITY_SCRAPPED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_SCRAPPED | 0 | The quantity that is scrapped. | ||
Quantity Started | FI_QUANTITY_STARTED | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_STARTED | 0 | the quantity that is started. | ||
Quantity To Move | FI_QUANTITY_TO_MOVE | no | 0 | CHARGE_ELEMENT_OPERATION.QUANTITY_TO_MOVE | 0 | The quantity that is ready to move. | ||
Sender Name | FI_SENDER_NAME | no | 0 | 40 | CHARGE_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. | |
Sequence Num | FI_SEQUENCE_NUM | no | 0 | CHARGE_ELEMENT_OPERATION.SEQUENCE_NUM | Numeric value that allows operation to be sequenced, so operation 10 would show before operation 100 | |||
Work Center | FI_WORK_CENTER | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.WORK_CENTER | The department code or work center. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record status is set to Inactive on passing the value as 'D'. | |
Charge Filter Description1 | FI_CHARGE_FILTER_DESCRIPTION1 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description2 | FI_CHARGE_FILTER_DESCRIPTION2 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description3 | FI_CHARGE_FILTER_DESCRIPTION3 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description4 | FI_CHARGE_FILTER_DESCRIPTION4 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description5 | FI_CHARGE_FILTER_DESCRIPTION5 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Group Type1 | FI_CHARGE_FILTER_GROUP_TYPE1 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type2 | FI_CHARGE_FILTER_GROUP_TYPE2 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type3 | FI_CHARGE_FILTER_GROUP_TYPE3 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type4 | FI_CHARGE_FILTER_GROUP_TYPE4 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type5 | FI_CHARGE_FILTER_GROUP_TYPE5 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filtration Default Flag | FI_CHARGE_FILTRATION_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge filter element based on parent. |
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge element based on parent. |
Disable Qty Updates | FI_DISABLE_QTY_UPDATES | no | 0 | 40 | N | Used to determine if the Operation Quantities can be updated | ||
Element Id | FI_ELEMENT_ID | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_ID | This is used to store the id of the element possibly from the ERP. | ||
Location Source | FI_LOCATION_SOURCE | no | 0 | 40 | CHARGE_ELEMENT.LOCATION_SOURCE | Valid Values are 'ADHOC' or 'HIERARCHY' | This is used to specify the source of the charge location. | |
Location Value | FI_LOCATION_VALUE | no | 0 | 80 | CHARGE_ELEMENT.LOCATION_VALUE | Value is required for Location Source of ADHOC. This is used to specify the location associated with the charge element. | ||
Order Id | FI_ORDER_ID | no | 0 | 40 | ACTION_MOVE_QUANTITY.ORDER_ID | Charge element id for ERP order # | ||
Record Status | FI_RECORD_STATUS | no | 0 | 1 | CHARGE_ELEMENT.RECORD_STATUS | If not supplied the default value is 'A'. | Valid values are 'A' (Active) and 'I' (Inactive). | The status of the operation. Cannot be used if inactive. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current charge element record. | |
Work Center Group | FI_WORK_CENTER_GROUP | no | 0 | 40 | CHARGE_ELEMENT_OPERATION.WORK_CENTER_GROUP | The department or work center group. | ||
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Order (INTERFACE_ORDER) | |
---|---|
Type | 2000 |
Description | Interface event used to load Order data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1084 - Insert/Update Charge Element Order records |
Order (INTERFACE_ORDER) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_ELEMENT.CHARGE_TYPE | The default value will be derived from the specified level number. | This value must be a valid and active charge type in the Charge Type table or no record will be created | This value is used to map the charge type to the level number and element name supplied. This value must be supplied for charge element filtration purposes. |
Element Name | FI_ELEMENT_NAME | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_NAME | The default value will be derived from the specified charge type. | This value must be a valid element name in the Charge Type table or no record will be created | This value is used to map the element name to the charge type. This value must be supplied for a record to be created. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_VALUE | Each new element must have a parent's lev | This value must be supplied for a record to be created. | |
Order Num | FI_ORDER_NUM | yes | 0 | 80 | CHARGE_ELEMENT_ORDER.ORDER_NUM | Holds the ERP order # | ||
Order Status | FI_ORDER_STATUS | yes | 0 | 40 | CHARGE_ELEMENT_ORDER.ORDER_STATUS | Holds the B-COMM order status values (OPEN, ACTIVE, HOLD, COMPLETE, CLOSED). | ||
Charge Element End Date | FI_CHARGE_ELEMENT_END_DATE | no | 0 | CHARGE_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Charge Element End Date | |
Charge Element Start Date | FI_CHARGE_ELEMENT_START_DATE | no | 0 | CHARGE_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Charge Element Start Date | |
Charge Filtration Group1 | FI_CHARGE_FILTRATION_GROUP1 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group2 | FI_CHARGE_FILTRATION_GROUP2 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group3 | FI_CHARGE_FILTRATION_GROUP3 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group4 | FI_CHARGE_FILTRATION_GROUP4 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group5 | FI_CHARGE_FILTRATION_GROUP5 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group End Date1 | FI_CHARGE_FILTRATION_GROUP_END_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date2 | FI_CHARGE_FILTRATION_GROUP_END_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date3 | FI_CHARGE_FILTRATION_GROUP_END_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date4 | FI_CHARGE_FILTRATION_GROUP_END_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date5 | FI_CHARGE_FILTRATION_GROUP_END_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group Start Date1 | FI_CHARGE_FILTRATION_GROUP_START_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date2 | FI_CHARGE_FILTRATION_GROUP_START_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date3 | FI_CHARGE_FILTRATION_GROUP_START_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date4 | FI_CHARGE_FILTRATION_GROUP_START_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date5 | FI_CHARGE_FILTRATION_GROUP_START_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | CHARGE_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge element based on parent. |
Description | FI_DESCRIPTION | no | 0 | 80 | CHARGE_ELEMENT.DESCRIPTION | Description of the Order | ||
End Date | FI_END_DATE | no | 0 | CHARGE_ELEMENT_ORDER.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Planned start date | |
External Order Status | FI_EXTERNAL_ORDER_STATUS | no | 0 | 40 | CHARGE_ELEMENT_ORDER.EXTERNAL_ORDER_STATUS | Holds any ERP/MRP specific order status. | ||
Flex Field Name1 | FI_FLEX_FIELD_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name10 | FI_FLEX_FIELD_NAME10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME10 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name11 | FI_FLEX_FIELD_NAME11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME11 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name12 | FI_FLEX_FIELD_NAME12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME12 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name13 | FI_FLEX_FIELD_NAME13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME13 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name14 | FI_FLEX_FIELD_NAME14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME14 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name15 | FI_FLEX_FIELD_NAME15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME15 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name2 | FI_FLEX_FIELD_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name3 | FI_FLEX_FIELD_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name4 | FI_FLEX_FIELD_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name5 | FI_FLEX_FIELD_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name6 | FI_FLEX_FIELD_NAME6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name7 | FI_FLEX_FIELD_NAME7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME7 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name8 | FI_FLEX_FIELD_NAME8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME8 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name9 | FI_FLEX_FIELD_NAME9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME9 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Value1 | FI_FLEX_FIELD_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value10 | FI_FLEX_FIELD_VALUE10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE10 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value11 | FI_FLEX_FIELD_VALUE11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE11 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value12 | FI_FLEX_FIELD_VALUE12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE12 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value13 | FI_FLEX_FIELD_VALUE13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE13 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value14 | FI_FLEX_FIELD_VALUE14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE14 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value15 | FI_FLEX_FIELD_VALUE15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE15 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value2 | FI_FLEX_FIELD_VALUE2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value3 | FI_FLEX_FIELD_VALUE3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value4 | FI_FLEX_FIELD_VALUE4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value5 | FI_FLEX_FIELD_VALUE5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value6 | FI_FLEX_FIELD_VALUE6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value7 | FI_FLEX_FIELD_VALUE7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE7 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value8 | FI_FLEX_FIELD_VALUE8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE8 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value9 | FI_FLEX_FIELD_VALUE9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE9 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Hierarchy Name | FI_HIERARCHY_NAME | no | 0 | 40 | This value must be a valid hierarchy name in the Hierarchy table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Hierarchy Type | FI_HIERARCHY_TYPE | no | 0 | 40 | This must be a valid hierarchy type in the Hierarchy Type table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Inventory Code | FI_INVENTORY_CODE | no | 0 | 80 | CHARGE_ELEMENT_ORDER.INVENTORY_CODE | stores the inventory abbreviation code. | ||
Item Num | FI_ITEM_NUM | no | 0 | 80 | CHARGE_ELEMENT_ORDER.ITEM_NUM | Item# of the part or item being produced | ||
Location Element Name | FI_LOCATION_ELEMENT_NAME | no | 0 | 80 | This value must be a valid element name in the Hierarchy Group Definition table or no record will be created. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Location Element Value | FI_LOCATION_ELEMENT_VALUE | no | 0 | 80 | This value must be a valid element value in the Hierarchy Element table. | Value is required for Location Source of Hierarchy. This is used to determine the Location Element Node. | ||
Order Quantity Planned | FI_ORDER_QUANTITY_PLANNED | no | 0 | CHARGE_ELEMENT_ORDER.QUANTITY_PLANNED | Quantity planned to be produced for the order. Equivalent to order quantity or scheduled quantity | |||
Order Quantity Started | FI_ORDER_QUANTITY_STARTED | no | 0 | CHARGE_ELEMENT_ORDER.QUANTITY_STARTED | Quantity started for the order. | |||
Order Type | FI_ORDER_TYPE | no | 0 | 40 | CHARGE_ELEMENT_ORDER.ORDER_TYPE | Holds the ERP order type. | ||
Overreporting Amount | FI_OVERREPORTING_AMOUNT | no | 0 | CHARGE_ELEMENT_ORDER.OVERREPORTING_AMOUNT | Holds the amount or percentage value that will be allowed for over reporting for this order, based on type. | |||
Overreporting Type | FI_OVERREPORTING_TYPE | no | 0 | 1 | CHARGE_ELEMENT_ORDER.OVERREPORTING_TYPE | Valid Values are 'P' (Percentage) and 'A'(Amount). | The type of the over reporting amount. | |
Parent Order Num | FI_PARENT_ORDER_NUM | no | 0 | 80 | CHARGE_ELEMENT_ORDER.PARENT_ORDER_NUM | Holds the ERP parent order # | ||
Planned Hours | FI_PLANNED_HOURS | no | 0 | CHARGE_ELEMENT.PLANNED_HOURS | Planned hours for a charge element which is stored in hours | |||
Primary Unit Of Measure | FI_PRIMARY_UNIT_OF_MEASURE | no | 0 | 20 | CHARGE_ELEMENT_ORDER.PRIMARY_UOM | Primary/Base UOM code for the item bring produced | ||
Priority | FI_PRIORITY | no | 0 | CHARGE_ELEMENT_ORDER.PRIORITY | Defines the priority for the order and is used in situations like work queue. | |||
Quantity Overcompleted | FI_QUANTITY_OVERCOMPLETED | no | 0 | CHARGE_ELEMENT_ORDER.QUANTITY_OVERCOMPLETED | Quantity Overcompleted for the order. | |||
Reference Order Num | FI_REFERENCE_ORDER_NUM | no | 0 | 80 | CHARGE_ELEMENT_ORDER.REFERENCE_ORDER_NUM | Holds the ERP master order that needs to be referenced. | ||
Sender Name | FI_SENDER_NAME | no | 0 | 40 | CHARGE_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. | |
Start Date | FI_START_DATE | no | 0 | CHARGE_ELEMENT_ORDER.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Planned start date | |
Underreporting Amount | FI_UNDERREPORTING_AMOUNT | no | 0 | 40 | CHARGE_ELEMENT_ORDER.UNDERREPORTING_AMOUNT | Holds the ERP underreporting amount. | ||
Underreporting Type | FI_UNDERREPORTING_TYPE | no | 0 | 40 | CHARGE_ELEMENT_ORDER.UNDERREPORTING_TYPE | Holds the ERP underreporting type. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record status is set to Inactive on passing the value as 'D'. | |
Charge Filter Description1 | FI_CHARGE_FILTER_DESCRIPTION1 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description2 | FI_CHARGE_FILTER_DESCRIPTION2 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description3 | FI_CHARGE_FILTER_DESCRIPTION3 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description4 | FI_CHARGE_FILTER_DESCRIPTION4 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description5 | FI_CHARGE_FILTER_DESCRIPTION5 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Group Type1 | FI_CHARGE_FILTER_GROUP_TYPE1 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type2 | FI_CHARGE_FILTER_GROUP_TYPE2 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type3 | FI_CHARGE_FILTER_GROUP_TYPE3 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type4 | FI_CHARGE_FILTER_GROUP_TYPE4 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type5 | FI_CHARGE_FILTER_GROUP_TYPE5 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filtration Default Flag | FI_CHARGE_FILTRATION_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge filter element based on parent. |
Element Id | FI_ELEMENT_ID | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_ID | This is used to store the id of the element possibly from the ERP. | ||
Location Source | FI_LOCATION_SOURCE | no | 0 | 40 | CHARGE_ELEMENT.LOCATION_SOURCE | Valid Values are 'ADHOC' or 'HIERARCHY' | This is used to specify the source of the charge location. | |
Location Value | FI_LOCATION_VALUE | no | 0 | 80 | CHARGE_ELEMENT.LOCATION_VALUE | Value is required for Location Source of ADHOC. This is used to specify the location associated with the charge element. | ||
Record Status | FI_RECORD_STATUS | no | 0 | 1 | CHARGE_ELEMENT.RECORD_STATUS | If not supplied the default value is 'A'. | Valid values are 'A' (Active) and 'I' (Inactive). | The status of the charge element record. Cannot be used if inactive. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current charge element record. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Pay Scales (INTERFACE_PAY_SCALES) | |
---|---|
Type | 2000 |
Description | This interface populate Pay Scales, Pay Class and Pay Level. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 100033 - Pay Scale and Pay Levels Validation |
Pay Scales (INTERFACE_PAY_SCALES) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Pay Scale Name | FI_PAY_SCALE_NAME | yes | 0 | 40 | PAY_SCALE.PAY_SCALE_NAME | Value is required for create/update/deletion of Pay Scale, Pay Class and Pay Level record. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the pay scales. The record is deleted from the database on passing the value as 'D'. | |
Description | FI_DESCRIPTION | no | 0 | 80 | PAY_SCALE_CLASS.DESCRIPTION | Description for the Pay Class. | ||
Enabled Flag | FI_ENABLED_FLAG | no | 0 | 1 | PAY_SCALE_CLASS.ENABLED_FLAG | 1 | Should be 0 or 1 | For a Pay Class enabled flag 0 is considered as an Inactive record and enabled flag 1 is considered as an Active record. |
End Date | FI_END_DATE | no | 0 | PAY_SCALE_LEVEL.END_DATE | 99991231 | Format is yyyyMMdd. For example, 99991231 | This prompt value is used to populate the end date column in the pay_scale_level. | |
Labor Rate Amount | FI_LABOR_RATE_AMOUNT | no | 0 | PAY_SCALE_LEVEL.LABOR_RATE_AMOUNT | Should be a floating number | Value is required for creating the Pay Level only if the labor_rate_required_flag is 1. The value should be within the Min and Max Labor Rate of a Pay Class. | ||
Labor Rate Required Flag | FI_LABOR_RATE_REQUIRED_FLAG | no | 0 | 1 | PAY_SCALE_CLASS.LABOR_RATE_REQUIRED_FLAG | 1 | Should be 0 or 1 | Value 0 is considered as Labor Rate is not required for the Level(s) and 1 is considered as Labor Rate is required for the Level(s). |
Max Labor Rate Amount | FI_MAX_LABOR_RATE_AMOUNT | no | 0 | PAY_SCALE_CLASS.MAX_LABOR_RATE_AMOUNT | Should be a floating number | Value is required for creating the Pay Class. | ||
Max Payroll Rate Amount | FI_MAX_PAYROLL_RATE_AMOUNT | no | 0 | PAY_SCALE_CLASS.MAX_PAYROLL_RATE_AMOUNT | Should be a floating number | Value is required for creating the Pay Class. | ||
Min Labor Rate Amount | FI_MIN_LABOR_RATE_AMOUNT | no | 0 | PAY_SCALE_CLASS.MIN_LABOR_RATE_AMOUNT | Should be a floating number | Value is required for creating the Pay Class. | ||
Min Payroll Rate Amount | FI_MIN_PAYROLL_RATE_AMOUNT | no | 0 | PAY_SCALE_CLASS.MIN_PAYROLL_RATE_AMOUNT | Should be a floating number | Value is required for creating the Pay Class. | ||
Payroll Rate Amount | FI_PAYROLL_RATE_AMOUNT | no | 0 | PAY_SCALE_LEVEL.PAYROLL_RATE_AMOUNT | Should be a floating number | Value is required for creating the Pay Level. The value should be within the Min and Max Payroll Rate of a Pay Class. | ||
Pay Class | FI_PAY_CLASS | no | 0 | 40 | PAY_SCALE_CLASS.PAY_SCALE_CLASS_NAME | Value is required for create/update/deletion of Pay Class and Pay Level record. If value is not passed then the data will not be processed for Pay Class and Pay Level. | ||
Pay Level | FI_PAY_LEVEL | no | 0 | PAY_SCALE_LEVEL.PAY_LEVEL | Should be a number | Value is required for create/update/deletion of Pay Level record. If value is not passed then the data will not be processed for Pay Level. | ||
Start Date | FI_START_DATE | no | 0 | PAY_SCALE_LEVEL.START_DATE | 19700101 | Format is yyyyMMdd. For example, 19700101 | This prompt value is used to populate the start date column in the pay_scale_level. |
Person (INTERFACE_PERSON) | |
---|---|
Type | 2000 |
Description | Interface event used to load person data. Supports full syncronization and incremental syncronization |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1023 - Insert/Update Person records |
Person (INTERFACE_PERSON) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON.PERSON_NUM | Used to identify the person. If this value is not supplied a record will not be created. | ||
Anchor Date | FI_ANCHOR_DATE | no | 0 | 40 | PERSON.ANCHOR_DATE | This prompt value is the anchor date from which attendance rewards are calculated by the attendance reward service. | ||
Applicable Date | FI_APPLICABLE_DATE | no | 0 | 20 | Current Date | Format is yyyyMMdd. For example, 99991231. This value only applies if smart update is set to 'Y' | This is used to find the record that needs to be updated based on the applicable date. | |
Attendance Entry Type | FI_ATTENDANCE_ENTRY_TYPE | no | 0 | 40 | PERSON_EMPLOYEE_PROFILE.ATTENDANCE_ENTRY_TYPE | PERSON.TIME_ENTRY_TYPE | This prompt value only takes effect if the Employee Category module is enabled. This prompt value takes precedency over the time_entry_type value in the person table. Valid values include PUNCHED, EXCEPTION, ELAPSED, NONE | PUNCHED - Punch Entry, EXCEPTION - Exception or Automatic Entry, ELAPSED - Elapsed Entry Type, NONE - One cannot enter time at all from anywhere. |
Badge Group | FI_BADGE_GROUP | no | 0 | 40 | BADGE.BADGE_GROUP | SYSTEM | Badge group is used to provide users with the ability to restrict the list of badges to a specific group of employees. | |
Badge Num | FI_BADGE_NUM | no | 0 | 40 | BADGE.BADGE_NUM, BADGE.BADGE_ID, PERSON_BADGE.BADGE_ID | If value is not supplied, no badge or person badge record will be created. | If populated, badge will be created based on the badge number and associated with the person number for the person record. One person can have multiple badges provided the following is true: The badge start and dates do not overlap for the same badge type | |
Badge Status | FI_BADGE_STATUS | no | 0 | 1 | BADGE.BADGE_STATUS | I | Valid values are 'I','A','U' or 'L' | If no badge status is provided the default is I. The badge can have one of the following statuses: I - ISSUED, U - UNAVAILABLE, A - AVAILABLE, L - Lost. |
Badge Type | FI_BADGE_TYPE | no | 0 | 40 | BADGE.BADGE_TYPE | PERMANENT | Valid values are PERMANENT or TEMPORARY | Used to identify if the badge in permanent or temporary. |
Birth Date | FI_BIRTH_DATE | no | 0 | PERSON.BIRTH_DATE | Format is yyyyMMdd. For example, 20101231 | Used to update the birth date column in the person table. | ||
Classification Type | FI_CLASSIFICATION_TYPE | no | 0 | 40 | PERSON_EMPLOYEE_PROFILE.CLASSIFICATION_TYPE | Hourly | Valid values are 'Hourly', 'Salaried' or 'Nonexempt' | This prompt is used with the Employee Category module. Whether the person is Hourly, Salaried or Nonexempt (salaried). |
Clear Transactions | FI_CLEAR_TRANSACTIONS | no | 0 | 3 | Yes | Valid values are 'Yes' or 'No' | This prompt is used with the Employee Category module. On termination of a person employee profile record, this prompt is used to determine if the actions and trans actions associated with the employee will be cancelled after the termination date. | |
Code Name1 | FI_CODE_NAME1 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name2 | FI_CODE_NAME2 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name3 | FI_CODE_NAME3 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name4 | FI_CODE_NAME4 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name5 | FI_CODE_NAME5 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name6 | FI_CODE_NAME6 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name7 | FI_CODE_NAME7 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name8 | FI_CODE_NAME8 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Name9 | FI_CODE_NAME9 | no | 0 | 40 | PERSON_ADHOC.CODE_NAME | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value1 | FI_CODE_VALUE1 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value2 | FI_CODE_VALUE2 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value3 | FI_CODE_VALUE3 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value4 | FI_CODE_VALUE4 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value5 | FI_CODE_VALUE5 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value6 | FI_CODE_VALUE6 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value7 | FI_CODE_VALUE7 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value8 | FI_CODE_VALUE8 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Code Value9 | FI_CODE_VALUE9 | no | 0 | 40 | PERSON_ADHOC.CODE_VALUE | Used to associated a person adhoc record with person via the person_adhoc table. | ||
Default Pin | FI_DEFAULT_PIN | no | 0 | 3 | PERSON_PIN.PIN | No | Valid values are 'Yes' or 'No' | This prompt is used to determine if an default person_pin record will be added for the person record. When there is no existing record and the value is set to Yes, a new record is created with blank pin. |
Direct Ind | FI_DIRECT_IND | no | 0 | 1 | PERSON_EMPLOYEE_PROFILE.DIRECT_IND | D | Valid Values are 'D' or 'I' | This prompt is used only when the Employee Category module is enabled. Used to update the direct_ind column on the person_employee_profile table. |
Direct Supervision Action | FI_DIRECT_SUPERVISION_ACTION | no | 0 | 40 | A | Valid values are 'A' (Add) or 'U' (Update) | If set to 'A', processes date logic on the supervision manager person group as add. If set to 'U', processes date logic as modify. | |
Email Address1 | FI_EMAIL_ADDRESS1 | no | 0 | 80 | PERSON.EMAIL_ADDRESS1 | This prompt is used to populate the email_address1 column in the person table. | ||
Email Address2 | FI_EMAIL_ADDRESS2 | no | 0 | 80 | PERSON.EMAIL_ADDRESS2 | This prompt is used to populate the email_address2 column in the person table. | ||
Employee Profile Action | FI_EMPLOYEE_PROFILE_ACTION | no | 0 | 40 | A | Valid values are 'A' (Add) or 'U' (Update) | If set to 'A', processes date logic on the employee profile as add. If set to 'U', processes date logic as modify. | |
Employment Status | FI_EMPLOYMENT_STATUS | no | 0 | 20 | PERSON_EMPLOYEE_PROFILE.EMPLOYMENT_STATUS | Valid Values are 'ACTIVE', 'INACTIVE' or 'TERMINATED' | This prompt is used to populate the employment_status column in the person_employee_profile table. This prompt value overrides the record status in the person table if the Employee Categories module is enabled. | |
End Date | FI_END_DATE | no | 0 | PERSON_GROUP.END_DATE, PERSON_GROUP_MEMBER.END_DATE, PERSON_GROUP_MANAGER.END_DATE, PERSON_BADGE.END_DATE, PERSON_EMPLOYEE_PROFILE.END_DATE | 99991231 | Format is yyyyMMdd. For example, 99991231 | In the person_group_member table, the end_date is only used if FI_MANAGER_NUM is not empty and as part of the insertion for DIRECT_MANAGER person_group_member record. When creating a new person_group DIRECT_MANAGER using the person interface, the end_date of person_group and person_group_manager will always be '9999-12-31'. In the person_badge table, end_date is used during the insertion of a person_badge record if the FI_END_TIMESTAMP prompt is not set. The end_date could also be used during the insertion of the person_employee_profile record. | |
End Timestamp | FI_END_TIMESTAMP | no | 0 | PERSON_BADGE.END_DATE | 99991231 | Format is yyyyMMddHHmmss. For example, 99991231120000 | In the person_badge record, the end_timestamp is used during the insertion of a badge. | |
Exclusive Direct Group | FI_EXCLUSIVE_DIRECT_GROUP | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | If the FI_EXCLUSIVE_DIRECT_GROUP prompt is set to true ('Y'es) then end date person group membership for all existing records to which the employee currently belongs and the new record inserted. If the prompt is set to false then do nothing. | |
Exclusive Filtration Group | FI_EXCLUSIVE_FILTRATION_GROUP | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | If the FI_EXCLUSIVE_FILTRATION_GROUP prompt is set to true ('Y'es) then end date person group membership for all existing records to which the employee currently belongs and the new record inserted. If the prompt is set to false then do nothing. | |
First Name | FI_FIRST_NAME | no | 0 | 40 | PERSON.FIRST_NAME | If value is not supplied, the value in the person num will be used. | Used to update the first_name column in the person table. | |
Full Part Time Ind | FI_FULL_PART_TIME_IND | no | 0 | 1 | PERSON_EMPLOYEE_PROFILE.FULL_PART_TIME_IND | F | Valid Values are 'F' or 'P'. | This prompt value only takes effect if the Employee Category module is enabled. Whether the person is full time or part time |
Government Num | FI_GOVERNMENT_NUM | no | 0 | 40 | PERSON.GOVERNMENT_NUM | Used to update the government_num column in the person table. | ||
Hire Date | FI_HIRE_DATE | no | 0 | PERSON.HIRE_DATE | Used to update the hire_date column in the person table. | |||
Ignore Current Badge Assignment | FI_IGNORE_CURRENT_BADGE_ASSIGNMENT | no | 0 | 40 | N | Valid values are 'Y' (Yes) or 'N' (No) | If 'Y', does not stop processing if the badge is currently assigned to the current person. | |
Last Name | FI_LAST_NAME | no | 0 | 40 | PERSON.LAST_NAME | Used to update the last_name column in the person table. | ||
Login Name | FI_LOGIN_NAME | no | 0 | 40 | PERSON.LOGIN_NAME | Used to update the login_name column in the person table. Value is saved only when it is Unique(should not be associated with another Active Person) or it belongs to an existing Inactive Person(Login Name of the Inactive person is blanked out first and then the Login Name is set for this person). | ||
Manager Num | FI_MANAGER_NUM | no | 0 | 40 | PERSON_GROUP.PERSON_GROUP_NAME, PERSON_GROUP_MANAGER.MANAGER_ID | If the FI_MANAGER_NUM is not populated, no person group, person group member or person group manager record will be created or updated. | If the FI_MANAGER_NUM is populated, a new person group, person group member or person group manager record will be created or updated. The FI_MANAGER_NUM prompt is used to populate the manager_id column in the person_group_manager table. | |
Middle Name | FI_MIDDLE_NAME | no | 0 | 40 | PERSON.MIDDLE_NAME | Used to update the middle_name column in the person table. | ||
Person Type | FI_PERSON_TYPE | no | 0 | 40 | PERSON.PERSON_TYPE, PERSON_EMPLOYEE_PROFILE.PERSON_TYPE | EMPLOYEE | Used to update the person_type column in the person table. | |
Pin | FI_PIN | no | 0 | 40 | PERSON_PIN.PIN | Used to create or modify to person_pin associated with the person record. | ||
Preferred Name | FI_PREFERRED_NAME | no | 0 | 40 | PERSON.PREFERRED_NAME | Used to update the preferred_name column in the person table. | ||
Rcd Num | FI_RCD_NUM | no | 0 | 40 | PERSON.RCD_NUM | 0 | Used to identify the person. | |
Record Status | FI_RECORD_STATUS | no | 0 | 1 | PERSON.RECORD_STATUS | A | Valid Values are 'A' or 'I' | Used to update the record status column in the person table. The record status column is used to determine if the person record is Active (A) or Inactive (I). |
Rehire Date | FI_REHIRE_DATE | no | 0 | PERSON.REHIRE_DATE | Format is yyyyMMdd. For example, 20101231 | Used to update the rehire date column in the person table. | ||
Sender Name | FI_SENDER_NAME | no | 0 | 40 | PERSON.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Used to update the sender_name column in the person table. | |
Service Date | FI_SERVICE_DATE | no | 0 | PERSON.SERVICE_DATE | Format is yyyyMMdd. For example, 20101231 | Used to update the service date column in the person table. | ||
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current record. | |
Start Date | FI_START_DATE | no | 0 | PERSON_GROUP.START_DATE, PERSON_GROUP_MEMBER.START_DATE, PERSON_GROUP_MANAGER.START_DATE, PERSON_BADGE.START_DATE, PERSON_EMPLOYEE_PROFILE.START_DATE | 19700101 | Format is yyyyMMdd. For example, 19700101 | In the person_group_member table, the start_date is only used if FI_MANAGER_NUM is not empty and as part of the insertion for DIRECT_MANAGER person_group_member record. When creating a new person_group DIRECT_MANAGER using the person interface, the start_date of the person_group and person_group_manager will always be '1970-01-01'. In the person_badge table, start_date is used during the insertion of a person_badge record if the FI_START_TIMESTAMP prompt is not set. The end_date could also be used during the insertion of the person_employee_profile record. | |
Start Timestamp | FI_START_TIMESTAMP | no | 0 | PERSON_BADGE.START_DATE | 19700101 | Format is yyyyMMddHHmmss. For example, 99991231120000 | In the person_badge record, the start_timestamp is used during the insertion of a badge. | |
Suffix | FI_SUFFIX | no | 0 | 6 | PERSON.SUFFIX | Used to update the suffix column in the person table. | ||
Supervisor Role Name | FI_SUPERVISOR_ROLE_NAME | no | 0 | 40 | PERSON_GROUP_MANAGER.MANAGER_ROLE_NAME | Role name for a given person. | ||
Time Entry Type | FI_TIME_ENTRY_TYPE | no | 0 | 1 | PERSON.TIME_ENTRY_TYPE | 1 | Valid values include 1,2,3,4 | 1 (PUNCHED) - Punch Entry, 2 (EXCEPTION) - Exception or Automatic Entry, 3 (ELAPSED) - Elapsed Entry Type, 4 (NONE) - One cannot enter time at all from anywhere. Please note that if the employee categories module is enabled then the FI_ATTENDANCE_ENTRY_TYPE prompt value takes precedence over the value in the FI_TIME_ENTRY_TYPE |
Version Num | FI_VERSION_NUM | no | 0 | 15 | BADGE.VERSION_NUM | 0 | Version Num is used to provide users with the ability to have multiple badge numbers with different version numbers. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Adhoc (INTERFACE_PERSON_ADHOC) | |
---|---|
Type | 2000 |
Description | This interface populates person ad-hoc. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1106 - Insert/Update Person Ad-Hoc records |
Person Adhoc (INTERFACE_PERSON_ADHOC) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Code Name | FI_CODE_NAME | yes | 0 | 40 | PERSON_ADHOC.CODE_NAME | Adds or updates person ad-hoc code name. | ||
Code Value | FI_CODE_VALUE | yes | 0 | 80 | PERSON_ADHOC.CODE_VALUE | Adds or updates personad-hoc code value. | ||
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_ADHOC.PERSON_ID | If this is supplied, must be a valid person or the person ad-hoc record will not get created. | New person ad-hoc record will be created, or an existing ad-hoc/code name pair will be updated. | |
Record Status | FI_RECORD_STATUS | yes | 0 | 1 | PERSON_ADHOC.RECORD_STATUS | A | Indicates the record status (e.g. Active or Inactive). | |
Action | FI_ACTION | no | 0 | 1 | PERSON_ADHOC.CODE_NAME | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete a person ad-hoc setting. |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Assignment (INTERFACE_PERSON_ASSIGNMENT) | |
---|---|
Type | 2000 |
Description | This interface populate person assignment. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1059 - Insert/Update Person Assignment records |
Person Assignment (INTERFACE_PERSON_ASSIGNMENT) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Assignment Type | FI_ASSIGNMENT_TYPE | yes | 0 | 40 | PERSON_ASSIGNMENT.ASSIGNMENT_TYPE | Adds or updates person assignment record for given assignment type. | ||
Assignment Value | FI_ASSIGNMENT_VALUE | yes | 0 | 80 | PERSON_ASSIGNMENT.ASSIGNMENT_VALUE | Adds or updates person_assignment.assignment_value for given assignment type. | ||
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_ASSIGNMENT.PERSON_ID | If this is supplied, must be a valid person or the person assignment will not get created. | If populated, person (based on person number), new person assignment record will be created. | |
Action | FI_ACTION | no | 0 | 1 | PERSON_ASSIGNMENT.ASSIGNMENT_TYPE | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the person assignment. For A, when F_OVERRIDE_ASSIGNMENT = 0, an add is done with FI_LEVEL_NUM = 0, overlapping records will be changed so that no overlaps occur. For A, when F_OVERRIDE_ASSIGNMENT = 1, an add is done with the value of max FI_LEVEL_NUM + 1 for FI_LEVEL_NUM. For U, when F_OVERRIDE_ASSIGNMENT = 0, an update is done with FI_LEVEL_NUM = 0, overlapping records will be changed so that no overlaps occur. FI_START_DATE is used as effective date. For U, when F_OVERRIDE_ASSIGNMENT = 1, an add is done with the value of max FI_LEVEL_NUM + 1 for FI_LEVEL_NUM. For D, when F_OVERRIDE_ASSIGNMENT = 0, a delete is done using supplied FI_START_DATE as effective date and FI_LEVEL_NUM of 0, which deletes a default record using effective date. When F_OVERRIDE_ASSIGNMENT = 1, a delete is done using supplied F_START_DATE as effective date and FI_LEVEL_NUM (must be > 0) to determine which record to delete. The record is deleted from the database on passing the value as 'D'. |
Applicable Date | FI_APPLICABLE_DATE | no | 0 | 20 | Current Date | Format is yyyyMMdd. For example, 99991231. This value only applies if smart update is set to 'Y' | This is used to find the record that needs to be updated based on the applicable date. | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 40 | SYSTEM | The valid values come from the shift definition table where the values shift_id, shift_num, data_group_name and description are distinct | This field is required only for Assignment Type of Shift. | |
End Date | FI_END_DATE | no | 0 | PERSON_ASSIGNMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 99991231 | This prompt value is used to populate the start date column in the person_setting. | |
Exclusive Hierarchy Assignment | FI_EXCLUSIVE_HIERARCHY_ASSIGNMENT | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This prompt is now deprecated. It will not affect processing regardless of whether it's set to 'Y' or 'N'. If the assignment is a hierarchy assignment and the FI_OVERRIDE_ASSIGNMENT_FLAG prompt is set to true 0 (not override) then the record will end date person group membership of hierarchy type for all existing records to which the employee currently belongs and the new record inserted. If the assignment is a hierarchy assignment and FI_OVERRIDE_ASSIGNMENT_FLAG is set to 1 then the record will not affect person group membership. | |
Override Assignment Flag | FI_OVERRIDE_ASSIGNMENT_FLAG | no | 0 | 1 | PERSON_ASSIGNMENT.FI_OVERRIDE_ASSIGNMENT_FLAG | 0 | Valid values are '0' for false (not override) and '1' for true (is override). | This field defines if the assignment is and Override or Default assignment. When override is true, only action codes A and D are applicable, U is treated as A. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current record. | |
Start Date | FI_START_DATE | no | 0 | PERSON_ASSIGNMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 19700101 | This prompt value is used to populate the start date for Person Assignment. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Authorized Hours (INTERFACE_PERSON_AUTHORIZED_HOURS) | |
---|---|
Type | 2000 |
Description | This interface populates person authorized hours (EWT and Comp Time). |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1115 - Validation to populate Person Authorized Hours records |
Person Authorized Hours (INTERFACE_PERSON_AUTHORIZED_HOURS) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Duration | FI_DURATION | yes | 0 | PERSON_AUTHORIZED_HOURS.DURATION | Must be greater than zero for add, or may be zero for update and delete | Identifies the number of hours to be authorized. This value is converted into seconds in the system. | ||
Hours Type | FI_HOURS_TYPE | yes | 0 | PERSON_AUTHORIZED_HOURS.HOURS_TYPE | Must be one of the valid hours types: EWT_HOURS or COMP_TIME_HOURS | Identifies the type of hours being authorized. If this value is not one of the valid values, an error will be logged and a new record will not be created. | ||
Pay Period Date | FI_PAY_PERIOD_DATE | yes | 0 | PERSON_AUTHORIZED_HOURS.START_DATE | Must be a valid date of the form yyyyMMdd | This date will be used to determine the date range over which the authorized hours will apply. | ||
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_AUTHORIZED_HOURS.PERSON_ID | Must be a valid person number, or the person authorized hours record will not get created. | New person authorized hours record will be created, or an existing record will be updated. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete a person authorized hours record. |
Person Direct Manager (INTERFACE_PERSON_DIRECT_MANAGER) | |
---|---|
Type | 2000 |
Description | This interface populates (person) direct manager. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1107 - Insert/Update Person Direct Manager records |
Person Direct Manager (INTERFACE_PERSON_DIRECT_MANAGER) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Manager Num | FI_MANAGER_NUM | yes | 0 | 40 | PERSON_GROUP_MANAGER.MANAGER_ID | The person number of the direct manager. If a person record for this manager does not yet exist (e.g. hasn’t been loaded yet), we create a placeholder for it so that this person’s group record can be created. | ||
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_GROUP_MEMBER.PERSON_ID | This must be a valid person in the person table or no record will be created. | If populated, person (based on person number), new person manager record will be created. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the person's direct manager. | |
End Date | FI_END_DATE | no | 0 | 8 | PERSON_GROUP_MEMBER.END_DATE | 99991231 | Format is yyyyMMdd. For example, 99991231. | The end date of the person’s membership in the group (i.e. the date that the manger stopped being the person’s direct manager) |
Exclusive Direct Group | FI_EXCLUSIVE_DIRECT_GROUP | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | If the FI_EXCLUSIVE_DIRECT_GROUP prompt is set to true ('Y'es) then end date person group membership of hierarchy type for all existing records to which the employee currently belongs and the new record inserted. If the prompt is set to false then do nothing. | |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current record. | |
Start Date | FI_START_DATE | no | 0 | 8 | PERSON_GROUP_MEMBER.START_DATE | Current Date | Format is yyyyMMdd. For example, 19700101 | The start date of the person’s membership in the group (i.e. the date that the manger became the person’s direct manager) |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Group (INTERFACE_PERSON_GROUP) | |
---|---|
Type | 2000 |
Description | Interface event used to load person group along with person group members and person group managers. Supports only incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1050 - Interface Group Validation |
Person Group (INTERFACE_PERSON_GROUP) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Person Group Name | FI_PERSON_GROUP_NAME | yes | 0 | 40 | PERSON_GROUP.PERSON_GROUP_NAME | Name of the group to create/update. | ||
Person Group Type | FI_PERSON_GROUP_TYPE | yes | 0 | 40 | PERSON_GROUP.PERSON_GROUP_TYPE | The following group types are available: DIRECT_MANAGER, EVENT_FILTRATION, FACILITY, MESSAGE_GROUP, POLICY_GROUP, SERVICE_GROUP, SUPERVISOR_MANAGER and TERMINAL_FILTRATION | Type of group to create/update | |
Action | FI_ACTION | no | 0 | 1 | PERSON_GROUP.PERSON_GROUP_NAME | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or deleting the person group. The record is deleted from the database on passing the value as 'D'. |
Applicable Date | FI_APPLICABLE_DATE | no | 0 | 20 | Current Date | Format is yyyyMMdd. For example, 99991231. This value only applies if smart update is set to 'Y' | This is used to find the record that needs to be updated based on the applicable date. | |
Description | FI_DESCRIPTION | no | 0 | 80 | PERSON_GROUP.DESCRIPTION | Description of the group | ||
End Date | FI_END_DATE | no | 0 | PERSON_GROUP.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Used for effective end date of the group. | |
Exclusive Direct Group | FI_EXCLUSIVE_DIRECT_GROUP | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | If the FI_EXCLUSIVE_DIRECT_GROUP prompt is set to true ('Y'es) then end date person group membership for all existing records to which the employee currently belongs and the new record inserted. If the prompt is set to false then do nothing. | |
Exclusive Filtration Group | FI_EXCLUSIVE_FILTRATION_GROUP | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | If the FI_EXCLUSIVE_FILTRATION_GROUP prompt is set to true ('Y'es) then end date person group membership for all existing records to which the employee currently belongs and the new record inserted. If the prompt is set to false then do nothing. | |
Is Manager | FI_IS_MANAGER | no | 0 | 1 | N | Valid values are 'Y' or 'N' | If this is set to 'Y' and the 'Person Num' is supplied, the person is added as a manager of the group | |
Person End Date | FI_PERSON_END_DATE | no | 0 | PERSON_GROUP_MEMBER.END_DATE, PERSON_GROUP_MANAGER.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Used for effective end date of person membership and management in the group. For a Direct Manager Type, the group end date and the manager end date should be same. So this value will be ignored and the End Date will be considered. | |
Person Num | FI_PERSON_NUM | no | 0 | 40 | PERSON_GROUP_MEMBER.PERSON_ID, PERSON_GROUP_MANAGER.PERSON_ID | If this is supplied, must be a valid person or the group will not get created. | If populated, person (based on person number), becomes a member of the group. If the 'Is Manager' is set with a value of 'Y', the person becomes a manager of the group. 'Person Start Date' and 'Person End Date' are used for effectivity of both membership and management. | |
Person Start Date | FI_PERSON_START_DATE | no | 0 | PERSON_GROUP_MEMBER.START_DATE, PERSON_GROUP_MANAGER.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Used for effective start date of person membership and management in the group. For a Direct Manager Type, the group start date and the manager start date should be same. So this value will be ignored and the Start Date will be considered. | |
Rcd Num | FI_RCD_NUM | no | 0 | 40 | PERSON_GROUP_MEMBER.PERSON_ID, PERSON_GROUP_MANAGER.PERSON_ID | 0 | Used to identify the person. | |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current record. | |
Start Date | FI_START_DATE | no | 0 | PERSON_GROUP.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Used for effective start date of the group. | |
Supervisor Role Name | FI_SUPERVISOR_ROLE_NAME | no | 0 | 40 | PERSON_GROUP_MANAGER.MANAGER_ROLE_NAME | Role name for a given person. | ||
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Pay Scale (INTERFACE_PERSON_PAY_SCALE) | |
---|---|
Type | 2000 |
Description | This interface populate Person Pay Scale. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 100032 - Person Pay Scale Validation |
Person Pay Scale (INTERFACE_PERSON_PAY_SCALE) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_PAY_SCALE.PERSON_ID | Must be a valid person number or the person pay scale will not get created. | Person Id is stored internally based on the Person Number. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the person pay scale. The record is deleted from the database on passing the value as 'D'. | |
End Date | FI_END_DATE | no | 0 | PERSON_PAY_SCALE.END_DATE | 99991231 | Format is yyyyMMdd. For example, 99991231 | This prompt value is used to populate the end date column in the person_pay_scale. For Default record type value is set internally to an infinity date of 99991231 and it cannot be changed. | |
No Pay Scale Flag | FI_NO_PAY_SCALE_FLAG | no | 0 | 1 | PERSON_PAY_SCALE.NO_PAY_SCALE_FLAG | 0 | Should be a number. | Flag indicates weather to consider the Pay Scale data. Value 0 indicates that the Pay Scale data is not required. |
Pay Class | FI_PAY_CLASS | no | 0 | 40 | PERSON_PAY_SCALE.PAY_CLASS | Value is required when the no_pay_scale_flag is not enabled. A valid Pay class is required. | ||
Pay Level | FI_PAY_LEVEL | no | 0 | PERSON_PAY_SCALE.PAY_LEVEL | Should be a number | Value is required when the no_pay_scale_flag is not enabled. A valid Pay level is required. | ||
Pay Scale Name | FI_PAY_SCALE_NAME | no | 0 | 40 | PERSON_PAY_SCALE.PAY_SCALE_NAME | Value is required when the no_pay_scale_flag is not enabled. A valid Pay Scale Name is required. | ||
Record Type Ind | FI_RECORD_TYPE_IND | no | 0 | 1 | PERSON_PAY_SCALE.RECORD_TYPE_ID | D | Valid values are 'D' (Default),'O' (Override). | User to determine weather the record is Default or Override. |
Start Date | FI_START_DATE | no | 0 | PERSON_PAY_SCALE.START_DATE | 19700101 | Format is yyyyMMdd. For example, 19700101 | This prompt value is used to populate the start date column in the person_pay_scale. For Default record type value is set internally to 19700101 and it cannot be changed. |
Person Schedule (INTERFACE_PERSON_SCHEDULE) | |
---|---|
Type | 2000 |
Description | Interface event used to load person schedule data. Supports full syncronization and incremental syncronization |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1042 - Interface Person Schedule Validation |
Person Schedule (INTERFACE_PERSON_SCHEDULE) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
End Timestamp | FI_END_TIMESTAMP | yes | 0 | PERSON_SCHEDULE.END_TIMESTAMP | Format is yyyyMMdd. For example, 99991231 | This value must be provided or a record will not be created. | ||
Person Num | FI_PERSON_NUM | yes | 0 | 40 | Must be a valid person number mapping to a valid person id. | Used to identify the person. If this value is not supplied a valid person id can not be derived and a record will not be created. | ||
Post Date | FI_POST_DATE | yes | 0 | PERSON_SCHEDULE.POST_DATE | Format is yyyyMMdd. For example, 99991231 | If this value is not supplied a schedule record will not be created. | ||
Start Timestamp | FI_START_TIMESTAMP | yes | 0 | PERSON_SCHEDULE.START_TIMESTAMP | Format is yyyyMMdd. For example, 99991231 | This value must be provided or a record will not be created. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the person schedule. The record is deleted from the database on passing the value as 'D'. | |
Ad Hoc Type | FI_AD_HOC_TYPE | no | 0 | 40 | PERSON_SCHEDULE.ADHOC_TYPE | Valid values are BY_CLOCK and VIRTUAL. | Virtual means that the time reporter’s schedule set on the most previous post date that is NOT identified as a Gap Day shall be copied to the new date. By Clock means When the user clocks in, the system will find the records in this configuration that corresponds to the period containing the time stamp of the clock in. | |
App End Offset | FI_APP_END_OFFSET | no | 0 | 60 | The default value of 60 is in minutes. If End Time Stamp and Applicable End Time Stamp are the same, the Application End Offset value is substracted from the End Time Stamp and used as the value for the Applicable End Time Stamp. | |||
App End Timestamp | FI_APP_END_TIMESTAMP | no | 0 | PERSON_SCHEDULE.APP_END_TIMESTAMP | If not supplied, uses the value from the End Timestamp prompt. | Format is yyyyMMdd. For example, 99991231 | If End Timestamp and Applicable End Timestamp are the same, the Application End Offset value is substracted from the End Timestamp and used as the value for the Applicable End Timestamp prompt. | |
App Start Offset | FI_APP_START_OFFSET | no | 0 | 60 | The default value of 60 is in minutes. If Start Time Stamp and Applicable Start Time Stamp are the same, the Application Start Offset value is substracted from the Start Time Stamp and used as the value for the Applicable Start Time Stamp. | |||
App Start Timestamp | FI_APP_START_TIMESTAMP | no | 0 | PERSON_SCHEDULE.APP_START_TIMESTAMP | If not supplied, uses the value from the Start Timestamp prompt. | Format is yyyyMMdd. For example, 99991231 | If Start Timestamp and Applicable Start Timestamp are the same, the Application Start Offset value is substracted from the Start Timestamp and used as the value for the Applicable Start Timestamp prompt. | |
Availability Type | FI_AVAILABILITY_TYPE | no | 0 | 40 | PERSON_SCHEDULE.AVAILABILITY_TYPE | WORKING | The valid values are WORKING, NOT_WORKING, AVAILABLE and UNAVAILABLE. | This field controls when Normal, Exclusion and Optional Schedules can be made for a time reporter. |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 40 | The valid values come from the shift definition table where the values shift_id, shift_num, data_group_name and description are distinct | This field is required only for Shift creation. | ||
Description | FI_DESCRIPTION | no | 0 | 80 | PERSON_SCHEDULE.DESCRIPTION | This value is used to provide a descriptive summary of the schedule created. | ||
End Early Margin | FI_END_EARLY_MARGIN | no | 0 | PERSON_SCHEDULE.END_EARLY_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the end timestamp prompt. For example a 10 minute end early margin with a 6:00 PM end timestamp means the employee can perform an action 'early' between 5:50PM and 6:00PM without a violation occurring. | ||
End Late Margin | FI_END_LATE_MARGIN | no | 0 | PERSON_SCHEDULE.END_LATE_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the end timestamp prompt. For example a 10 minute end late margin with a 6:00 PM end timestamp means the employee can perform an action 'late' between 6:00PM and 6:10PM without a violation occurring. | ||
Error On App Overlap | FI_ERROR_ON_APP_OVERLAP | no | 0 | 40 | ERROR | Valid values are ERROR or SPLIT | Used during interface download that lets the incoming schedules to not be inserted if there is an overlap with existing applicable part of the schedule. When set to SPLIT the schedule is inserted with a split between applicable end of old and applicable start of new schedule. | |
Error On Overlap | FI_ERROR_ON_OVERLAP | no | 0 | 40 | No | Valid values are Yes or No | Flag used during interface download that lets the incoming schedules to not be inserted if there is an overlap with existing schedules. | |
Gap Day Num | FI_GAP_DAY_NUM | no | 0 | PERSON_SCHEDULE.GAP_DAY_NUM | 0 | This value determines wheather the schedule for the posting date is on a gap day and the number of the gap day. Non-gap days have a value of zero as gap days have a value greater than or equal to 1. | ||
Is Elapsed Flag | FI_IS_ELAPSED_FLAG | no | 0 | 1 | PERSON_SCHEDULE.IS_ELAPSED_FLAG | 0 | This field defines that the entry method used will be only the elapsed entry method. | |
Is Holiday Ot Flag | FI_IS_HOLIDAY_OT_FLAG | no | 0 | 1 | PERSON_SCHEDULE.IS_HOLIDAY_OT_FLAG | 0 | Valid values are '0' for no holiday overtime and '1' for holiday overtime. | This field defines if the schedule applies to holiday overtime. |
Locale | FI_LOCALE | no | 0 | 40 | PERSON_SCHEDULE.LOCALE | none | ||
Mandatory Ind | FI_MANDATORY_IND | no | 0 | 1 | PERSON_SCHEDULE.MANDATORY_IND | M | Valid values are 'M' (MANDATORY) and 'O' (OPTIONAL). | Employee must adhere to the schedule if the schedule is mandatory while there are no consequences to not adhering to the schedule if the schedule is optional. |
Ot Type | FI_OT_TYPE | no | 0 | 10 | PERSON_SCHEDULE.OT_TYPE | The valid values are GAP_DAY, PRE_SHIFT and POST_SHIFT | This value is used to determine the overtime type the schedule applies to. | |
Pay Period Offset | FI_PAY_PERIOD_OFFSET | no | 0 | 2 | PERSON_SCHEDULE.PAY_PERIOD_OFFSET | 0 | The valid values are '0' (CURRENT), '-1' (PREVIOUS) and '1' (NEXT). | Usually for a 9/80 schedule, this field specifies that time in this schedule goes into the week /pay period 'bucket' for the current, next, or previous week/pay period, and displays with that current, next or previous week/pay period. |
Pay Week Offset | FI_PAY_WEEK_OFFSET | no | 0 | 2 | PERSON_SCHEDULE.PAY_WEEK_OFFSET | 0 | The valid values are '0' (CURRENT), '-1' (PREVIOUS) and '1' (NEXT). | Usually for a 9/80 schedule, this field specifies that time in this schedule goes into the week /pay period 'bucket' for the current, next, or previous week/pay period, and displays with that current, next or previous week/pay period. |
Protected Flag | FI_PROTECTED_FLAG | no | 0 | 1 | PERSON_SCHEDULE.PROTECTED_FLAG | 0 | Valid values are '0' for not protected and '1' for protected. | This value is used to execute protection violations. |
Schedule Type | FI_SCHEDULE_TYPE | no | 0 | 40 | PERSON_SCHEDULE.SCHEDULE_TYPE | NORMAL | Valid values are NORMAL, EXCLUSION, OPTIONAL, AD_HOC_P and AVAILABILITY. | This value is used to determine the type of the schedule to be created. |
Shift Num | FI_SHIFT_NUM | no | 0 | The valid values come from the shift definition table where the values shift_id, shift_num, data_group_name and description are distinct | This field is required only for Shift creation. | |||
Short Shift Amount | FI_SHORT_SHIFT_AMOUNT | no | 0 | PERSON_SCHEDULE.SHORT_SHIFT_AMOUNT | 0.0 | |||
Split Day Ind | FI_SPLIT_DAY_IND | no | 0 | 1 | PERSON_SCHEDULE.SPLIT_DAY_IND | N | The valid values are 'N' (NO SPLIT), 'F' (FIRST HALF) and 'S' (SECOND HALF). | Split day refers to the 9-80 schedule. |
Start Early Margin | FI_START_EARLY_MARGIN | no | 0 | PERSON_SCHEDULE.START_EARLY_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the start timestamp prompt. For example a 10 minute start early margin with a 10:00 AM start timestamp means the employee can perform an action 'early' between 9:50AM and 10:00AM without a violation occurring. | ||
Start Late Margin | FI_START_LATE_MARGIN | no | 0 | PERSON_SCHEDULE.START_LATE_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the start timestamp prompt. For example a 10 minute start late margin with a 10:00 AM start timestamp means the employee can perform an action 'late' between 10:00AM and 10:10AM without a violation occurring. | ||
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Schedule Event (INTERFACE_PERSON_SCHEDULE_EVENT) | |
---|---|
Type | 2000 |
Description | Interface event used to load person schedule event data. Supports full syncronization and incremental syncronization |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1043 - Interface Person Schedule Event Validation |
Person Schedule Event (INTERFACE_PERSON_SCHEDULE_EVENT) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Event End Timestamp | FI_EVENT_END_TIMESTAMP | yes | 0 | PERSON_SCHEDULE_EVENT.END_TIMESTAMP | The default is 19700101 Plus the value of the Start Late Margin if Event Basis Indirect prompt value is 'Offset' even if the value was supplied. | Format is yyyyMMdd. For example, 99991231 | If action type is not 'D' and the event basis ind is strict then end timestamp must be provided for a record to be created. | |
Event Name | FI_EVENT_NAME | yes | 0 | 40 | PERSON_SCHEDULE_EVENT.EVENT_NAME | The valid values are the names of the events of type 'Attendance' that are active and whose Event Type Id is 3002 or 3003. | This value must be supplied or a record will not be created. | |
Event Start Timestamp | FI_EVENT_START_TIMESTAMP | yes | 0 | PERSON_SCHEDULE_EVENT.START_TIMESTAMP | The default is 19700101 if Event Basis Indirect prompt value is 'Offset' even if the value was supplied. | Format is yyyyMMdd. For example, 99991231 | The Start Timestamp must be supplied or a record will not be created. | |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | Must be a valid person number mapping to a valid person id. | Used to identify the person. If this value is not supplied a valid person id can not be derived and a record will not be created. A schedule must exist for this person number, schedule type, post date and schedule start timestamp combinationn for a record to be created. | ||
Post Date | FI_POST_DATE | yes | 0 | PERSON_SCHEDULE.POST_DATE | Format is yyyyMMdd. For example, 99991231 | If this value is not supplied a schedule record will not be created. A schedule must exist for this person number, schedule type, post date and schedule start timestamp combinationn for a record to be created. | ||
Schedule Start Timestamp | FI_SCHEDULE_START_TIMESTAMP | yes | 0 | PERSON_SCHEDULE.START_TIMESTAMP | Format is yyyyMMdd. For example, 99991231 | This value must be provided or a record will not be created. A schedule must exist for this person number, schedule type, post date and schedule start timestamp combinationn for a record to be created. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the person schedule event. The record is deleted from the database on passing the value as 'D'. | |
Auto Event Ind | FI_AUTO_EVENT_IND | no | 0 | 1 | PERSON_SCHEDULE_EVENT.AUTO_EVENT_IND | P | The valid values are 'A' (AUTO), 'P' (PUNCH) and 'O' (OVERRIDE). | Defines how the event will post. |
Event Basis Ind | FI_EVENT_BASIS_IND | no | 0 | 1 | PERSON_SCHEDULE_EVENT.EVENT_BASIS_IND | S | The valid values are 'S' (Strict) and 'O' (Offset). | Split day refers to the 9-80 schedule. |
Event End Early Margin | FI_EVENT_END_EARLY_MARGIN | no | 0 | PERSON_SCHEDULE_EVENT.END_EARLY_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the end timestamp prompt. For example a 10 minute end early margin with a 6:00 PM end timestamp means the employee can perform an action 'early' between 5:50PM and 6:00PM without a violation occurring. | ||
Event End Late Margin | FI_EVENT_END_LATE_MARGIN | no | 0 | PERSON_SCHEDULE_EVENT.END_LATE_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the end timestamp prompt. For example a 10 minute end late margin with a 6:00 PM end timestamp means the employee can perform an action 'late' between 6:00PM and 6:10PM without a violation occurring. | ||
Event End Offset | FI_EVENT_END_OFFSET | no | 0 | PERSON_SCHEDULE_EVENT.END_OFFSET | 0 | if Action Type is not 'D' and the Event Basis Ind is 'Offset' then the Start Offset must be less than the End Offset. | ||
Event Start Early Margin | FI_EVENT_START_EARLY_MARGIN | no | 0 | PERSON_SCHEDULE_EVENT.START_EARLY_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the start timestamp prompt. For example a 10 minute start early margin with a 10:00 AM start timestamp means the employee can perform an action 'early' between 9:50AM and 10:00AM without a violation occurring. | ||
Event Start Late Margin | FI_EVENT_START_LATE_MARGIN | no | 0 | PERSON_SCHEDULE_EVENT.START_LATE_MARGIN | 900 | The default value of 900 is in seconds. This number is used to define the time range within the time reporter can perform an action. It is calculated relative to the start timestamp prompt. For example a 10 minute start late margin with a 10:00 AM start timestamp means the employee can perform an action 'late' between 10:00AM and 10:10AM without a violation occurring. | ||
Event Start Offset | FI_EVENT_START_OFFSET | no | 0 | PERSON_SCHEDULE_EVENT.START_OFFSET | 0 | if Action Type is not 'D' and the Event Basis Ind is 'Offset' then the Start Offset must be less than the End Offset. If the Action Type is 'D' and the Event Basis is not 'Strict' then the Start Offset must be greater than zero for a record to be created. | ||
Required Ind | FI_REQUIRED_IND | no | 0 | 1 | PERSON_SCHEDULE_EVENT.REQUIRED_IND | M | The valid values are 'S' (Strict) and 'O' (Offset). | Defines wheather the event is required or there will be violations. |
Schedule Type | FI_SCHEDULE_TYPE | no | 0 | 40 | PERSON_SCHEDULE.SCHEDULE_TYPE | NORMAL | Valid values are NORMAL, EXCLUSION, OPTIONAL, AD_HOC_P (for AD HOC PLACEHOLDER), and AVAILABILITY | This value is used to determine the type of the schedule to be created. A schedule must exist for this person number, schedule type, post date and schedule start timestamp combinationn for a record to be created. |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Person Setting (INTERFACE_PERSON_SETTING) | |
---|---|
Type | 2000 |
Description | This interface populate person setting. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1058 - Insert/Update Person Setting records |
Person Setting (INTERFACE_PERSON_SETTING) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_SETTING.PERSON_ID | If this is supplied, must be a valid person or the person setting will not get created. | If populated, person (based on person number), new person setting record will be created. | |
Setting Type | FI_SETTING_TYPE | yes | 0 | 40 | PERSON_SETTING.SETTING_TYPE | Adds or updates person setting record for given setting type. | ||
Setting Value | FI_SETTING_VALUE | yes | 0 | 40 | PERSON_SETTING.SETTING_VALUE | Adds or updates person_setting.setting_value for given setting type. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the person setting. The record is deleted from the database on passing the value as 'D'. | |
Applicable Date | FI_APPLICABLE_DATE | no | 0 | 20 | Current Date | Format is yyyyMMdd. For example, 99991231. This value only applies if smart update is set to 'Y' | This is used to find the record that needs to be updated based on the applicable date. | |
Effective Date | FI_EFFECTIVE_DATE | no | 0 | Format is yyyyMMdd. For example, 99991231. For Update and Delete of records value is required and if no value is passed then it is an error. | This prompt value is used to identify the record that needs to be updated or deleted. | |||
End Date | FI_END_DATE | no | 0 | PERSON_SETTING.END_DATE | 99991231 | Format is yyyyMMdd. For example, 99991231 | This prompt value is used to populate the end date column in the person_setting. | |
Smart Create | FI_SMART_CREATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart create should be applied to the current record. Applies only for Setting Type - charge filtration group. | |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current record. | |
Start Date | FI_START_DATE | no | 0 | PERSON_SETTING.START_DATE | 19700101 | Format is yyyyMMdd. For example, 19700101 | This prompt value is used to populate the start date column in the person_setting. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Task (INTERFACE_PROJECT) | |
---|---|
Type | 2000 |
Description | Interface event used to load Task data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1018 - Insert/Update Charge Element records |
Task (INTERFACE_PROJECT) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_ELEMENT.CHARGE_TYPE | The default value will be derived from the specified level number. | This value must be a valid and active charge type in the Charge Type table or no record will be created | This value is used to map the charge type to the level number and element name supplied. This value must be supplied for charge element filtration purposes. |
Element Name | FI_ELEMENT_NAME | yes | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The default value will be derived from the specified charge type. | This value must be a valid element name in the Charge Type table or no record will be created | This value is used to map the element name to the charge type. This value must be supplied for a record to be created. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_VALUE | Each new element must have a parent's lev | This value must be supplied for a record to be created. | |
Charge Element End Date | FI_CHARGE_ELEMENT_END_DATE | no | 0 | CHARGE_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Charge Element End Date | |
Charge Element Start Date | FI_CHARGE_ELEMENT_START_DATE | no | 0 | CHARGE_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Charge Element Start Date | |
Charge Filtration Group1 | FI_CHARGE_FILTRATION_GROUP1 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group2 | FI_CHARGE_FILTRATION_GROUP2 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group3 | FI_CHARGE_FILTRATION_GROUP3 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group4 | FI_CHARGE_FILTRATION_GROUP4 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group5 | FI_CHARGE_FILTRATION_GROUP5 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group End Date1 | FI_CHARGE_FILTRATION_GROUP_END_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date2 | FI_CHARGE_FILTRATION_GROUP_END_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date3 | FI_CHARGE_FILTRATION_GROUP_END_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date4 | FI_CHARGE_FILTRATION_GROUP_END_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date5 | FI_CHARGE_FILTRATION_GROUP_END_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group Start Date1 | FI_CHARGE_FILTRATION_GROUP_START_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date2 | FI_CHARGE_FILTRATION_GROUP_START_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date3 | FI_CHARGE_FILTRATION_GROUP_START_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date4 | FI_CHARGE_FILTRATION_GROUP_START_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date5 | FI_CHARGE_FILTRATION_GROUP_START_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | CHARGE_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Description | FI_DESCRIPTION | no | 0 | 80 | CHARGE_ELEMENT.DESCRIPTION | Description of the Department | ||
Flex Field Name1 | FI_FLEX_FIELD_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name10 | FI_FLEX_FIELD_NAME10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME10 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name11 | FI_FLEX_FIELD_NAME11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME11 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name12 | FI_FLEX_FIELD_NAME12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME12 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name13 | FI_FLEX_FIELD_NAME13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME13 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name14 | FI_FLEX_FIELD_NAME14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME14 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name15 | FI_FLEX_FIELD_NAME15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME15 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name2 | FI_FLEX_FIELD_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name3 | FI_FLEX_FIELD_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name4 | FI_FLEX_FIELD_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name5 | FI_FLEX_FIELD_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name6 | FI_FLEX_FIELD_NAME6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name7 | FI_FLEX_FIELD_NAME7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME7 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name8 | FI_FLEX_FIELD_NAME8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME8 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name9 | FI_FLEX_FIELD_NAME9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME9 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Value1 | FI_FLEX_FIELD_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value10 | FI_FLEX_FIELD_VALUE10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE10 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value11 | FI_FLEX_FIELD_VALUE11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE11 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value12 | FI_FLEX_FIELD_VALUE12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE12 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value13 | FI_FLEX_FIELD_VALUE13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE13 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value14 | FI_FLEX_FIELD_VALUE14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE14 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value15 | FI_FLEX_FIELD_VALUE15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE15 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value2 | FI_FLEX_FIELD_VALUE2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value3 | FI_FLEX_FIELD_VALUE3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value4 | FI_FLEX_FIELD_VALUE4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value5 | FI_FLEX_FIELD_VALUE5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value6 | FI_FLEX_FIELD_VALUE6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value7 | FI_FLEX_FIELD_VALUE7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE7 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value8 | FI_FLEX_FIELD_VALUE8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE8 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value9 | FI_FLEX_FIELD_VALUE9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE9 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Sender Name | FI_SENDER_NAME | no | 0 | 40 | CHARGE_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record status is set to Inactive on passing the value as 'D'. | |
Charge Filter Description1 | FI_CHARGE_FILTER_DESCRIPTION1 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description2 | FI_CHARGE_FILTER_DESCRIPTION2 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description3 | FI_CHARGE_FILTER_DESCRIPTION3 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description4 | FI_CHARGE_FILTER_DESCRIPTION4 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description5 | FI_CHARGE_FILTER_DESCRIPTION5 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Group Type1 | FI_CHARGE_FILTER_GROUP_TYPE1 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type2 | FI_CHARGE_FILTER_GROUP_TYPE2 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type3 | FI_CHARGE_FILTER_GROUP_TYPE3 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type4 | FI_CHARGE_FILTER_GROUP_TYPE4 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type5 | FI_CHARGE_FILTER_GROUP_TYPE5 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filtration Default Flag | FI_CHARGE_FILTRATION_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge filter element based on parent. |
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge element based on parent. |
Element Id | FI_ELEMENT_ID | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_ID | This is used to store the id of the element possibly from the ERP. | ||
Location Source | FI_LOCATION_SOURCE | no | 0 | 40 | CHARGE_ELEMENT.LOCATION_SOURCE | Valid Values are 'ADHOC' or 'HIERARCHY' | This is used to specify the source of the charge location. | |
Location Value | FI_LOCATION_VALUE | no | 0 | 80 | CHARGE_ELEMENT.LOCATION_VALUE | Value is required for Location Source of ADHOC. This is used to specify the location associated with the charge element. | ||
Record Status | FI_RECORD_STATUS | no | 0 | 1 | CHARGE_ELEMENT.RECORD_STATUS | If not supplied the default value is 'A'. | Valid values are 'A' (Active) and 'I' (Inactive). | The status of the charge element record. Cannot be used if inactive. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current charge element record. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
PTO Request (INTERFACE_PTO_REQUEST) | |
---|---|
Type | 2000 |
Description | Interface event used to process PTO Request and Response from the ERP. Supports only incremental syncronization. |
Validation | 1047 - Pto Request Hours Prompt Validation |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1096 - PTO request validation |
PTO Request (INTERFACE_PTO_REQUEST) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
End Date | FI_END_DATE | yes | 0 | PTO_REQUEST.END_DATE | Format is yyyyMMdd. For example, 20101231 | PTO Request End Date | ||
Event Name | FI_EVENT_NAME | yes | 0 | 40 | PTO_REQUEST.EVENT_NAME | The valid values are in the event table. If no event name is specified, then no records will be created. | This prompt is used to specify the Event Name. | |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PTO_REQUEST.PERSON_ID | This value must map to a valid person in the Person Table or no record will be created. | The person number. This value must be supplied or a record will not be created. | |
Start Date | FI_START_DATE | yes | 0 | PTO_REQUEST.START_DATE | Format is yyyyMMdd. For example, 20101231 | PTO Request Start Date | ||
Advance Payment Flag | FI_ADVANCE_PAYMENT_FLAG | no | 0 | 1 | PTO_REQUEST.ADVANCE_PAYMENT_FLAG | 0 | Valid Values are '0' and '1'. | This value is used to update the Advance payment flag column. |
Comment | FI_COMMENT | no | 0 | 80 | PTO_REQUEST.USER_COMMENT | User defined comment. | ||
External Absence Code | FI_EXTERNAL_ABSENCE_CODE | no | 0 | PTO_REQUEST.EXTERNAL_ABSENCE_CODE | This is the absence code provided by the External System. Required for B-COMM. | |||
External Absence Reason | FI_EXTERNAL_ABSENCE_REASON | no | 0 | 80 | PTO_REQUEST.EXTERNAL_ABSENCE_REASON | This is the absence reason provided by the External System. Required for B-COMM. | ||
External Transaction Num | FI_EXTERNAL_TRANSACTION_NUM | no | 0 | 40 | PTO_REQUEST.EXTERNAL_TRANSACTION_NUM | This is the transaction number provided by the External System. Required for B-COMM. | ||
Hours | FI_HOURS | no | 0 | PTO_REQUEST.REQUEST_DURATION | 0 | This is the number of hours being requested. Required when hours type is HOURS. | ||
Hours Type | FI_HOURS_TYPE | no | 0 | 20 | PTO_REQUEST.REQUEST_HOURS_TYPE | HOURS | Valid Values are FULL, HALF and HOURS. | This value is used to populate the hours type column |
Manager Appr Ind | FI_MANAGER_APPR_IND | no | 0 | 1 | Valid Values are 'Y' (yes), 'N' (no) and '' (empty) | This value is used to determine if the manager has approved the request or not via the External System. Required for B-COMM | ||
Start Timestamp | FI_START_TIMESTAMP | no | 0 | PTO_REQUEST.START_TIMESTAMP | 19700101 | Format is yyyyMMddHHmmss for B-COMM, HHmm or HH:mm otherwise. For example, 99991231120000 or 05:00. | PTO Request Start Timestamp. Not required when hours type is FULL. | |
Event End Offset | FI_EVENT_END_OFFSET | no | 0 | PTO_REQUEST.END_DATE | 0 | This is number of days that the request can be made for. Required for B-COMM or if FI_END_DATE is not given. | ||
Manager Num | FI_MANAGER_NUM | no | 0 | 40 | PTO_REQUEST.UPDATED_BY | SYSTEM | The value is used to update the updated by column. | |
Request Status | FI_REQUEST_STATUS | no | 0 | 20 | PTO_REQUEST.REQUEST_STATUS | PENDING | Must map to PENDING, APPROVED, DISAPPROVED or CANCELLED | Making the assumption that we do not need POSTED and EXPIRED since those are set automatically |
Request Type | FI_REQUEST_TYPE | no | 0 | 1 | PTO_REQUEST.REQUEST_TYPE_IND | S | S or C | S is schedule, C is cancel |
Validate Schedule | FI_VALIDATE_SCHEDULE | no | 0 | 1 | Y | Y or N | Used to determine if PTO request details are checked against a person's schedule. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Subcontractor (INTERFACE_SUBCONTRACTOR) | |
---|---|
Type | 2000 |
Description | Interface event used to load Subcontractor data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1093 - Insert/Update/Delete Subcontractor records |
Subcontractor (INTERFACE_SUBCONTRACTOR) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Person Num | FI_PERSON_NUM | yes | 0 | 40 | PERSON_VENDOR.PERSON_ID | This value must map to a valid person in the Person Table or no record will be created. | The person number. This value must be supplied or a record will not be created. | |
Rate Type | FI_RATE_TYPE | yes | 0 | 40 | PERSON_VENDOR_RATE.RATE_TYPE | Value must be supplied. Should be either PAY or LABOR. | ||
Vendor Name | FI_VENDOR_NAME | yes | 0 | 40 | VENDOR.VENDOR_NAME | This value must be supplied or record won't be created. | ||
Vendor Num | FI_VENDOR_NUM | yes | 0 | 40 | VENDOR.VENDOR_NUM | Numeric values. Must be supplied or record won't be created. | ||
Vendor Site Code | FI_VENDOR_SITE_CODE | yes | 0 | 40 | VENDOR.VENDOR_SITE_CODE | This value must be supplied or record won't be created. | ||
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add) or 'U' (Update) | This is used to determine whether we are adding or updating the data. | |
End Date | FI_END_DATE | no | 0 | PERSON_VENDOR.END_DATE | 99991131 | Format is yyyyMMdd. For example, 20101231 | Person Vendor End Date | |
Hours Classification | FI_HOURS_CLASSIFICATION | no | 0 | 3 | PERSON_VENDOR_RATE.CLASSIFICATION | ALL | Must map to a valid hours class, default is ALL. | |
Rate Amount | FI_RATE_AMOUNT | no | 0 | PERSON_VENDOR_RATE.RATE_AMOUNT | Decimal value | Has to be decimal. | ||
Rcd Num | FI_RCD_NUM | no | 0 | 40 | PERSON.RCD_NUM | This value must map to a valid person in the person table. | Used to identify the person. | |
Retroactive Flag | FI_RETROACTIVE_FLAG | no | 0 | 1 | 0 | Valid values are '0' (Not Retroactive) or '1' (Retroactive) | Retroactive record starts up to one year back. Not retroactive must start at least TODAY. | |
Shift Num | FI_SHIFT_NUM | no | 0 | 20 | PERSON_VENDOR_RATE.SHIFT_NUM | ALL | Must map to a valid shift num, default is ALL. | |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current record. | |
Start Date | FI_START_DATE | no | 0 | PERSON_VENDOR.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Person Vendor Start Date | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Task (INTERFACE_TASK) | |
---|---|
Type | 2000 |
Description | Interface event used to load Task data. Supports full syncronization and incremental syncronization. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1018 - Insert/Update Charge Element records |
Task (INTERFACE_TASK) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Charge Type | FI_CHARGE_TYPE | yes | 0 | 40 | CHARGE_ELEMENT.CHARGE_TYPE | The default value will be derived from the specified level number. | This value must be a valid and active charge type in the Charge Type table or no record will be created | This value is used to map the charge type to the level number and element name supplied. This value must be supplied for charge element filtration purposes. |
Element Name | FI_ELEMENT_NAME | yes | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | The default value will be derived from the specified charge type. | This value must be a valid element name in the Charge Type table or no record will be created | This value is used to map the element name to the charge type. This value must be supplied for a record to be created. |
Element Value | FI_ELEMENT_VALUE | yes | 0 | 80 | CHARGE_ELEMENT.ELEMENT_VALUE | Each new element must have a parent's lev | This value must be supplied for a record to be created. | |
Charge Element End Date | FI_CHARGE_ELEMENT_END_DATE | no | 0 | CHARGE_ELEMENT.END_DATE | 99991231 | Format is yyyyMMdd. For example, 20101231 | Charge Element End Date | |
Charge Element Start Date | FI_CHARGE_ELEMENT_START_DATE | no | 0 | CHARGE_ELEMENT.START_DATE | Current Date | Format is yyyyMMdd. For example, 20101231 | Charge Element Start Date | |
Charge Filtration Group1 | FI_CHARGE_FILTRATION_GROUP1 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group2 | FI_CHARGE_FILTRATION_GROUP2 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group3 | FI_CHARGE_FILTRATION_GROUP3 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group4 | FI_CHARGE_FILTRATION_GROUP4 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group5 | FI_CHARGE_FILTRATION_GROUP5 | no | 0 | 80 | CHARGE_FILTER_ELEMENT_TYPE.CHARGE_FILTER_NAME | The name of the charge filter or filtration group. | ||
Charge Filtration Group End Date1 | FI_CHARGE_FILTRATION_GROUP_END_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date2 | FI_CHARGE_FILTRATION_GROUP_END_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date3 | FI_CHARGE_FILTRATION_GROUP_END_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date4 | FI_CHARGE_FILTRATION_GROUP_END_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group End Date5 | FI_CHARGE_FILTRATION_GROUP_END_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.END_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element End Date | |
Charge Filtration Group Start Date1 | FI_CHARGE_FILTRATION_GROUP_START_DATE1 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date2 | FI_CHARGE_FILTRATION_GROUP_START_DATE2 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date3 | FI_CHARGE_FILTRATION_GROUP_START_DATE3 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date4 | FI_CHARGE_FILTRATION_GROUP_START_DATE4 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Charge Filtration Group Start Date5 | FI_CHARGE_FILTRATION_GROUP_START_DATE5 | no | 0 | CHARGE_FILTER_ELEMENT.START_DATE | 19700101 | Format is yyyyMMdd. For example, 20101231 | Charge Filter Element Start Date | |
Data Group Name | FI_DATA_GROUP_NAME | no | 0 | 80 | CHARGE_ELEMENT.DATA_GROUP_NAME | SYSTEM | This prompt is used to specify the Data Group Name. | |
Description | FI_DESCRIPTION | no | 0 | 80 | CHARGE_ELEMENT.DESCRIPTION | Description of the Department | ||
Flex Field Name1 | FI_FLEX_FIELD_NAME1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME1 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name10 | FI_FLEX_FIELD_NAME10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME10 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name11 | FI_FLEX_FIELD_NAME11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME11 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name12 | FI_FLEX_FIELD_NAME12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME12 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name13 | FI_FLEX_FIELD_NAME13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME13 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name14 | FI_FLEX_FIELD_NAME14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME14 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name15 | FI_FLEX_FIELD_NAME15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME15 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name2 | FI_FLEX_FIELD_NAME2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME2 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name3 | FI_FLEX_FIELD_NAME3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME3 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name4 | FI_FLEX_FIELD_NAME4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME4 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name5 | FI_FLEX_FIELD_NAME5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME5 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name6 | FI_FLEX_FIELD_NAME6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME6 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name7 | FI_FLEX_FIELD_NAME7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME7 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name8 | FI_FLEX_FIELD_NAME8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME8 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Name9 | FI_FLEX_FIELD_NAME9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_NAME9 | This is used to hold the attributes for flex field names associated with charge elements. | ||
Flex Field Value1 | FI_FLEX_FIELD_VALUE1 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE1 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value10 | FI_FLEX_FIELD_VALUE10 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE10 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value11 | FI_FLEX_FIELD_VALUE11 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE11 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value12 | FI_FLEX_FIELD_VALUE12 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE12 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value13 | FI_FLEX_FIELD_VALUE13 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE13 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value14 | FI_FLEX_FIELD_VALUE14 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE14 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value15 | FI_FLEX_FIELD_VALUE15 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE15 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value2 | FI_FLEX_FIELD_VALUE2 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE2 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value3 | FI_FLEX_FIELD_VALUE3 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE3 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value4 | FI_FLEX_FIELD_VALUE4 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE4 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value5 | FI_FLEX_FIELD_VALUE5 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE5 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value6 | FI_FLEX_FIELD_VALUE6 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE6 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value7 | FI_FLEX_FIELD_VALUE7 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE7 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value8 | FI_FLEX_FIELD_VALUE8 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE8 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Flex Field Value9 | FI_FLEX_FIELD_VALUE9 | no | 0 | 40 | CHARGE_ELEMENT_FLEX_FIELD.FLEX_FIELD_VALUE9 | This is used to hold the attributes for flex field values associated with charge elements. | ||
Parent Element Name | FI_PARENT_ELEMENT_NAME | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_NAME | PROJECT | Valid value is required for charge element that is higher than level 1. The element name of the project that is the parent of the task. | This value is used to specify the name of the parent of the charge element. In this case the parent is an project. |
Parent Element Value | FI_PARENT_ELEMENT_VALUE | no | 0 | 40 | CHARGE_ELEMENT_ORDER.ORDER_NUM | Valid value is required for charge element that is higher than level 1. The element value of the project that is the parent of the task. | This value is used to specify the value of the parent of the charge element. In this case the parent is an project. | |
Sender Name | FI_SENDER_NAME | no | 0 | 40 | CHARGE_ELEMENT.SENDER_NAME | The default value is whatever is specified for the sender name of the service parameter. | Actual name of the ERP source that sends the data. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid values are 'A' (Add), 'D' (Delete) or 'U' (Update) | This is used to determine whether we are adding, updating or delete the data. The record status is set to Inactive on passing the value as 'D'. | |
Charge Filter Description1 | FI_CHARGE_FILTER_DESCRIPTION1 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description2 | FI_CHARGE_FILTER_DESCRIPTION2 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description3 | FI_CHARGE_FILTER_DESCRIPTION3 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description4 | FI_CHARGE_FILTER_DESCRIPTION4 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Description5 | FI_CHARGE_FILTER_DESCRIPTION5 | no | 0 | 80 | CHARGE_FILTER.DESCRIPTION | Description for charge filtration group | ||
Charge Filter Group Type1 | FI_CHARGE_FILTER_GROUP_TYPE1 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type2 | FI_CHARGE_FILTER_GROUP_TYPE2 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type3 | FI_CHARGE_FILTER_GROUP_TYPE3 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type4 | FI_CHARGE_FILTER_GROUP_TYPE4 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filter Group Type5 | FI_CHARGE_FILTER_GROUP_TYPE5 | no | 0 | 40 | CHARGE_FILTER.GROUP_TYPE | FILTRATION | Should be either FILTRATION or APPRVOAL | FILTRATION or APPRVOAL group type, empty means FILTRATION |
Charge Filtration Default Flag | FI_CHARGE_FILTRATION_DEFAULT_FLAG | no | 0 | 1 | CHARGE_FILTER_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge filter element based on parent. |
Default Flag | FI_DEFAULT_FLAG | no | 0 | 1 | CHARGE_ELEMENT.DEFAULT_FLAG | If not supplied the default value is '0'. | Valid values are '1' and '0'. | To determine whether this is the default charge element based on parent. |
Element Id | FI_ELEMENT_ID | no | 0 | 40 | CHARGE_ELEMENT.ELEMENT_ID | This is used to store the id of the element possibly from the ERP. | ||
Location Source | FI_LOCATION_SOURCE | no | 0 | 40 | CHARGE_ELEMENT.LOCATION_SOURCE | Valid Values are 'ADHOC' or 'HIERARCHY' | This is used to specify the source of the charge location. | |
Location Value | FI_LOCATION_VALUE | no | 0 | 80 | CHARGE_ELEMENT.LOCATION_VALUE | Value is required for Location Source of ADHOC. This is used to specify the location associated with the charge element. | ||
Record Status | FI_RECORD_STATUS | no | 0 | 1 | CHARGE_ELEMENT.RECORD_STATUS | If not supplied the default value is 'A'. | Valid values are 'A' (Active) and 'I' (Inactive). | The status of the charge element record. Cannot be used if inactive. |
Smart Update | FI_SMART_UPDATE | no | 0 | 1 | N | Valid values are 'Y' (Yes) or 'N' (No) | This is used to determine if smart update should be applied to the current charge element record. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |
Error Log (INTERFACE_TRANSACTION_ERROR) | |
---|---|
Type | 2000 |
Description | This interface populates Error Log Records. |
Validation | 1074 - Minimum and Maximum length Validation |
Validation | 1113 - Validation to populate Error Log and update Trans Action Proc Status |
Error Log (INTERFACE_TRANSACTION_ERROR) Prompts | ||||||||
---|---|---|---|---|---|---|---|---|
Prompt Name | Prompt Semantic | Required | Minimum Length | Maximum Length | Data Storage | Default Value | Validation | Notes |
Error Code | FI_ERROR_CODE | yes | 0 | 20 | ERROR_LOG.ERROR_CODE | This must be a valid Error Code. | This value is used to determine which error is being used. | |
Error Description | FI_ERROR_DESCRIPTION | yes | 0 | 1000 | ERROR_LOG.ERROR_DESCRIPTION | Description of the error. | ||
Transaction Id | FI_TRANSACTION_ID | yes | 0 | 80 | ERROR_LOG.TRANSACTION_ID | This Id must exist in the trans_action table. | Id of the transaction that caused the error. | |
Transaction Process Name | FI_TRANSACTION_PROCESS_NAME | yes | 0 | 40 | ERROR_LOG.PROCESS_NAME | This process name must exist in a trans_action record. | Process name of the transaction that caused the error. | |
Transaction Process Status | FI_TRANSACTION_PROCESS_STATUS | yes | 0 | 1 | ERROR_LOG.PROCESS_STATUS | Valid values are 'C' (Complete) and 'Z' (Canceled After Being Processed) | Process status of the transaction that caused the error. | |
Action | FI_ACTION | no | 0 | 1 | A | Valid value is 'A' (Add) | This is used to determine that we are adding Error Log records. | |
Transaction Name | FI_TRANSACTION_NAME | no | 0 | 80 | ERROR_LOG.TRANSACTION_NAME | If provided, this must be a valid transaction name in the interface_transaction table | Transaction name that caused the error. | |
Xml Detail Create Date | FI_XML_DETAIL_CREATE_DATE | no | 0 | 40 | INTERFACE_IN_XML_QUEUE_DTL.CREATE_DATE | The create date determines the earliest date the record will be processed |