Arquivo de importação do resumo de férias
Num relance
Nome do arquivo: VacationSummary-[YYMMDD][HHMM].xml, onde [MMDDYY] é a data no formato MMDDAA e [HHMM] é a hora no formato HHMM.
Tipo de arquivo: XML
Os arquivos de importação de dados de resumo de férias permitem importar itens de férias ou folgas do agente para o IEX WFM Integrated. Isso é útil se você tiver um sistema de terceiros, como um banco de dados de recursos humanos, do qual deseja extrair informações sobre férias ou horários de folga dos agentes. O uso de arquivos de importação do resumo de férias também pode ajudar a reduzir o tempo de entrada de dados para definir agentes durante a configuração inicial de um novo sistema IEX WFM Integrated.
Fatos importantes sobre os arquivos de dados de importação do resumo de férias
- Os registros no arquivo de dados podem ser classificados em qualquer ordem.
-
Siga as especificações gerais de XML para o conteúdo do arquivo e as práticas recomendadas para XML.
-
Cada arquivo deve conter os elementos descritos na Definição do tipo de documento e atender aos critérios descritos nesta seção.
-
As tags de elementos diferenciam maiúsculas de minúsculas.
-
Os elementos de data e hora devem usar o fuso horário do seu IEX WFM Integrated.
- O tamanho do campo para todos os nomes de entidades e itens de dados definidos pelo usuário é de 64 caracteres, salvo indicação em contrário.
- Limite o nome dos arquivos a 30 caracteres.
-
O tamanho máximo do arquivo é 5 MB.
-
Todos os números devem ser inteiros. Não há suporte para os valores decimais.
-
Alguns elementos usados nos arquivos de importação de dados do resumo de férias têm nomes legados.
-
Se ocorrerem erros durante o processamento do arquivo, talvez os dados não sejam importados corretamente. Verifique a formatação do arquivo antes de entrar em contato com o seu representante da conta do IEX WFM Integrated.
Tipos de ganhos
As informações de tipo de ganhos não são incluídas nos arquivos de importação de dados de resumo de férias. Para contabilizar os tipos de ganhos, a importação de dados adiciona os valores ganhos de cada agente para códigos de atividade que pertencem ao mesmo tipo de ganhos. O valor ganho total é armazenado como o valor ganho do tipo de ganhos.
Na Classics, Inc., férias e tempo pessoal pertencem ao tipo de ganhos PTO. Minnie May Barry tem atualmente 48 horas de PTO. Se o arquivo de dados do resumo de férias incluir 40 horas de férias e 16 horas de tempo pessoal para Minnie May, seu tempo de PTO no IEX WFM Integrated será de 56 horas após a conclusão da importação.
Para importar informações de folga para qualquer código (incluindo lista de espera), o código deve receber um tipo de ganhos. Se um código não tiver um tipo de ganhos, a importação falhará.
Informações gerais de processamento
A importação de dados limpa o valor existente no banco de dados IEX WFM Integrated quando um elemento:
-
Contém um valor em branco.
-
É omitido do arquivo de importação do resumo de férias.
Se o arquivo de importação do resumo de férias contiver um registro que não possui nenhum registro correspondente no banco de dados IEX WFM Integrated, a importação de dados criará um registro no banco de dados. Ele adiciona ao registro os dados contidos no arquivo de importação, incluindo agente, grupo de férias, ano de férias e tipo de férias.
Se o arquivo de importação do resumo de férias contiver um registro que já existe no banco de dados IEX WFM Integrated, a importação de dados substituirá o registro. Se um elemento secundário de férias for omitido do arquivo de importação, a importação de dados não modificará o registro existente. O elemento vacYear deve ser uma regra de folga com uma unidade de cálculo de HH:MM. A importação de dados não oferece suporte a regras de folga com uma unidade de cálculo de dias.
Definição de tipo de documento do resumo de férias
DTD (definição de tipo de documento) é um modelo para compilar arquivos de importação XML. Você não precisa criar um DTD no seu ambiente.
<?xml version="1.0" encoding="UTF-8" ?> <!ELEMENT agentVacationSummary (agentVacation+)> <!ELEMENT agentVacation (agent, vacation+)> <!ELEMENT agent (agentID, vacGroup, vacYear)> <!ELEMENT vacation (from?, to?, earned?, credited?, debited?, selected?, taken?, minFullWeeks?, maxPartialHours?, coFrom?, coTo?)> <!ELEMENT agentID (#PCDATA)> <!ELEMENT vacGroup (#PCDATA)> <!ELEMENT vacYear (#PCDATA)> <!ELEMENT from (day, month, year)> <!ELEMENT to (day, month, year)> <!ELEMENT earned (#PCDATA)> <!ELEMENT credited (#PCDATA)> <!ELEMENT debited (#PCDATA)> <!ELEMENT selected (#PCDATA)> <!ELEMENT taken (#PCDATA)> <!ELEMENT minFullWeeks (#PCDATA)> <!ELEMENT maxPartialHours (#PCDATA)> <!ELEMENT coFrom (#PCDATA)> <!ELEMENT coTo (#PCDATA)> <!ELEMENT day (#PCDATA)> <!ELEMENT month (#PCDATA)> <!ELEMENT year (#PCDATA)> <!ATTLIST vacation type CDATA #REQUIRED> <!ATTLIST agentID acdID CDATA #IMPLIED>
Considerações sobre o tipo de elemento DTD
Quando usar a definição de tipo de documento (DTD) para criar um arquivo, lembre-se destas considerações sobre declarações de tipo de elemento:
<!ELEMENT elementName (childElement, childElement, ...)>
Quando um elemento é definido com uma lista de elementos secundários separados por vírgulas, os elementos secundários devem aparecer na mesma ordem no arquivo de importação. Caso contrário, o elemento não será válido.
<!ELEMENT elementName (#PCDATA)>
Os elementos com o tipo #PCDATA podem conter qualquer string de texto. A importação de dados de dados valida o texto conforme necessário.
Qualificadores de atributos
O DTD usa qualificadores de elemento XML padrão:
- ? -Elementos com este qualificador não são necessários. Se incluí-los, você pode apenas especificá-los uma vez por elemento.
- *-Elementos com este qualificador não são necessários. Você pode incluir mais de um desses para cada elemento.
- +-Pelo menos um dos elementos com esse qualificador é necessário. Você pode incluir mais de um de cada elemento.
- [sem qualificador]-Elementos não marcados com um qualificador são necessários e você só pode especificá-los uma vez por elemento.
Conteúdo do arquivo: especificações de campos
Esta seção inclui todos os elementos para uso em arquivos de importação do resumo de férias. Use o DTD de resumo de férias como modelo para estruturar os dados no seu arquivo de importação. Se um elemento puder ser editado na interface de usuário do IEX WFM Integrated, a coluna Descrição faz referência à tela IEX WFM Integrated onde você pode editá-lo.
Elemento raiz
O elemento raiz é agentVacationSummary. Esse elemento deve conter um ou mais elementos agentVacation secundários.
Elementos secundários
Os elementos são recusados com base no nível deles no DTD.
Elemento |
Elemento ou atributo secundário |
Descrição |
Valores válidos |
---|---|---|---|
agentVacation |
Contém todas as informações de férias de um único agente para um grupo de folga e regra de folga. Esse elemento contém um único elemento secundário agent e um ou mais elementos vacation secundários. Se você precisar importar informações de um agente para vários grupos de folga ou regras de folga, use elementos agentVacation separados para cada grupo ou regra de folga desse agente. |
||
agente | Deve incluir um agentID, um vacGroup e um vacYear. | ||
agentID |
Identificador usado para encontrar o agente a ser modificado no IEX WFM Integrated. O valor usado determina os requisitos das informações que preenchem o elemento agentID. O valor padrão é T. Pode ser editado na tela: Definição do agente. |
Valor S: Valor T: Um valor: O tamanho máximo é 64. Valor E: O tamanho máximo é 256. |
|
acdID |
Atributo de agentID. A importação de dados corresponde ao agentID ao agente no IEX WFM Integrated ao qual está atribuído o acdID especificado na data atual (com base no fuso horário do IEX WFM Integrated). Pode ser editado na tela: Definição do agente. |
1-2147483647 |
|
vacGroup |
ID do grupo de folga do agente. Deve existir um registro para o agente no AgentMap cujo campo vac_group_id corresponda a esse ID. Pode ser editado na tela: Definição do agente. |
1-2147483647 |
|
vacYear |
Nome do ano de folga para o qual as informações resumidas do agente serão importadas. Deve existir um registro em VacYear cujo vac_group_id corresponde ao ID no elemento vacGroup e cujo campo vac_year_name corresponde à string no elemento vacYear. O ID do ano de férias não será especificado no arquivo de importação. Deve ser uma regra de folga com uma unidade de cálculo de HH:MM. A importação de dados não oferece suporte a regras de folga com uma unidade de cálculo de dias. Pode ser editado na tela: Regras de folga. |
Qualquer string. Uma regra de folga deve ser definida com esse nome para o grupo de folga |
|
vacation | Contém todas as informações de férias do agente para o vacGroup e vacYear especificado. Esse elemento terão um atributo type para indicar o tipo de férias importado bem como os elementos secundários opcionais: from, to, earned, debited,credited, selected, taken, minFullWeeks, maxPartialHours, coFrom e coTo. | ||
type |
O atributo do elemento vacation. Descrição do código de atividade para o qual o registro VacSummary será adicionado ou atualizado. Se essa string for Lista de espera, o registro VacSummary com o código -1 será atualizado ou adicionado. Caso contrário, deve existir um registro na tabela de exceção cuja descrição corresponda a essa string (diferencia maiúsculas de minúsculas) e deve existir um registro em VacType para o vacGroup e o vacYear especificados para esse código de atividade. Pode ser editado na tela: Regras de folga. |
Qualquer caractere ASCII imprimível, exceto | e \. Diferencia maiúsculas de minúsculas |
|
de |
Data mais antiga para a qual o agente poderá solicitar esse tipo de férias. Deve ser uma data válida, usando os elementos secundários day, month e year. Deve estar entre as datas de início e término do ano de férias e deve ser igual ou anterior à data final especificada (ou à toDate do registro existente se o elemento to for excluído). Essa data será armazenada no campo fromDate em VacSummary. Pode ser editado na tela: Resumo de folga do agente. |
||
dia | O dia do elemento from. | 1-31 | |
month | O mês do elemento from. | 1-12 | |
year | O ano do elemento from. | Qualquer ano | |
Para |
Data mais recente para a qual o agente poderá solicitar esse tipo de férias. Deve ser uma data válida, usando os elementos secundários day, month e year. Deve estar entre as datas de início e término do ano de férias e deve ser igual ou após à data inicial especificada (ou à fromDate do registro existente se o elemento from for excluído). Essa data será armazenada no campo toDate em VacSummary. Pode ser editado na tela: Resumo de folga do agente. |
||
dia | O dia do elemento to. | 1-31 | |
month | O mês do elemento to. | 1-12 | |
year | O ano do elemento to. | Qualquer ano | |
ganho |
O tempo, em minutos, que o agente ganhou para o tipo de férias no ano de férias. Esse valor será armazenado no campo Earned em VacSummary. Pode ser editado na tela: Resumo de folga do agente. |
0-479520 (999 dias de 8 horas) |
|
credited |
Quantidade de tempo creditada, em minutos para o tipo de férias. Esse valor será armazenado no campo credited em VacSummary. O tempo creditado é adicionado ao tempo ganho do agente no Gerenciador de folga. Pode ser editado na tela: Resumo de folga do agente. |
0-479520 (999 dias de 8 horas) | |
debited |
Quantidade de tempo debitado, em minutos para o tipo de férias. Esse valor será armazenado no campo previouslyUsed em VacSummary. O tempo debitado é contabilizado como tempo usufruído no Gerenciador de folga. Pode ser editado na tela: Resumo de folga do agente. |
0-479520 (999 dias de 8 horas) |
|
selecionada(s) | Não importado. É baseado em atividades futuras inseridas no IEX WFM Integrated. | ||
ocupado | Não importado. É baseado nas programações no IEX WFM Integrated. | ||
minFullWeeks |
Número mínimo de semanas que o agente deve tirar em incrementos de semanas inteiras. Pode ser editado na tela: Resumo de folga do agente. |
0-78
|
|
maxPartialHours |
Quantidade máxima de tempo que o agente pode tirar em incrementos de dias parciais. Se os agentes puderem tirar todo o seu tempo de folga em incrementos de dias parciais, esse valor deverá ser igual ao de earned. Pode ser editado na tela: Resumo de folga do agente. |
Deve ser menor ou igual ao valor earned do registro. |
|
coFrom |
O tempo, em minutos, que o agente transferiu do ano anterior para o tipo de férias. Esse valor será armazenado no campo coFromLastYr em VacSummary. Pode ser editado na tela: Resumo de folga do agente. |
0-479520 (999 dias de 8 horas) |
|
coTo |
O tempo, em minutos, que o agente transferiu para o próximo ano para o tipo de férias. Esse valor será armazenado no campo coToNextYr em VacSummary. Pode ser editado na tela: Resumo de folga do agente. |
0-479520 (999 dias de 8 horas) |
Exemplo de arquivo de importação
<?xml version="1.0" encoding="UTF-8" ?> <agentVacationSummary> <agentVacation> <agent> <agentID>270</agentID> <vacGroup>10</vacGroup> <vacYear>2007</vacYear> </agent> <vacation type=”PTO”> <earned>2400</earned> </vacation> <vacation type=”Personal Time”> <earned>960</earned> </vacation> <vacation type=”Wait List”> <earned>2400</earned> </vacation> </agentVacation> <agentVacation> <agent> <agentID>275</agentID> <vacGroup>10</vacGroup> <vacYear>2007</vacYear> </agent> <vacation type=”PTO”> <from> <day>1</day> <month>1</month> <year>2007</year> </from> <to> day>29</day> <month>3</month><year>2008</year> </to> <earned>2400</earned> <credited>480</credited> <debited>0</debited> <coFrom>1440</coFrom> <coTo>0</coTo> </vacation> <vacation type=”Personal Time”> <from> <day>1</day> <month>1</month>< year>2007</year> </from> <to> <day>29</day> <month>3</month> <year>2008</year> </to> <earned>0</earned> <credited>0</credited> <debited>0</debited> <coFrom>0</coFrom> <coTo>0</coTo> </vacation> <vacation type=”Wait List”> <from> <day>1</day> <month>1</month> <year>2007</year> </from> <to> <day>29</day> <month>3</month> <year>2008</year> </to> <earned>3360</earned> <credited>0</credited> <debited>0</debited> <coFrom>0</coFrom> <coTo>0</coTo> </vacation> </agentVacation> </agentVacationSummary>