Introdução

O Cloud HCM fornece uma capacidade de extrair dados do HCM usando uma plataforma de nova geração com armazenamento de dados otimizado para leitura.

Objetivos

Ao concluir este tutorial, você entenderá como:

  • Views de extração de consulta e sua hierarquia de objetos
  • Enviar e rastrear de forma assíncrona solicitações de job de extração para recuperação de dados selecionados
  • Fazer download de arquivos de saída de extração

Pré-requisitos

Antes de começar:

  1. Entre em contato com o Oracle CoE para garantir que o armazenamento de dados otimizado para leitura seja provisionado no seu pod e que seus dados estejam sendo replicados
  2. Executar a configuração de segurança necessária, incluindo:
    • Configuração de segurança de dados
    • Configuração do aplicativo cliente OAuth

Casos de Uso

Essa funcionalidade permite abordar os seguintes casos de uso.

Extração Completa de Dados

A extração completa dos dados selecionados pode ser uma atividade única ou periódica.

Você pode recuperar toda a hierarquia de objetos ou apenas um subconjunto dela.

A extração completa de dados recuperará todos os registros que correspondem aos critérios de filtragem e os arquivos de saída podem ser muito grandes.

Os objetos de data efetiva serão recuperados a partir da data efetiva solicitada, em que a data de extração atual é o padrão.

Extração Incremental de Dados

A extração incremental dos dados selecionados geralmente é uma atividade periódica e programada.

Você pode recuperar toda a hierarquia de objetos ou apenas um subconjunto dela.

Neste caso de uso, você deseja recuperar somente objetos que foram alterados desde a execução de extração anterior, em que a primeira execução de extração é a linha de base. Para isso, os filtros de atributos timeUpdated precisam ser aplicados em qualquer nível que esteja sujeito à detecção de alterações.

A consulta de extração de dados incrementais pode aplicar critérios de filtragem adicionais. Os arquivos de saída normalmente serão menores em comparação com a extração completa, pois conterão apenas delta.

Somente os valores atuais dos atributos serão recuperados.

Os objetos de data efetiva serão recuperados a partir da data efetiva solicitada, em que a data de extração atual é o padrão.

Atenção:

Os registros excluídos fisicamente não serão retornados usando a filtragem por timeUpdated.

Tarefa 1: Escolhendo uma View de Extração

Escolha qual view de extração usar, dependendo dos objetos e atributos necessários. As visualizações disponíveis a partir da versão 26B são listadas abaixo, juntamente com os objetos e atributos que podem ser extraídos, agrupados por módulo.

Para objetos de data efetiva, você normalmente encontrará uma exibição regular que retorna dados efetivos a partir da data fornecida e, adicionalmente, uma exibição de histórico que retorna todos os registros de data efetiva.

Diversos Idiomas:

Os atributos traduzíveis só estão disponíveis em inglês neste momento.

RH Global - Emprego

Nome do Módulo oraHcmHrCoreEmployment
Caminho de Contexto do Módulo hcmHrCore/employment

Nome da View Atributos
actionExtracts código
id
startDate
endDate
nome
descrição
timeCreated
timeUpdated
createdBy
updatedBy
actionOccurrenceExtracts id
actionDate
actionTypeCode
categoryCode
createdBy
entityType
freezeStartDate
freezeUntilDate
howToProcess
parentEntityType
proposedActionType
proposedStartDate
proposedWorkerType
enviadoPor
timeCreated
timeUpdated
updatedBy
actionReason.id
actionReason.code
actionReason.name
action.id
action.code
action.name
actionReasonExtracts nome
de código
id
createdBy
descrição
endDate
startDate
timeCreated
timeUpdated
updatedBy
assignmentStatusTypeExtracts id
userStatus
assignmentStatusCode
activeFlag
defaultFlag
fromDate
toDate
timeCreated
timeUpdated
createdBy
updatedBy
contractExtracts id
endDate
contractNumber
contractualJobTitle
description
documentStatus
documentStatusChangeDate
duration
durationUnits
effectiveEndDate
effectiveStartDate
endReason
extensionPeriod
extensionPeriodUnits
extensionReason
numberOfExtensions
parties
reference
startReason
statusReason
createdBy
timeCreated
timeUpdated
updatedBy
type.lookupCode
type.lookupType
type.meaning
country.territoryCode
country.territoryShortName
workRelationship.id
workRelationship.startDate
workRelationship.workerType
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
assignment.id
assignment.effectiveStartDate
assignment.effectiveEndDate
assignment.effectiveSequence
assignment.effectiveLatestChange
assignment.assignmentType
assignment.businessTitle
assignment.assignmentNumber
assignment.primaryFlag
assignment.assignmentStatusType
documentOfRecordExtracts id
comments
createdBy
creationSource
dateFrom
dateTo
documentCode
documentName
documentNumber
issuedDate
issuingAuthority
issuingCountry
issuingLocation
publish
publishDate
relatedObjectName
status
tagList
timeCreated
timeUpdated
updatedBy
verifiedBy
verifiedDate
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
assignment.id
assignment.effectiveStartDate
assignment.effectiveEndDate
assignment.effectiveSequence
assignment.effectiveLatestChange
assignment.assignmentType
assignment.businessTitle
assignment.assignmentNumber
assignment.primaryFlag
assignment.assignmentStatusType
documentOfRecordTypeExtracts id
activeInactiveFlag
archiveCriteriaBasis
archiveCriteriaDays
authorizationRequired
biReportPath
categoryCode
commentsLabel
commentsRequired
createdBy
dateFromLabel
dateFromRequired
dateToLabel
dateToRequired
description
documentNameLabel
documentNameRequired
documentNumberLabel
documentNumberRequired
documentType
documentTypeLevel
hierarchyCode
issuedDateLabel
issuedDateRequired
issuingAuthorityLabel
issuingAuthorityRequired
issuingCountryLabel
issuingCountryRequired
issuingLocationLabel
issuingLocationRequired
legislationCode
lockCreate
lockCreateRoleList
lockDelete
lockDeleteRoleList
lockUpdate
lockUpdateRoleList
minimumAttachmentsCount
multipleOccurencesFlag
publishRequired
purgeArchiveCriteriaDays
subCategoryCode
systemDocumentType
tagList
timeCreated
timeUpdated
updatedBy
warningPeriod
emailExtracts id
fromDate
toDate
tipo
emailAddress
primaryFlag
createdBy
timeCreated
updatedBy
timeUpdated
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
legislativeInformationExtracts id
effectiveStartDate
effectiveEndDate
sexo
estado civil
maritalStatusChangeDate
maiorEducaçãoNível
criadoPor
horaCriado
atualizadoPor
tempoAtualizado
legislação.Código do Território
legislação.territórioNomeShort
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
legislativeInformationHistoryExtracts id
effectiveStartDate
effectiveEndDate
gênero
estado civil
maritalStatusChangeDate
maiorEducaçãoNível
criadoPor
horaCriado
atualizadoPor
tempoAtualizado
legislação.Código do Território
legislação.territórioNomeDéficit
personDetail.id
personDetail.personNumber
managerHierarchyExtracts effectiveStartDate
effectiveEndDate
personId
assignmentId
managerType
managerLevel
managerId
managerAssignmentId
primaryAssignmentFlag
primaryManagerFlag
createdBy
timeCreated
updatedBy
timeUpdated
personAssignment.id
personAssignment.effectiveStartDate
personAssignment.effectiveEndDate
personAssignment.effectiveSequence
personAssignment.effectiveLatestChange
personAssignment.assignmentType
personAssignment.assignmentNumber
personAssignment.primaryFlag
personAssignment.businessTitle
personAssignment.workAtHomeFlag
personAssignment.officeBuilding
personAssignment.officeFloor
personAssignment.officeMailStop
personAssignment.officeNumber
personAssignment.primaryAssignmentFlag
personAssignment.primaryWorkRelationshipFlag
personAssignment.timeUpdated
personAssignment.updatedBy
personAssignment.timeCreated
personAssignment.createdBy
personAssignment.systemPersonType
personAssignment.labourUnionMemberFlag
personAssignment.managerFlag
personAssignment.probationEndDate
personAssignment.probationPeriod
personAssignment.probationPeriodUnit
personAssignment.normalHours
personAssignment.frequency
personAssignment.endTime
personAssignment.startTime
personAssignment.noticePeriod
personAssignment.noticePeriodUOM
personAssignment.workerCategory
personAssignment.assignmentCategory
personAssignment.hourlyPaidOrSalaried
personAssignment.projectedEndDate
personAssignment.projectedStartDate
personAssignment.assignmentStatusType
personAssignment.retirementAge
personAssignment.retirementDate
personAssignment.synchronizeFromPositionFlag
personAssignment.fullTimeOrPartTime
personAssignment.permanentAssignmentFlag
personAssignment.seniorityBasis
personAssignment.overtimePeriod
personAssignment.adjustedFullTimeEquivalent
personAssignment.annualWorkingDuration
personAssignment.annualWorkingDurationUnit
personAssignment.annualWorkingRatio
personAssignment.standardFrequency
personAssignment.standardWorkingHours
personAssignment.standardAnnualWorkingDuration
personAssignment.sequence
personAssignment.department.id
personAssignment.department.name
personAssignment.department.title
personAssignment.department.effectiveStartDate
personAssignment.department.effectiveEndDate
personAssignment.legalEmployer.id
personAssignment.legalEmployer.name
personAssignment.legalEmployer.effectiveStartDate
personAssignment.legalEmployer.effectiveEndDate
personAssignment.legislation.territoryCode
personAssignment.legislation.territoryShortName
personAssignment.position.id
personAssignment.position.effectiveStartDate
personAssignment.position.effectiveEndDate
personAssignment.position.name
personAssignment.position.code
personAssignment.grade.id
personAssignment.grade.effectiveStartDate
personAssignment.grade.effectiveEndDate
personAssignment.grade.name
personAssignment.grade.code
personAssignment.location.id
personAssignment.location.effectiveStartDate
personAssignment.location.effectiveEndDate
personAssignment.location.name
personAssignment.location.code
personAssignment.location.mainAddress.id
personAssignment.location.mainAddress.effectiveStartDate
personAssignment.location.mainAddress.effectiveEndDate
personAssignment.location.mainAddress.county
personAssignment.location.mainAddress.state
personAssignment.location.mainAddress.province
personAssignment.location.mainAddress.townOrCity
personAssignment.location.mainAddress.postalCode
personAssignment.location.mainAddress.longPostalCode
personAssignment.location.mainAddress.addressLine1
personAssignment.location.mainAddress.addressLine2
personAssignment.location.mainAddress.addressLine3
personAssignment.location.mainAddress.addressLine4
personAssignment.location.mainAddress.country.territoryCode
personAssignment.location.mainAddress.country.territoryShortName
personAssignment.job.id
personAssignment.job.effectiveStartDate
personAssignment.job.effectiveEndDate
personAssignment.job.name
personAssignment.job.code
personAssignment.job.jobFunctionCode
personAssignment.job.managerLevel
personAssignment.job.jobFamily.id
personAssignment.job.jobFamily.effectiveStartDate
personAssignment.job.jobFamily.effectiveEndDate
personAssignment.job.jobFamily.code
personAssignment.job.jobFamily.name
personAssignment.collectiveAgreement.id
personAssignment.collectiveAgreement.effectiveStartDate
personAssignment.collectiveAgreement.effectiveEndDate
personAssignment.collectiveAgreement.name
personAssignment.personType.id
personAssignment.personType.userPersonType
personAssignment.workerUnion.id
personAssignment.workerUnion.effectiveStartDate
personAssignment.workerUnion.effectiveEndDate
personAssignment.workerUnion.name
personAssignment.assignmentUserStatus.id
personAssignment.assignmentUserStatus.userStatus
personAssignment.businessUnit.id
personAssignment.businessUnit.effectiveStartDate
personAssignment.businessUnit.effectiveEndDate
personAssignment.businessUnit.name
personAssignment.account.codeCombinationId
personAssignment.account.concatenatedSegments
personAssignment.account.chartOfAccountsId
personAssignment.ledger.ledgerId
personAssignment.ledger.name
personAssignment.workRelationship.id
personAssignment.workRelationship.startDate
personAssignment.workRelationship.workerType
personAssignment.workRelationship.timeCreated
personAssignment.workRelationship.timeUpdated
personAssignment.localName.id
personAssignment.localName.effectiveStartDate
personAssignment.localName.effectiveEndDate
personAssignment.localName.lastName
personAssignment.localName.firstName
personAssignment.localName.displayName
personAssignment.localName.listName
personAssignment.localName.timeCreated
personAssignment.localName.timeUpdated
personAssignment.globalName.id
personAssignment.globalName.effectiveStartDate
personAssignment.globalName.effectiveEndDate
personAssignment.globalName.lastName
personAssignment.globalName.firstName
personAssignment.globalName.displayName
personAssignment.globalName.listName
personAssignment.globalName.timeCreated
personAssignment.globalName.timeUpdated
personAssignment.personDetail.id
personAssignment.personDetail.personNumber
personAssignment.personDetail.effectiveStartDate
personAssignment.personDetail.effectiveEndDate
personAssignment.personDetail.timeCreated
personAssignment.personDetail.timeUpdated
personAssignment.actionOccurrence.id
personAssignment.peopleGroup.id
nameExtracts id
effectiveStartDate
effectiveEndDate
type
lastName
firstName
middleNames
title
prefix
suffix
knownAs
previousLastName
honors
militaryRank
displayName
fullName
listName
orderName
createdBy
timeCreated
updatedBy
timeUpdated
legislation.territoryCode
legislation.territoryShortName
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
nationalIdentifierExtracts id
createdBy
expirationDate
issueDate
identifierNumber
placeOfIssue
timeCreated
timeUpdatedBy
country.territoryCode
country.territoryShortName
country.territoryShortName
type.lookupCode
type.lookupType
type.meaning
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
peopleGroupExtracts id
createdBy
enabledFlag
endDateActive
groupName
startDateActive
summaryFlag
timeCreated
timeUpdated
updatedBy
personAddressExtracts effectiveStartDate
effectiveEndDate
id
type
createdBy
timeCreated
timeUpdated
updatedBy
building
floorNumber
townOrCity
postalCode
longPostalCode
addressLine1
addressLine2
addressLine3
addressLine4
county
state
province
primaryFlag
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
country.territoryCode
country.territoryShortName
personAddressHistoryExtracts effectiveStartDate
effectiveEndDate
id
type
createdBy
timeCreated
timeUpdatedBy
updatedBy
building
floorNumber
townOrCity
postalCode
longPostalCode
addressLine1
addressLine2
addressLine3
addressLine4
país
estado
província
primaryFlag
personDetail.id
personDetail.personNumber
country.territoryCode
country.territoryShortName
personTypeExtracts id
userPersonType
systemPersonType
activeFlag
defaultFlag
timeCreated
timeUpdated
createdBy
updatedBy
phoneExtracts id
fromDate
toDate
phoneNumber
areaCode
countryCodeNumber
extensão
primaryFlag
valididade
criadoPor
timeCreated
updatedBy
timeUpdated
legislation.territoryCode
legislation.territoryShortName
type.lookupCode
type.lookupType
type.meaning
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
workerAssignmentExtracts id
effectiveStartDate
effectiveEndDate
effectiveSequence
effectiveLatestChange
assignmentType
assignmentNumber
primaryFlag
businessTitle
workAtHomeFlag
officeBuilding
officeFloor
officeMailStop
officeNumber
primaryAssignmentFlag
primaryWorkRelationshipFlag
timeUpdated
updatedBy
timeCreated
createdBy
systemPersonType
labourUnionMemberFlag
managerFlag
probationEndDate
probationPeriod
probationPeriodUnit
normalHours
frequency
endTime
startTime
noticePeriod
noticePeriodUOM
workerCategory
assignmentCategory
hourlyPaidOrSalaried
projectedEndDate
projectedStartDate
assignmentStatusType
expenseCheckSendToAddress
retirementAge
retirementDate
synchronizeFromPositionFlag
fullTimeOrPartTime
permanentAssignmentFlag
seniorityBasis
overtimePeriod
adjustedFullTimeEquivalent
annualWorkingDuration
annualWorkingDurationUnit
annualWorkingRatio
standardFrequency
standardWorkingHours
standardAnnualWorkingDuration
sequence
department.id
department.name
department.title
department.effectiveStartDate
department.effectiveEndDate
legalEmployer.id
legalEmployer.name
legalEmployer.effectiveStartDate
legalEmployer.effectiveEndDate
legislation.territoryCode
legislation.territoryShortName
position.id
position.effectiveStartDate
position.effectiveEndDate
position.name
position.code
grade.id
grade.effectiveStartDate
grade.effectiveEndDate
grade.name
grade.code
location.id
location.effectiveStartDate
location.effectiveEndDate
location.name
location.code
location.mainAddress.id
location.mainAddress.effectiveStartDate
location.mainAddress.effectiveEndDate
location.mainAddress.county
location.mainAddress.state
location.mainAddress.province
location.mainAddress.townOrCity
location.mainAddress.postalCode
location.mainAddress.longPostalCode
location.mainAddress.addressLine1
location.mainAddress.addressLine2
location.mainAddress.addressLine3
location.mainAddress.addressLine4
location.mainAddress.country.territoryCode
location.mainAddress.country.territoryShortName
job.id
job.effectiveStartDate
job.effectiveEndDate
job.name
job.code
job.jobFunctionCode
job.managerLevel
job.jobFamily.id
job.jobFamily.effectiveStartDate
job.jobFamily.effectiveEndDate
job.jobFamily.code
job.jobFamily.name
collectiveAgreement.id
collectiveAgreement.effectiveStartDate
collectiveAgreement.effectiveEndDate
collectiveAgreement.name
personType.id
personType.userPersonType
workerUnion.id
workerUnion.effectiveStartDate
workerUnion.effectiveEndDate
workerUnion.name
assignmentUserStatus.id
assignmentUserStatus.userStatus
businessUnit.id
businessUnit.effectiveStartDate
businessUnit.effectiveEndDate
businessUnit.name
account.codeCombinationId
account.concatenatedSegments
account.chartOfAccountsId
ledger.ledgerId
ledger.name
workRelationship.id
workRelationship.startDate
workRelationship.workerType
workRelationship.timeCreated
workRelationship.timeUpdated
localName.id
localName.effectiveStartDate
localName.effectiveEndDate
localName.lastName
localName.firstName
localName.displayName
localName.listName
localName.timeCreated
localName.timeUpdated
globalName.id
globalName.effectiveStartDate
globalName.effectiveEndDate
globalName.lastName
globalName.firstName
globalName.displayName
globalName.listName
globalName.timeCreated
globalName.timeUpdated
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate
personDetail.timeCreated
personDetail.timeUpdated
actionOccurrence.id
peopleGroup.id
workerAssignmentHistoryExtracts id
effectiveStartDate
effectiveEndDate
effectiveSequence
effectiveLatestChange
assignmentType
assignmentNumber
primaryFlag
businessTitle
workAtHomeFlag
officeBuilding
officeFloor
officeMailStop
officeNumber
primaryAssignmentFlag
primaryWorkRelationshipFlag
timeUpdated
updatedBy
timeCreated
createdBy
systemPersonType
labourUnionMemberFlag
managerFlag
probationEndDate
probationPeriod
probationPeriodUnit
normalHours
frequency
endTime
startTime
noticePeriod
noticePeriodUOM
workerCategory
assignmentCategory
hourlyPaidOrSalaried
projectedEndDate
projectedStartDate
assignmentStatusType
expenseCheckSendToAddress
retirementAge
retirementDate
synchronizeFromPositionFlag
fullTimeOrPartTime
permanentAssignmentFlag
seniorityBasis
overtimePeriod
adjustedFullTimeEquivalent
annualWorkingDuration
annualWorkingDurationUnit
annualWorkingRatio
standardFrequency
standardWorkingHours
standardAnnualWorkingDuration
sequence
department.id
legalEmployer.id
legislation.territoryCode
legislation.territoryShortName
position.id
grade.id
location.id
location.mainAddress.id
location.mainAddress.country.territoryCode
location.mainAddress.country.territoryShortName
job.id
job.jobFamily.id
collectiveAgreement.id
personType.id
personType.userPersonType
workerUnion.id
assignmentUserStatus.id
assignmentUserStatus.userStatus
businessUnit.id
account.codeCombinationId
account.concatenatedSegments
account.chartOfAccountsId
ledger.ledgerId
ledger.name
workRelationship.id
localName.id
globalName.id
personDetail.id
personDetail.personNumber
actionOccurrence.id
peopleGroup.id
workerExtracts id
personDetail.id
personDetail.effectiveStartDate
personDetail.effectiveEndDate
personDetail.personNumber
personDetail.primaryNationalIdentifier.id
personDetail.primaryNationalIdentifier.identifierNumber
personDetail.primaryEmail.id
personDetail.primaryEmail.emailAddress
personDetail.primaryPhone.id
personDetail.primaryPhone.phoneNumber
personDetail.primaryPhone.areaCode
personDetail.primaryPhone.countryCodeNumber
personDetail.primaryPhone.extension
personDetail.mailingAddress.id
personDetail.mailingAddress.effectiveStartDate
personDetail.mailingAddress.effectiveEndDate
personDetail.mailingAddress.addressLine1
personDetail.mailingAddress.addressLine2
personDetail.mailingAddress.addressLine3
personDetail.mailingAddress.addressLine4
personDetail.mailingAddress.building
personDetail.mailingAddress.floorNumber
personDetail.mailingAddress.townOrCity
personDetail.mailingAddress.county
personDetail.mailingAddress.state
personDetail.mailingAddress.province
personDetail.mailingAddress.postalCode
personDetail.mailingAddress.longPostalCode
personDetail.mailingAddress.country.territoryCode
personDetail.mailingAddress.country.territoryShortName
personDetail.localName.id
personDetail.localName.effectiveStartDate
personDetail.localName.effectiveEndDate
personDetail.localName.lastName
personDetail.localName.firstName
personDetail.localName.displayName
personDetail.localName.listName
personDetail.globalName.id
personDetail.globalName.effectiveStartDate
personDetail.globalName.effectiveEndDate
personDetail.globalName.lastName
personDetail.globalName.firstName
personDetail.globalName.displayName
personDetail.globalName.listName
workRelationshipExtracts id
startDate
workerType
timeCreated
timeUpdated
workerNumber
primaryFlag
createdBy
updatedBy
readyToConvertFlag
enterpriseSeniorityDate
legalEmployerSeniorityDate
onMilitaryServiceFlag
lastWorkingDate
terminationDate
notificationDate
projectedTerminationDate
legalEmployer.id
legalEmployer.name
legalEmployer.effectiveStartDate
legalEmployer.effectiveEndDate
legislation.territoryCode
legislation.territoryShortName
personDetail.id
personDetail.personNumber
personDetail.effectiveStartDate
personDetail.effectiveEndDate

RH Global - Estruturas de Trabalho

Nome do Módulo oraHcmHrCoreWorkStructures
Caminho de Contexto do Módulo hcmHrCore/workStructures

Nome da View Atributos
gradeExtracts id
code
effectiveStartDate
effectiveEndDate
status
timeUpdated
atualizadoPor
horaCriada
criadaPor
nome
açãoOcorrência.id
gradeHistoryExtracts id
code
effectiveStartDate
effectiveEndDate
status
timeUpdated
atualizadoPor
horaCriada
criadaPor
nome
açãoOcorrência.id
gradeExtratos da Escada id
effectiveStartDate
effectiveEndDate
activeStatus
allowProgressionOverrideFlag
allowSalaryOverrideFlag
autoProgressionCode
autoSalaryChangeCode
createdBy
groupCode
gradeType
name
progressionDateCode
progressionStyleCode
rateChangeDateCode
salaryAdjustmentTypeCode
salaryCalculationMethodCode
salaryChangeDateCode
salaryUpdateMethodCode
stepDeterminationCode
timeCreated
timeUpdated
updateSalaryFlag
atualizadoPor
actionOccurrence.id
jobExtracts id
effectiveStartDate
effectiveEndDate
código
status
criado por
horaCriado por
atualizado por
horárioAtualizado
nome
açãoOcorrência.id
jobFamilyExtracts id
effectiveStartDate
effectiveEndDate
código
status
criado por
horaCriado por
atualizado por
horárioAtualizado
nome
açãoOcorrência.id
jobFamilyHistoryExtracts id
effectiveStartDate
effectiveEndDate
código
status
criado por
horaCriado por
atualizado por
horárioAtualizado
nome
açãoOcorrência.id
jobHistoryExtracts id
effectiveStartDate
effectiveEndDate
código
status
criado por
horaCriado por
atualizado por
horárioAtualizado
nome
açãoOcorrência.id
legislativeDataGroupExtracts nome
id
createdBy
timeCreated
timeUpdated
updatedBy
country.territoryCode
country.territoryShortName
locationAddressExtracts id
effectiveStartDate
effectiveEndDate
tipo
construção
número do piso
código do país
código do país
código postal
longPostalCode
linha de endereço1
linha de endereço2
linha de endereço3
linha de endereço4
país
estado
província
criado por
atualizado por
timeCreated
timeUpdated
addressCreatedBy
addressTimeCreated
addressTimeUpdated
endressUpdatedBy
locationExtracts id
code
createdBy
timeCreated
updatedBy
timeUpdated
employeeLocationFlag
effectiveStartDate
effectiveEndDate
countryCode
status
shipToSiteFlag
receivingSiteFlag
billToSiteFlag
officeSiteFlag
detailCreatedBy
detailTimeCreated
detailUpdatedBy
detailTimeUpdated
timezoneCode
description
name
actionOccurrence.id
mainAddress.id
mainAddress.effectiveStartDate
mainAddress.effectiveEndDate
locationHistoryExtracts código id
código
createdBy
timeCreated
updatedBy
timeUpdated
employeeLocationFlag
effectiveStartDate
effectiveEndDate
countryCode
status
shipToSiteFlag
receivingSiteFlag
billToSiteFlag
officeSiteFlag
detailCreatedBy
detailTimeCreated
detailUpdatedBy
detailTimeUpdatedBy
timezoneCode
descrição
nome
açãoOccurrence.id
organizationExtracts id
effectiveStartDate
effectiveEndDate
nome
título
criadoPor
atualizadoPor
horaCriada
horaAtualizada
classificações.id
classificações.effectiveStartDate
classificações.effectiveEndDate
classificações.código
location.id
location.effectiveStartDate
location.effectiveEndDate
location.name
local.código
organizationHistoryExtracts id
effectiveStartDate
effectiveEndDate
nome
título
criadoPor
atualizadoPor
horaCriado
tempoAtualizado
classificações.id
classificações.effectiveStartDate
classificações.effectiveEndDate
classificações.código
local.id
location.effectiveStartDate
location.effectiveEndDate
location.name
local.código
positionExtracts id
effectiveStartDate
effectiveEndDate
código
status
hiringStatus
criado por
timeCreated
updatedBy
timeUpdated
name
actionOccurrence.id
positionHistoryExtracts id
effectiveStartDate
effectiveEndDate
código
status
hiringStatus
criado por
timeCreated
updatedBy
timeUpdated
name
actionOccurrence.id

HCM Comum - Eventos

Nome do Módulo oraHcmHrCoreEvents
Caminho de Contexto do Módulo hcmHrCore/events

Nome da View Atributos
objectChangeExtracts id
sourceObjectName
groupSequence
operationType
dateEffectiveMode
effectiveDate
keyAttribute1Name
keyAttribute1DataType
keyAttribute1StringValue
keyAttribute1NumberValue
keyAttribute1DateValue
keyAttribute2Name
keyAttribute2DataType
keyAttribute2StringValue
keyAttribute2NumberValue
keyAttribute2DateValue
keyAttribute3Name
keyAttribute3DataType
keyAttribute3StringValue
keyAttribute3NumberValue
keyAttribute3DateValue
purgeDate
createdBy
timeCreated
updatedBy
timeUpdated
changeComponents.id
changeComponents.physicalType
changeComponents.logicalType
changeComponents.oldEffectiveStartDate
changeComponents.newEffectiveStartDate
changeComponents.oldEffectiveEndDate
changeComponents.newEffectiveEndDate
changeComponents.oldEffectiveSequence
changeComponents.newEffectiveSequence
changeComponents.createdBy
changeComponents.timeCreated
changeComponents.updatedBy
changeComponents.timeUpdated
changeComponents.changedAttributes.changedAttributesXml

Folha de Pagamentos - Definições de Saldo

Nome do Módulo oraHcmPayrollBalanceDefinitions
Caminho de Contexto do Módulo hcmPayroll/balanceDefinitions

Nome da View Atributos
balanceAttributeDefaultExtracts id
criadoPor
código de legislação
timeCreated
timeUpdated
updatedBy
legislativeDataGroup.id
balanceDimension.id
attributeExclusion.id
balanceAttributeExtracts id
criadoPor
código de legislação
timeCreated
timeUpdated
updatedBy
legislativeDataGroup.id
definedBalance.id
attributeExclusion.id
balanceDimensionExtracts id
code
legislationCode
dimensionLevel
dimensionType
periodType
baseDatabaseItemSuffix
description
paymentsFlag
expiryCheckingLevel
feedCheckingType
initialDate
timeUpdated
timeCreated
timePeriod.id
timePeriod.name
initialTimeDefinition.id
initialTimeDefinition.name
expiryTimeDefinition.id
expiryTimeDefinition.name
startTimeDefinition.id
startTimeDefinition.name
endTimeDefinition.id
endTimeDefinition.name
legislativeDataGroup.id
legislativeDataGroup.name
assignmentActionBalanceDimension.id
balanceExtracts id
código
currencyCode
descrição
nome
remunerationFlag
reportingName
timeCreated
timeUpdated
uomCode
legislationCode
criatedBy
updatedBy
comentários
baseBalanceType.id
baseBalanceType.name
inputValue.id
inputValue.effectiveStartDate
inputValue.effectiveEndDate
legislativeDataGroup.id
balanceGroupAttributeExclusionExtracts id
código
alterável
código de legislação
groupLevelFlag
timeCreated
timeUpdated
createdBy
updatedBy
balanceDimension.id
legislativeDataGroup.id
legislativeDataGroup.name
balanceGroupAttributeInclusionExtracts id
legislationCode
timeCreated
timeUpdated
balanceGroup.id
attributeExclusion.id
legislativeDataGroup.id
legislativeDataGroup.name
balanceGroupExtracts id
code
código de legislação
balanceCategoryAttributeFlag
balanceDimensionAttributeFlag
groupLevelFlag
timeCreated
timeUpdated
legislativeDataGroup.id
balanceGroupUsageExtracts id
balanceReportType
createdBy
descrição
formatType
legislationCode
timeCreated
timeUpdated
updatedBy
code
name
balanceGroup.id
legialtiveDataGroup.id
balanceReportSortItemExtracts id
createdBy
legislationCode
timeCreated
timeUpdated
updatedBy
sequenceNumber
legialtiveDataGroup.id
extratos de saldo definidos id
legislationCode
grossupAllowedFlag
grossupExcludeByDefault
saveRunBalance
timeCreated
timeUpdated
balanceType.id
balanceType.name
balanceDimension.id
legislativeDataGroup.
dimensionUsageExtracts id
nome
databaseItemSuffix
código de legislação
useInExceptionReportingFlag
timeCreated
timeUpdated
balanceDimension.id
legislativeDataGroup.id

Folha de Pagamento - Definições de Elemento

Nome do Módulo oraHcmPayrollElementDefinitions
Caminho de Contexto do Módulo hcmPayroll/elementDefinitions

Nome da View Atributos
elementClassificationExtracts id
code
costableFlag
costingDebitOrCredit
createByDefaultFlag
createdBy
dateFrom
dateTo
defaultHighPriority
defaultLowPriority
defaultPriority
description
distributableOverFlag
frequencyRuleEnabledFlag
legislationCode
name
nonPaymentsFlag
processWhenEarningFlag
secondaryClassificationFlag
timeCreated
timeUpdated
updatedBy
baseClassification.id
baseClassification.name
parentClassification.id
parentClassification.name
legislativeDataGroup.id
legislativeDataGroup.name
elementHistoryExtracts id
code
effectiveStartDate
effectiveEndDate
grossupFlag
indirectOnlyFlag
inputCurrencyCode
outputCurrencyCode
iterativeFlag
iterativePriority
creatorType
deductionOrExemption
legislationCode
multipleEntriesAllowedFlag
onceEachPeriodFlag
processInRunFlag
processMode
processingPriority
processingType
standardLinkFlag
timeDefinitionType
validationOverrideMessage
closedForEntryFlag
additionalEntryAllowedFlag
timeUpdated
updatedBy
timeCreated
createdBy
category
description
expeditedMode
name
parentBaseElementName
reportingName
primaryClassification.id
primaryClassification.name
secondaryClassification.id
secondaryClassification.name
endingTimeDefinition.id
endingTimeDefinition.name
frequencyTimeDefinition.id
frequencyTimeDefinition.name
startingTimeDefinition.id
startingTimeDefinition.name
legislativeDataGroup.id
legislativeDataGroup.name
inputValueHistoryExtracts id
code
createdBy
defaultValue
displaySequence
effectiveEndDate
effectiveStartDate
forceRunResultValueFlag
generateDatabaseItemsFlag
hotDefaultFlag
lookupType
mandatoryFlag
maximumValue
minimumValue
name
reservedInputValue
retroActiveStaticFlag
timeCreated
timeUpdated
unitOfMeasure
updatedBy
userDisplayFlag
userEnterableFlag
validationOverrideMessage
valueSetCode
viewObjectName
warningOrError
element.id
element.name

Folha de Pagamento - Definições da Folha de Pagamento

Nome do Módulo oraHcmPayrollDefinitions
Caminho de Contexto do Módulo hcmPayroll/definitions

Nome da View Atributos
ConsolidationGroupExtracts nome
de código
id
timeCreated
timeUpdated
descrição
createdBy
updatedBy
legislativeDataGroup.id
legislativeDataGroup.name
Folha de pagamentoHistoryExtracts id
effectiveStartDate
effectiveEndDate
name
periodType
firstPeriodEndDate
numberOfYears
periodResetYears
cutoffDateOffset
regularEarnDateOffset
regularProcessDateOffset
payslipViewDateOffset
negativePayAllowedFlag
timeCreated
timeUpdated
baseOffsets
paymentDayType
payslipAvailabilityDayType
cutoffDayType
payrollRunDayType
earningsDayType
payslipAvailabilityBaseDate
cutoffBaseDate
payrollRunBaseDate
earningsBaseDate
paymentBaseDate
earningsOffsetDays
paymentOffsetDays
payslipAvailabilityOffsetDays
cutoffOffsetDays
payslipOffset
earningsOffset
processOffset
cutoffOffset
defaultPaydateOffset
earningsFixedDate
payslipAvailabilityFixedDate
cutoffFixedDate
payrollRunFixedDate
paymentFixedDate
reportingName
processSubDateOffset
plannedSubmissionDayType
plannedSubmissionBaseDate
processSubOffset
plannedSubmissionFixedDate
consolidationGroup.id
consolidationGroup.name
ledger.ledgerId
timeDefinition.id
timeDefinition.name
legislativeDataGroup.id
legislativeDataGroup.name
TimeDefinitionExtracts id
shortName
nome
definitionType
periodType
periodUnit
dayAdjustment
legislationCode
numberOfYears
startDate
creatorType
dynamicCode
timeCreated
timeUpdated
createdBy
updatedBy
baseTimeDefinition.id
baseTimeDefinition.name
periodTimeDefinition.id
periodTimeDefinition.name
legislativeDataGroup.id
legislativeDataGroup.name
Extratos de Período id
legislationCode
endDate
name
periodNumber
periodType
startDate
cutOffDate
description
periodSetName
periodYear
quarterNumber
quickpayDisplayNumber
runDisplayNumber
status
defaultPaydate
regularProcessDate
plannedSubmissionDate
regularEarnDate
yearNumber
periodCategory
payslipViewDate
timeCreated
timeUpdated
createdBy
updatedBy
payroll.id
payroll.effectiveStartDate
payroll.effectiveEndDate
payroll.name
timeDefinition.id
timeDefinition.name
legislativeDataGroup.id
legislativeDataGroup.name

Folha de Pagamento - Relacionamentos da Folha de Pagamento

Nome do Módulo oraHcmPayrollRelationships
Caminho de Contexto do Módulo hcmPayroll/relationships

Nome da View Atributos
DetalhesHistóricosExtratos de Folha de Pagamento atribuídos id
effectiveStartDate
effectiveEndDate
timeCardRequiredFlag
primaryFlag
timeCreated
timeUpdated
updatedBy
createdBy
overtimePeriod.id
overtimePeriod.name
elementCriteria.id
assignedPayroll.id
assignedPayroll.payroll.id
assignedPayroll.payroll.name
assignedPayroll.legislativeDataGroup.id
assignedPayroll.legislativeDataGroup.name
assignedPayroll.payrollAssignment.id
assignedPayroll.payrollAssignment.assignmentNumber
assignedPayroll.payrollAssignment.startDate
assignedPayroll.payrollAssignment.endDate
assignedPayroll.payrollAssignment.payrollRelationship.id
assignedPayroll.payrollAssignment.payrollRelationship.payrollRelationshipNumber
assignedPayroll.payrollAssignment.payrollRelationship.person.id
assignedPayroll.payrollAssignment.payrollRelationship.person.personNumber
assignedPayroll.payrollAssignment.payrollRelationship.person.globalName.id
assignedPayroll.payrollAssignment.payrollRelationship.person.globalName.lastName
assignedPayroll.payrollAssignment.payrollRelationship.person.globalName.firstName
assignedPayroll.payrollAssignment.payrollRelationship.person.globalName.displayName
assignedPayroll.payrollAssignment.payrollRelationship.person.globalName.listName
assignedPayroll.payrollAssignment.payrollRelationship.payrollStatutoryUnit.id
assignedPayroll.payrollAssignment.payrollRelationship.payrollStatutoryUnit.name
assignedPayroll.payrollAssignment.assignment.id
assignedPayroll.payrollAssignment.assignment.effectiveSequence
assignedPayroll.payrollAssignment.assignment.effectiveLatestChange
assignedPayroll.payrollAssignment.assignment.assignmentNumber
assignedPayroll.payrollAssignment.assignment.businessTitle
assignedPayroll.payrollAssignment.assignment.assignmentType
assignedPayroll.payrollAssignment.assignment.assignmentStatusType
assignedPayroll.payrollAssignment.assignment.systemPersonType
assignedPayroll.payrollAssignment.assignment.primaryAssignmentFlag
assignedPayroll.payrollAssignment.assignment.primaryWorkRelationshipFlag
assignedPayroll.payrollAssignment.assignment.primaryFlag
assignedPayroll.payrollAssignment.assignment.workerCategory
assignedPayroll.payrollAssignment.assignment.assignmentCategory
assignedPayroll.payrollAssignment.assignment.frequency
assignedPayroll.payrollAssignment.assignment.timeUpdated
assignedPayroll.payrollAssignment.assignment.timeCreated
assignedPayroll.payrollAssignment.assignment.department.id
assignedPayroll.payrollAssignment.assignment.department.name
assignedPayroll.payrollAssignment.assignment.department.title
assignedPayroll.payrollAssignment.assignment.legalEmployer.id
assignedPayroll.payrollAssignment.assignment.legalEmployer.name
assignedPayroll.payrollAssignment.assignment.legislation.territoryCode
assignedPayroll.payrollAssignment.assignment.legislation.territoryShortName
assignedPayroll.payrollAssignment.assignment.position.id
assignedPayroll.payrollAssignment.assignment.position.name
assignedPayroll.payrollAssignment.assignment.position.code
assignedPayroll.payrollAssignment.assignment.grade.id
assignedPayroll.payrollAssignment.assignment.grade.name
assignedPayroll.payrollAssignment.assignment.grade.code
assignedPayroll.payrollAssignment.assignment.location.id
assignedPayroll.payrollAssignment.assignment.location.name
assignedPayroll.payrollAssignment.assignment.location.code
assignedPayroll.payrollAssignment.assignment.job.id
assignedPayroll.payrollAssignment.assignment.job.name
assignedPayroll.payrollAssignment.assignment.job.code
assignedPayroll.payrollAssignment.assignment.businessUnit.id
assignedPayroll.payrollAssignment.assignment.businessUnit.name
assignedPayroll.payrollAssignment.assignment.workRelationship.id
assignedPayroll.payrollAssignment.assignment.workRelationship.startDate
assignedPayroll.payrollAssignment.assignment.workRelationship.enterpriseSeniorityDate
assignedPayroll.payrollAssignment.assignment.workRelationship.primaryFlag
assignedPayroll.payrollAssignment.assignment.workRelationship.workerNumber
assignedPayroll.payrollAssignment.assignment.workRelationship.terminationDate
assignedPayroll.payrollAssignment.assignment.workRelationship.legalEmployerSeniorityDate
Extratos de Folha de Pagamento atribuídos id
createdBy
endDate
finalCloseDate
firstStandardEarningDate
lastStandardEarningDate
lastStandardProcessDate
startDate
timeCreated
timeUpdated
updatedBy
payroll.id
payroll.name
payroll.effectiveStartDate
payroll.effectiveEndDate
payrollTerm.id
payrollAssignment.id
payrollAssignment.assignmentNumber
payrollAssignment.startDate
payrollAssignment.endDate
payrollAssignment.payrollRelationship.id
payrollAssignment.payrollRelationship.payrollRelationshipNumber
payrollAssignment.payrollRelationship.person.id
payrollAssignment.payrollRelationship.person.personNumber
payrollAssignment.payrollRelationship.person.effectiveStartDate
payrollAssignment.payrollRelationship.person.effectiveEndDate
payrollAssignment.payrollRelationship.person.globalName.id
payrollAssignment.payrollRelationship.person.globalName.effectiveStartDate
payrollAssignment.payrollRelationship.person.globalName.effectiveEndDate
payrollAssignment.payrollRelationship.person.globalName.lastName
payrollAssignment.payrollRelationship.person.globalName.firstName
payrollAssignment.payrollRelationship.person.globalName.displayName
payrollAssignment.payrollRelationship.person.globalName.listName
payrollAssignment.payrollRelationship.payrollStatutoryUnit.id
payrollAssignment.payrollRelationship.payrollStatutoryUnit.name
payrollAssignment.payrollRelationship.payrollStatutoryUnit.effectiveStartDate
payrollAssignment.payrollRelationship.payrollStatutoryUnit.effectiveEndDate
payrollAssignment.assignment.id
payrollAssignment.assignment.effectiveStartDate
payrollAssignment.assignment.effectiveEndDate
payrollAssignment.assignment.effectiveSequence
payrollAssignment.assignment.effectiveLatestChange
payrollAssignment.assignment.assignmentNumber
payrollAssignment.assignment.businessTitle
payrollAssignment.assignment.assignmentType
payrollAssignment.assignment.assignmentStatusType
payrollAssignment.assignment.systemPersonType
payrollAssignment.assignment.primaryAssignmentFlag
payrollAssignment.assignment.primaryWorkRelationshipFlag
payrollAssignment.assignment.primaryFlag
payrollAssignment.assignment.workerCategory
payrollAssignment.assignment.assignmentCategory
payrollAssignment.assignment.frequency
payrollAssignment.assignment.timeUpdated
payrollAssignment.assignment.timeCreated
payrollAssignment.assignment.department.id
payrollAssignment.assignment.department.name
payrollAssignment.assignment.department.title
payrollAssignment.assignment.department.effectiveStartDate
payrollAssignment.assignment.department.effectiveEndDate
payrollAssignment.assignment.legalEmployer.id
payrollAssignment.assignment.legalEmployer.name
payrollAssignment.assignment.legalEmployer.effectiveStartDate
payrollAssignment.assignment.legalEmployer.effectiveEndDate
payrollAssignment.assignment.legislation.territoryCode
payrollAssignment.assignment.legislation.territoryShortName
payrollAssignment.assignment.position.id
payrollAssignment.assignment.position.effectiveStartDate
payrollAssignment.assignment.position.effectiveEndDate
payrollAssignment.assignment.position.name
payrollAssignment.assignment.position.code
payrollAssignment.assignment.grade.id
payrollAssignment.assignment.grade.effectiveStartDate
payrollAssignment.assignment.grade.effectiveEndDate
payrollAssignment.assignment.grade.name
payrollAssignment.assignment.grade.code
payrollAssignment.assignment.location.id
payrollAssignment.assignment.location.effectiveStartDate
payrollAssignment.assignment.location.effectiveEndDate
payrollAssignment.assignment.location.name
payrollAssignment.assignment.location.code
payrollAssignment.assignment.job.id
payrollAssignment.assignment.job.effectiveStartDate
payrollAssignment.assignment.job.effectiveEndDate
payrollAssignment.assignment.job.name
payrollAssignment.assignment.job.code
payrollAssignment.assignment.businessUnit.id
payrollAssignment.assignment.businessUnit.effectiveStartDate
payrollAssignment.assignment.businessUnit.effectiveEndDate
payrollAssignment.assignment.businessUnit.name
payrollAssignment.assignment.workRelationship.id
payrollAssignment.assignment.workRelationship.startDate
payrollAssignment.assignment.workRelationship.enterpriseSeniorityDate
payrollAssignment.assignment.workRelationship.primaryFlag
payrollAssignment.assignment.workRelationship.workerNumber
payrollAssignment.assignment.workRelationship.terminationDate
payrollAssignment.assignment.workRelationship.legalEmployerSeniorityDate
legislativeDataGroup.id
legislativeDataGroup.name
payrollEmploymentDateExtracts id
createdBy
dateValue
sourceType
timeCreated
timeUpdated
atualizadoPor
assignedPayroll.id
payrollTerm.id
payrollTerm.assignmentNumber
payrollAssignment.id
payrollAssignment.assignmentNumber
payrollRelationship.id
payrollRelationship.payrollRelationshipNumber
timeDefintion.id
timeDefintion.name
payrollRelationshipDetailHistoryExtracts id
effectiveStartDate
effectiveEndDate
timeCreated
timeUpdated
updatedBy
createdBy
payrollRelationship.id
payrollRelationship.createdBy
payrollRelationship.endDate
payrollRelationship.payrollRelationshipNumber
payrollRelationship.startDate
payrollRelationship.timeCreated
payrollRelationship.timeUpdated
payrollRelationship.updatedBy
payrollRelationship.payrollStatutoryUnit.id
payrollRelationship.payrollStatutoryUnit.name
payrollRelationship.legislativeDataGroup.id
payrollRelationship.legislativeDataGroup.name
payrollRelationship.relationshipType.id
payrollRelationship.relationshipType.name
payrollRelationship.person.id
payrollRelationship.person.personNumber
payrollRelationship.person.globalName.id
payrollRelationship.person.globalName.lastName
payrollRelationship.person.globalName.firstName
payrollRelationship.person.globalName.displayName
payrollRelationship.person.globalName.listName
overtimePeriod.id
overtimePeriod.name
elementCriteria.id
payrollRelationshipExtracts id
createdBy
endDate
payrollRelationshipNumber
startDate
timeCreated
timeUpdated
updatedBy
payrollStatutoryUnit.id
payrollStatutoryUnit.name
payrollStatutoryUnit.effectiveStartDate
payrollStatutoryUnit.effectiveEndDate
person.id
person.personNumber
person.effectiveStartDate
person.effectiveEndDate
person.globalName.id
person.globalName.effectiveStartDate
person.globalName.effectiveEndDate
person.globalName.lastName
person.globalName.firstName
person.globalName.displayName
person.globalName.listName
legislativeDataGroup.id
legislativeDataGroup.name
relationshipType.id
relationshipType.name
relationshipGroupDetailHistoryExtracts id
effectiveStartDate
effectiveEndDate
timeCardRequiredFlag
timeCreated
timeUpdated
atualizadoPor
criadoPor
overtimePeriod.id
overtimePeriod.name
assignmentStatusType.id
assignmentStatusType.assignmentStatusCode
elementCriteria.id
RelationshipGroupExtracts id
assignmentNumber
createdBy
endDate
groupType
startDate
timeCreated
timeUpdated
updatedBy
payrollRelationship.id
payrollRelationship.payrollRelationshipNumber
payrollTerm.id
assignment.id
assignment.effectiveStartDate
assignment.effectiveEndDate
assignment.effectiveSequence
assignment.effectiveLatestChange
assignment.assignmentNumber
legalEmployer.id
legalEmployer.name
legalEmployer.effectiveStartDate
legalEmployer.effectiveEndDate
taxReportingUnit.id
taxReportingUnit.name
taxReportingUnit.effectiveStartDate
taxReportingUnit.effectiveEndDate
legislativeDataGroup.id
legislativeDataGroup.name

Folha de Pagamento - Métodos de Pagamento Pessoal

Nome do Módulo oraHcmPayrollPersonalPaymentMethods
Caminho de Contexto do Módulo hcmPayroll/personalPaymentMethods

Nome da View Atributos
PersonalPaymentMethodHistoryExtracts id
effectiveStartDate
effectiveEndDate
valor
criadoPor
nome
paymentAmountType
porcentagem
prioridade
remainingAmountFlag
timeCreated
timeUpdated
atualizadoPor
legislativeDataGroup.id
legislativeDataGroup.name
payrollRelationship.id
payrollRelationship.payrollRelationshipNumber

Folha de Pagamento - Tarefas do Fluxo de Processo

Nome do Módulo oraHcmPayrollProcessFlowTasks
Caminho de Contexto do Módulo hcmPayroll/processFlowTasks

Nome da View Atributos
taskActionExtracts id
activeIndicator
código
createdBy
defaultActionFlag
descrição
executionMode
legislationCode
método
nome
parentActionFlag
actionSequence
timeCreated
timeUpdated
tipo
updatedBy
baseTaskAction.id
legislativeDataGroup.id
legislativeDataGroup.name
taskExtracts id
automaticFlag
código
createdBy
defaultCategoryType
defaultChecklistName
defaultSubCategoryType
descrição
destinationUiUrl
hideIncompleteActionFlag
legislationCode
nome
requestCategory
submittingUserIndicator
timeCreated
timeUpdated
type
updatedBy
baseTask.id
baseTask.name
legislativeDataGroup.id
legislativeDataGroup.name

Folha de Pagamentos - Resultados do Processo

Nome do Módulo oraHcmPayrollProcessResults
Caminho de Contexto do Módulo hcmPayroll/processResults

Nome da View Atributos
payrollActionExtracts id
actionPopulationStatus
actionSequence
actionStatus
actionTypeCode
batchProcessMode
chequeProcedure
costingProcessMode
currentChunkNumber
currentTask
dateEarned
displayRunNumber
effectiveDate
eftExpiryDate
eftFileReference
endChequeNumber
endDate
expediteFlag
fileName
futureProcessMode
legislationCode
legislativeParameters
overrideDate
overridingDdDate
payPayeeType
paymentReason
processPhase
startChequeNumber
startDate
timeCreated
timeUpdated
updatedBy
payroll.id
payroll.effectiveStartDate
payroll.effectiveEndDate
consolidationSet.id
deductionTimePeriod.id
earnTimePeriod.id
legislativeDataGroup.id
payrollAction.id
payrollRelationshipActionExtracts id
actionSequence
actionStatusCode
chunkNumber
endDate
serialNumber
startDate
parentObject
processPath
payrollAction.id
payrollRelationship.id
pré-pagamento.id
personResultsMessageExtracts id
lineSequence
lineText
messageLevel
name
sourceType
payrollRelationshipAction.id
payrollRelationshipAction.payrollAction.id
payrollRelationshipAction.payrollAction.effectiveDate
payrollRelationshipAction.payrollAction.dateEarned
payrollRelationshipAction.payrollAction.startDate
payrollRelationshipAction.payrollAction.endDate
payrollRelationshipAction.payrollAction.payroll.id
payrollRelationshipAction.payrollAction.payroll.effectiveStartDate
payrollRelationshipAction.payrollAction.payroll.effectiveEndDate
payrollRelationshipAction.payrollAction.payroll.name
payrollRelationshipAction.payrollAction.actionType.lookupCode
payrollRelationshipAction.payrollAction.actionType.lookupType
payrollRelationshipAction.payrollAction.actionType.meaning
payrollRelationshipAction.payrollAction.legislativeDataGroup.id
payrollRelationshipAction.payrollAction.legislativeDataGroup.name
payrollRelationshipAction.payrollAction.payrollFlowActionStatistic.id
payrollRelationshipAction.payrollAction.payrollFlowActionStatistic.flowName
payrollRelationshipAction.payrollAction.payrollFlowActionStatistic.timeCreated
payrollRelationshipAction.payrollAction.payrollFlowActionStatistic.task.id
payrollRelationshipAction.payrollAction.payrollFlowActionStatistic.task.name
payrollRelationshipAction.payrollAction.payrollFlowActionStatistic.task.code
payrollRelationshipAction.payrollRelationship.id
payrollRelationshipAction.payrollRelationship.payrollRelationshipNumber
payrollRelationshipAction.payrollRelationship.person.id
payrollRelationshipAction.payrollRelationship.person.personNumber
payrollRelationshipAction.payrollRelationship.person.effectiveStartDate
payrollRelationshipAction.payrollRelationship.person.effectiveEndDate
payrollRelationshipAction.payrollRelationship.person.globalName.id
payrollRelationshipAction.payrollRelationship.person.globalName.effectiveStartDate
payrollRelationshipAction.payrollRelationship.person.globalName.effectiveEndDate
payrollRelationshipAction.payrollRelationship.person.globalName.lastName
payrollRelationshipAction.payrollRelationship.person.globalName.firstName
payrollRelationshipAction.payrollRelationship.person.globalName.displayName
payrollRelationshipAction.payrollRelationship.person.globalName.listName
payrollRelationshipAction.actionStatus.lookupCode
payrollRelationshipAction.actionStatus.lookupType
payrollRelationshipAction.actionStatus.meaning
payroll.id
payroll.effectiveStartDate
payroll.effectiveEndDate
payroll.name
ProcessResultsMessageExtracts id
lineSequence
lineText
messageLevel
name
sourceType
payrollAction.id
payrollAction.effectiveDate
payrollAction.dateEarned
payrollAction.payroll.id
payrollAction.payroll.effectiveStartDate
payrollAction.payroll.effectiveEndDate
payrollAction.payroll.name
payrollAction.actionType.lookupCode
payrollAction.actionType.lookupType
payrollAction.actionType.meaning
payrollAction.legislativeDataGroup.id
payrollAction.legislativeDataGroup.name
payrollAction.payrollFlowActionStatistic.id
payrollAction.payrollFlowActionStatistic.flowName
payrollAction.payrollFlowActionStatistic.timeCreated
payrollAction.payrollFlowActionStatistic.task.id
payrollAction.payrollFlowActionStatistic.task.name
payrollAction.payrollFlowActionStatistic.task.code
payroll.id
payroll.effectiveStartDate
payroll.effectiveEndDate
payroll.name

Tarefa 2: Preparando e Testando uma Consulta de Extração

Cada view de extração tem uma API de consulta que permite criar e testar consultas de extração.

URL /api/boss/data/objects/ora/{{moduleContextPath}}/v1/{{viewName}}/$query
Método HTTP POST
Modelo de solicitação
{
    "collection": {
        "limit": {{limit}},
        "offset": {{offset}},
        "sortBy": [ {{sortAttributes}} ],
        "filter": "{{topLevelFilter}}"
    },
    "fields": [ {{topLevelAttributes}} ],
    "accessors": {
        "{{childObject}}": {
            "collection": {
                "filter": "{{childLevelFilter}}"
            },
            "fields": [ {{childLevelAttributes}} ],
            "accessors": {
                {{nestedChildAccessors}}               
            }
        },
        ...
    }
}
Modelo de resposta
200 OK

{
	"items": [
		{{items}}
	],
	"hasMore": {{hasMore}}
}

Objetos e Atributos

Defina quais dados extrair, ou seja, quais objetos e atributos da view devem ser incluídos. A inclusão de objetos filhos requer a adição de accessors, enquanto a inclusão de campos específicos requer a listagem deles no array fields. Consulte o exemplo completo.

Atenção:

Se você não especificar explicitamente accessors e fields filhos, obterá a forma padrão da view. Lembre-se de que a forma padrão pode não incluir todos os objetos e atributos disponíveis da view.

Filtragem

Definir como os dados devem ser filtrados. Você pode usar as expressões a seguir para criar filtros para sua consulta.

Objetivo Expressão Exemplo
Teste de igualdade field = value ename = 'KING'
Teste de desigualdade field != value activeFlag != true
Teste maior que
Teste menor que
field > value
field < value
sal > 1999.99
hireDate < '2000-01-01'
timeUpdated> '1900-01-01T13:51:54Z'
Teste de maior que ou igual a
Teste de menor que ou igual
field >= value
field <= value< code>
sal >= 1999.99
hireDate <= '2000-01-01'
timeUpdated >= '1900-01-01T13:51:54Z'
Correspondência de padrões field LIKE 'pattern' job LIKE 'SALES%'
Teste de associação field IN (value1, ..., valueN) deptno IN (10, 20, 40)
Comparação de não diferenciação de maiúsculas e minúsculas field ~= value
field ~!= value
field ~> value
field ~< value
field ~>= value
field ~<= value
field ~LIKE 'pattern'
field ~IN (value1, ..., valueN)
ename ~= 'king'
Teste de existência (para relacionamentos um para muitos) child[expression] assignments[startDate = null]
Conjunção lógica expression AND expression  
Disjunção lógica expression OR expression  
Negação lógica !(expression)  

Filtragem por objetos filho em um relacionamento um para um:

No caso de relacionamentos um para um, você pode fazer referência a objetos filhos e seus atributos na cláusula de filtro, assim como a atributos de outros objetos pais, por exemplo, legalEmployer.id in (1001, 1002).

Filtrando objetos filhos em um relacionamento de um para muitos:

Em casos raros de relacionamentos um-para-muitos indicados pelo nome do acessador plural, o teste de existência na tabela acima filtrará os pais que têm pelo menos um filho que atende aos critérios. No entanto, isso não significa que os registros filhos, se recuperados, serão filtrados automaticamente. Se quiser garantir que você só obtenha registros filhos que atendam aos critérios, você também precisará repetir o filtro no nível filho.

Por exemplo, se você quiser recuperar apenas componentes de alteração do tipo físico UPDATE, será necessário aplicar os seguintes filtros na consulta de alterações de objeto:


{
    "collection": {
        "filter": "changeComponents[physicalType = 'UPDATE']"
    },
    "accessors": {
        "changeComponents": {
            "collection": {
                "filter": "physicalType = 'UPDATE'"
            },
...
                

Filtrando por data efetiva:

No caso de objetos com data efetiva, você obterá dados efetivos a partir da data atual por padrão. Para recuperar dados efetivos a partir de uma data específica, use o parâmetro de consulta HTTP $effectiveDate.

Por exemplo, se você quiser recuperar dados efetivos a partir de 2023-01-01, use o seguinte URL para sua consulta:

/api/boss/data/objects/ora/hcmHrCore/employment/v1/{{viewPath}}/$query?$effectiveDate=2023-01-01

Classificação

Definir como os dados devem ser classificados. A classificação é expressa por um array de atributos de classificação, incluindo a direção de classificação (asc ou desc). Por exemplo:

"sortBy": [
    {
        "totalAmount": "desc"
    },
    {
        "paidAmount": "asc"
    }
]

Pager

Definir como os dados devem ser paginados. O cliente pode controlar a paginação fornecendo parâmetros de limite e deslocamento. Por exemplo:

"limit": 200,
"offset": 400

O limite padrão é 25 e o limite máximo é 1000.

O deslocamento padrão é 0 e indica o início dos resultados.

O atributo de nível superior hasMore na resposta indica se há mais resultados a serem extraídos.

A paginação não deve ser usada como uma forma alternativa de extrair dados. Ao consultar essa API, não há garantia de que os dados não serão alterados entre as solicitações. Use a API assíncrona para extração de dados.

Exemplo

O exemplo de consulta de extração abaixo foi projetado para recuperar informações de atribuições junto com detalhes do empregador legal e do departamento, que:

  • São atribuições principais
  • São do tipo Funcionário
  • Não pertencem a Empregadores Legais com os IDs 10001 e 10002
  • São efetivos a partir da data de extração
  • Foi atualizado (ou criado) desde a execução anterior

Exemplo de Solicitação

Observe a condição do parâmetro limit e do atributo timeUpdated com o timestamp da execução de extração anterior.

POST /api/boss/data/objects/ora/hcmHrCore/employment/v1/workerAssignmentExtracts/$query
 
{
    "collection": {
        "limit": 10,
        "filter": "primaryFlag = true and timeUpdated > '2025-05-01T00:00:00Z' and assignmentType = 'E' and !(legalEmployer.id in (10001, 10002))"
    },
    "fields": [ "id", "assignmentType", "assignmentStatusType", "effectiveStartDate", "effectiveEndDate", "businessTitle", "workAtHomeFlag", "assignmentNumber", "timeUpdated" ],
    "accessors": {
        "personDetail": {
            "fields": [ "personNumber" ]
        },
        "globalName": {
            "fields": [ "firstName", "lastName" ]
        },
        "department": {
            "fields": [ "id", "name", "title" ]
        },
        "legalEmployer": {
            "fields": [ "id", "name" ]
        },
        "workRelationship": {
            "fields": [ "id" ]
        }
    }
}
				

Exemplo de Resposta

200 OK
 
{
    "items": [
        {
            "id": "300000795682243",
            "assignmentType": "E",
            "assignmentStatusType": "ACTIVE",
            "effectiveStartDate": "2018-06-14",
            "effectiveEndDate": "4712-12-31",
            "businessTitle": "Aeronautical Engineer Level-9352",
            "workAtHomeFlag": false,
            "assignmentNumber": "EHDLWorker_190903_1637",
            "timeUpdated": "2025-05-06T11:42:17.821Z",
            "$id": "300000795682243",
            "$context": {
                "etag": "89"
            },
            "personDetail": {
                "personNumber": "HDLWorker_190903_1637",
                "$id": "100000329366771",
                "$context": {
                    "etag": ""
                }
            },
            "globalName": {
                "firstName": "Raymond-Olivier",
                "lastName": "Beer-Tröst",
                "$id": "300000795668871",
                "$context": {
                    "etag": ""
                }
            },
            "department": {
                "id": "300000044556980",
                "name": "South - Venaria DC-GROUP/SFIELESOIT74155",
                "title": null,
                "$id": "300000044556980",
                "$context": {
                    "etag": "13",
                    "links": {
                        "$self": {
                            "href": "https://example.com/api/boss/data/objects/ora/hcmHrCore/workStructures/v1/departments/300000044556980?$effectiveDate=2025-05-13"
                        }
                    }
                }
            },
            "legalEmployer": {
                "id": "300000046740247",
                "name": "PSR_US_LE_1",
                "$id": "300000046740247",
                "$context": {
                    "etag": "15",
                    "links": {
                        "$self": {
                            "href": "https://example.com/api/boss/data/objects/ora/hcmHrCore/workStructures/v1/legalEmployers/300000046740247?$effectiveDate=2025-05-13"
                        }
                    }
                }
            },
            "workRelationship": {
                "id": "100000329414679",
                "$id": "100000329414679",
                "$context": {
                    "etag": "1"
                }
            }
        },
        {
            "id": "300000795670049",
            "assignmentType": "E",
            "assignmentStatusType": "ACTIVE",
            "effectiveStartDate": "2018-05-28",
            "effectiveEndDate": "4712-12-31",
            "businessTitle": "Civil Engineer-6864",
            "workAtHomeFlag": false,
            "assignmentNumber": "EHDLWorker_190903_11128",
            "timeUpdated": "2025-05-06T11:42:25.787Z",
            "$id": "300000795670049",
            "$context": {
                "etag": "89"
            },
            "personDetail": {
                "personNumber": "HDLWorker_190903_11128",
                "$id": "100000329383875",
                "$context": {
                    "etag": ""
                }
            },
            "globalName": {
                "firstName": "Charlotte-Pénélope",
                "lastName": "Beer-Tröst",
                "$id": "300000795669677",
                "$context": {
                    "etag": ""
                }
            },
            "department": {
                "id": "300000044582197",
                "name": "Human Resources-GROUP/AT081000101",
                "title": null,
                "$id": "300000044582197",
                "$context": {
                    "etag": "13",
                    "links": {
                        "$self": {
                            "href": "https://example.com/api/boss/data/objects/ora/hcmHrCore/workStructures/v1/departments/300000044582197?$effectiveDate=2025-05-13"
                        }
                    }
                }
            },
            "legalEmployer": {
                "id": "300000046740247",
                "name": "PSR_US_LE_1",
                "$id": "300000046740247",
                "$context": {
                    "etag": "15",
                    "links": {
                        "$self": {
                            "href": "https://example.com/api/boss/data/objects/ora/hcmHrCore/workStructures/v1/legalEmployers/300000046740247?$effectiveDate=2025-05-13"
                        }
                    }
                }
            },
            "workRelationship": {
                "id": "100000329453488",
                "$id": "100000329453488",
                "$context": {
                    "etag": "1"
                }
            }
        },
        ...
    ],
    "hasMore": true
}

Tarefa 3: Submetendo uma Solicitação de Tarefa de Extração

Depois que a consulta for definida, uma solicitação de job de extração poderá ser enviada usando a API do Programador de Jobs.

URL /api/saas-batch/jobscheduler/v1/jobRequests
Método HTTP POST
Modelo de solicitação
{
    "jobDefinitionName": "AsyncDataExtraction",
    "serviceName": "boss",
    "requestParameters": {
        "boss.module": "{{moduleName}}",
        "boss.resource.name": "{{viewName}}",
        "boss.resource.version": "v1",
        "boss.outputFormat": "json",
        "boss.request.system.param.effectiveDate": "{{effectiveDate}}",
        "boss.advancedQuery": "{{query}}"
    }
}

boss.request.system.param.effectiveDate é um parâmetro opcional que deve ser fornecido somente se você quiser recuperar dados efetivos a partir da data atual.

Modelo de resposta

No envio bem-sucedido, o código de resposta 202 será retornado, juntamente com o cabeçalho Location com o URL apontando para a instância de solicitação de job específica.

202 Accepted
 
Location: {{jobRequestUrl}}

Paginação ao extrair dados:

Embora você possa ter usado controles de paginação, ou seja, parâmetros limit e offset, ao criar e testar a consulta, não deseja que os resultados da extração sejam restringidos por eles. Remova qualquer uso de parâmetros limit e offset ao enviar uma consulta.

Passando na consulta:

A consulta informada ao enviar a solicitação de job de extração deve estar no formato de uma string JSON padrão. Execute a consulta preparada e testada usando o ponto final da API $query e:
  • Escape de todas as aspas duplas (" → \")
  • Remover qualquer caractere de nova linha (\n)
  • Reduzir potencialmente outros espaços em branco (por exemplo, recuos)

No geral, você deseja ir, por exemplo, de:

{
    "collection": {
        "limit": 100,
        "filter": "totalAmount > 10000"
    },
    "fields": [ "id", "totalAmount" ]
}

Para:

{\"collection\": {\"filter\": \"totalAmount > 10000\"},\"fields\": [ \"id\", \"totalAmount\" ]}

Exemplo

Exemplo de Solicitação

POST /api/saas-batch/jobscheduler/v1/jobRequests
 
{
    "jobDefinitionName": "AsyncDataExtraction",
    "serviceName": "boss",
    "requestParameters": {
        "boss.module": "oraHcmHrCoreEmployment",
        "boss.resource.name": "workerAssignmentExtracts",
        "boss.resource.version": "v1",
        "boss.outputFormat": "json",
        "boss.advancedQuery": "{\"collection\": {\"filter\": \"primaryFlag = true and timeUpdated > '2025-05-01T00:00:00Z' and assignmentType = 'E' and !(legalEmployer.id in (10001, 10002))\"},\"fields\": [ \"id\", \"assignmentType\", \"assignmentStatusType\", \"effectiveStartDate\", \"effectiveEndDate\", \"businessTitle\", \"workAtHomeFlag\", \"assignmentNumber\", \"timeUpdated\" ],\"accessors\": {\"personDetail\": {\"fields\": [ \"personNumber\" ]},\"globalName\": {\"fields\": [ \"firstName\", \"lastName\" ]},\"department\": {\"fields\": [ \"id\", \"name\", \"title\" ]},\"legalEmployer\": {\"fields\": [ \"id\", \"name\" ]},\"workRelationship\": {\"fields\": [ \"id\" ]}}}"
    }
}

Exemplo de Resposta

202 Accepted
 
Location: https://example.com/api/saas-batch/jobscheduler/v1/jobRequests/42075

Tarefa 4: Verificando a Conclusão da Tarefa

A verificação da conclusão envolve o uso da API do Programador de Jobs para sondar periodicamente os detalhes da solicitação de job, até que ela seja concluída com sucesso ou falhe.

URL /api/saas-batch/jobscheduler/v1/jobRequests/{{jobRequestId}}
Método HTTP GET

Conclusão bem-sucedida:

Uma solicitação de job será considerada concluída com sucesso quando as seguintes condições forem atendidas:
Atrib. Valor esperado
jobDetails.jobProgress.completed true
jobDetails.jobProgress.status SUCCEEDED

Falha na conclusão:

Uma solicitação de job será considerada com falha quando a condição a seguir for atendida. Nesse caso, o atributo jobDetails.jobProgress.message conterá a mensagem de erro.
Atrib. Valor esperado
jobDetails.jobProgress.status FAILED

Exemplo

Exemplo de Solicitação

GET /api/saas-batch/jobscheduler/v1/jobRequests/42075

Exemplos de Resposta

As respostas a seguir mostram diferentes estágios de um job enviado. Consulte os atributos jobProgress.status e jobProgress.completed em particular.

Aceito/Enfileirado
200 OK
 
{
    "jobDetails": {
        "jobRequestId": 42075,
        "jobRequest": {
            "jobDefinitionName": "AsyncDataExtraction",
            "serviceName": "boss",
            "systemDerivedVersion": "90",
            "jobSubmitter": "TM-MFITZIMMONS",
            "requestParameters": {
                "boss.module": "oraHcmHrCoreEmployment",
                "boss.resource.name": "workerAssignmentExtracts",
                "boss.resource.version": "v1",
                "boss.outputFormat": "json",
                "boss.advancedQuery": "{\"collection\": {\"filter\": \"primaryFlag = true and timeUpdated > '2025-05-01T00:00:00Z' and assignmentType = 'E' and !(legalEmployer.id in (10001, 10002))\"},\"fields\": [ \"id\", \"assignmentType\", \"assignmentStatusType\", \"effectiveStartDate\", \"effectiveEndDate\", \"businessTitle\", \"workAtHomeFlag\", \"assignmentNumber\", \"timeUpdated\" ],\"accessors\": {\"personDetail\": {\"fields\": [ \"personNumber\" ]},\"globalName\": {\"fields\": [ \"firstName\", \"lastName\" ]},\"department\": {\"fields\": [ \"id\", \"name\", \"title\" ]},\"legalEmployer\": {\"fields\": [ \"id\", \"name\" ]},\"workRelationship\": {\"fields\": [ \"id\" ]}}}"
            },
            "jobRetryNumber": 0,
            "timeoutThreshold": 14400
        },
        "jobStatus": "ENQUEUED",
        "jobProgress": {
            "status": "ACCEPTED",
            "message": "Job is submitted",
            "startTime": "2025-05-25T13:39:01Z",
            "endTime": "2025-05-25T13:39:15Z",
            "completedPercentage": "0",
            "completed": false
        }
    },
    "$context": {
        "links": {
            "$self": {
                "href": "https://example.com/api/saas-batch/jobscheduler/v1/jobRequests/42075"
            }
        }
    }
}
Executando
200 OK
 
{
    "jobDetails": {
        "jobRequestId": 42075,
        "jobRequest": {
            "jobDefinitionName": "AsyncDataExtraction",
            "serviceName": "boss",
            "systemDerivedVersion": "90",
            "jobSubmitter": "TM-MFITZIMMONS",
            "requestParameters": {
                "boss.module": "oraHcmHrCoreEmployment",
                "boss.resource.name": "workerAssignmentExtracts",
                "boss.resource.version": "v1",
                "boss.outputFormat": "json",
                "boss.advancedQuery": "{\"collection\": {\"filter\": \"primaryFlag = true and timeUpdated > '2025-05-01T00:00:00Z' and assignmentType = 'E' and !(legalEmployer.id in (10001, 10002))\"},\"fields\": [ \"id\", \"assignmentType\", \"assignmentStatusType\", \"effectiveStartDate\", \"effectiveEndDate\", \"businessTitle\", \"workAtHomeFlag\", \"assignmentNumber\", \"timeUpdated\" ],\"accessors\": {\"personDetail\": {\"fields\": [ \"personNumber\" ]},\"globalName\": {\"fields\": [ \"firstName\", \"lastName\" ]},\"department\": {\"fields\": [ \"id\", \"name\", \"title\" ]},\"legalEmployer\": {\"fields\": [ \"id\", \"name\" ]},\"workRelationship\": {\"fields\": [ \"id\" ]}}}"
            },
            "jobRetryNumber": 0,
            "timeoutThreshold": 14400
        },
        "jobStatus": "RUNNING",
        "jobProgress": {
            "jobRequestId": 42075,
            "status": "RUNNING",
            "message": "Job status is changed to RUNNING",
            "startTime": "2025-05-25T13:39:27Z",
            "endTime": "2025-05-25T13:40:25Z",
            "completedPercentage": "50",
            "completed": false
        }
    },
    "$context": {
        "links": {
            "$self": {
                "href": "https://example.com/api/saas-batch/jobscheduler/v1/jobRequests/42075"
            }
        }
    }
}
200 OK
 
{
    "jobDetails": {
        "jobRequestId": 42075,
        "jobRequest": {
            "jobDefinitionName": "AsyncDataExtraction",
            "serviceName": "boss",
            "systemDerivedVersion": "90",
            "jobSubmitter": "TM-MFITZIMMONS",
            "requestParameters": {
                "boss.module": "oraHcmHrCoreEmployment",
                "boss.resource.name": "workerAssignmentExtracts",
                "boss.resource.version": "v1",
                "boss.outputFormat": "json",
                "boss.advancedQuery": "{\"collection\": {\"filter\": \"primaryFlag = true and timeUpdated > '2025-05-01T00:00:00Z' and assignmentType = 'E' and !(legalEmployer.id in (10001, 10002))\"},\"fields\": [ \"id\", \"assignmentType\", \"assignmentStatusType\", \"effectiveStartDate\", \"effectiveEndDate\", \"businessTitle\", \"workAtHomeFlag\", \"assignmentNumber\", \"timeUpdated\" ],\"accessors\": {\"personDetail\": {\"fields\": [ \"personNumber\" ]},\"globalName\": {\"fields\": [ \"firstName\", \"lastName\" ]},\"department\": {\"fields\": [ \"id\", \"name\", \"title\" ]},\"legalEmployer\": {\"fields\": [ \"id\", \"name\" ]},\"workRelationship\": {\"fields\": [ \"id\" ]}}}"
            },
            "jobRetryNumber": 0,
            "timeoutThreshold": 14400
        },
        "jobStatus": "RUNNING",
        "jobProgress": {
            "jobRequestId": 42075,
            "status": "RUNNING",
            "message": "Publishing BOSS job progress: JobProgress(jobRequestId=42075, resourcePath=oraHcmHrCoreEmployment/v1/workers, dataDocName=null, deploymentId=null, jobStatus=RUNNING, startTime=2025-05-25T13:40:18Z, endTime=2025-05-25T13:40:38Z, completedPercentage=30, completed=false, error=null)",
            "startTime": "2025-05-25T13:40:40Z",
            "endTime": "2025-05-25T13:40:40Z",
            "completedPercentage": "30",
            "completed": false
        }
    },
    "$context": {
        "links": {
            "$self": {
                "href": "https://example.com/api/saas-batch/jobscheduler/v1/jobRequests/42075"
            }
        }
    }
}
Operação Concluída com Sucesso
200 OK
 
{
    "jobDetails": {
        "jobRequestId": 42075,
        "jobRequest": {
            "jobDefinitionName": "AsyncDataExtraction",
            "serviceName": "boss",
            "systemDerivedVersion": "90",
            "jobSubmitter": "TM-MFITZIMMONS",
            "requestParameters": {
                "boss.module": "oraHcmHrCoreEmployment",
                "boss.resource.name": "workerAssignmentExtracts",
                "boss.resource.version": "v1",
                "boss.outputFormat": "json",
                "boss.advancedQuery": "{\"collection\": {\"filter\": \"primaryFlag = true and timeUpdated > '2025-05-01T00:00:00Z' and assignmentType = 'E' and !(legalEmployer.id in (10001, 10002))\"},\"fields\": [ \"id\", \"assignmentType\", \"assignmentStatusType\", \"effectiveStartDate\", \"effectiveEndDate\", \"businessTitle\", \"workAtHomeFlag\", \"assignmentNumber\", \"timeUpdated\" ],\"accessors\": {\"personDetail\": {\"fields\": [ \"personNumber\" ]},\"globalName\": {\"fields\": [ \"firstName\", \"lastName\" ]},\"department\": {\"fields\": [ \"id\", \"name\", \"title\" ]},\"legalEmployer\": {\"fields\": [ \"id\", \"name\" ]},\"workRelationship\": {\"fields\": [ \"id\" ]}}}"
            },
            "jobRetryNumber": 0,
            "timeoutThreshold": 14400
        },
        "jobStatus": "SUCCEEDED",
        "jobProgress": {
            "jobRequestId": 42075,
            "status": "SUCCEEDED",
            "message": "Job status is changed to SUCCEEDED",
            "startTime": "2025-05-25T13:39:27Z",
            "endTime": "2025-05-25T13:41:26Z",
            "completedPercentage": "100",
            "completed": true
        }
    },
    "$context": {
        "links": {
            "$self": {
                "href": "https://example.com/api/saas-batch/jobscheduler/v1/jobRequests/42075"
            }
        }
    }
}

Tarefa 5: Extraindo Detalhes da Saída da Extração

Depois que o job for concluído com sucesso, suas informações do arquivo de saída poderão ser extraídas. Envolve o uso da API do Gerenciador de Arquivos de Job para a instância de solicitação de job de extração específica.

A saída é armazenada em partes compactadas.

URL /api/saas-batch/jobfilemanager/v1/jobRequests/{{jobRequestId}}/outputFiles
Método HTTP GET

Tamanho do arquivo:

O tamanho do arquivo é retornado no atributo de resposta items.fileSize e expresso em bytes.

Link do gabinete:

O URL para o conteúdo do arquivo real é retornado no atributo de resposta items.$context.links.enclosure.

Exemplo

Exemplo de Solicitação

GET /api/saas-batch/jobfilemanager/v1/jobRequests/42075/outputFiles

Exemplo de Resposta

No exemplo abaixo, a saída completa é armazenada em dois arquivos compactados.

200 OK
 
{
    "items": [
        {
            "fileName": "result_1_json.zip",
            "fileSize": 9390419,
            "timeCreated": "2025-04-22T22:04:22.667Z",
            "$context": {
                "links": {
                    "enclosure": {
                        "href": "https://example.com/api/saas-batch/jobfilemanager/v1/jobRequests/40071/outputFiles/result_1_json.zip/content"
                    },
                    "$self": {
                        "href": "https://example.com/api/saas-batch/jobfilemanager/v1/jobRequests/40071/outputFiles/result_1_json.zip"
                    }
                }
            }
        },
        {
            "fileName": "result_2_json.zip",
            "fileSize": 4462724,
            "timeCreated": "2025-04-22T22:04:36.565Z",
            "$context": {
                "links": {
                    "enclosure": {
                        "href": "https://example.com/api/saas-batch/jobfilemanager/v1/jobRequests/40071/outputFiles/result_2_json.zip/content"
                    },
                    "$self": {
                        "href": "https://example.com/api/saas-batch/jobfilemanager/v1/jobRequests/40071/outputFiles/result_2_json.zip"
                    }
                }
            }
        }
    ],
    "totalItems": 2,
    "$context": {
        "links": {
            "$self": {
                "href": "https://example.com/api/saas-batch/jobfilemanager/v1/jobRequests/40071/outputFiles"
            }
        }
    }
}

Tarefa 6: Fazendo Download da Saída de Extração

Por fim, é possível fazer download dos arquivos de saída de extração usando a API do Gerenciador de Arquivos de Job para a instância de solicitação de job de extração e o arquivo de saída específicos.

URL /api/saas-batch/jobfilemanager/v1/jobRequests/{{jobRequestId}}/outputFiles/{{fileName}}/content
Método HTTP GET

Atenção:

Você pode baixar até 32 MB em um único pedido. Se o arquivo individual for maior, por padrão você receberá uma parte de 32 MB do arquivo. Para solicitações consecutivas, você deve usar o cabeçalho HTTP Range conforme abaixo. O uso do cabeçalho Range também permite implementar o download multithread para extrair arquivos grandes com mais eficiência, se necessário.

Range: {{startByte}}-{{endByte}}/{{fileSize}}

Dica:

Para evitar o uso completo do cabeçalho Range, envie solicitações de job com o parâmetro adicional boss.export.maxChunkSize com o valor 180. Isso garantirá que cada pedaço compactado seja menor que 32 MB e você poderá baixá-lo em um único pedido.

Exemplo

Exemplo de Solicitação

GET /api/saas-batch/jobfilemanager/v1/jobRequests/42075/outputFiles/result_42075.json/content

Exemplos de Resposta

A resposta real é o conteúdo binário do arquivo compactado. Uma vez descompactado, ele é completo ou parcial (no caso de uso do cabeçalho Range), payload JSON não formatado, com resultados completos ou parciais (no caso de um bloco de arquivos) da consulta de extração.

Exemplo de resultados descompactados completos
{"items": [
    {"id":"300008335145001","assignmentType":"E","assignmentStatusType":"ACTIVE","effectiveStartDate":"2025-05-02","effectiveEndDate":"4712-12-31","businessTitle":"E7356262523","workAtHomeFlag":false,"assignmentNumber":"E7356262523","timeUpdated":"2025-05-01T07:53:15.722Z","$id":"300008335145001","$context":{"etag":"1"},"personDetail":{"personNumber":"7356262523","$id":"300008335144985","$context":{"etag":""}},"globalName":{"firstName":null,"lastName":"oracle","$id":"300008335144986","$context":{"etag":""}},"department":null,"legalEmployer":{"id":"300001939234024","name":"AORT Oracle United States","$id":"300001939234024","$context":{"etag":"6","links":{"$self":{"href":"/ora/hcmHrCore/workStructures/v1/$en-US/legalEmployers/300001939234024?$effectiveDate=2025-05-13"}}}},"workRelationship":{"id":"300008335144995","$id":"300008335144995","$context":{"etag":"1"}}},
    {"id":"300000310085281","assignmentType":"E","assignmentStatusType":"ACTIVE","effectiveStartDate":"2018-03-04","effectiveEndDate":"4712-12-31","businessTitle":"Medical Technologist Corporate Level-35321","workAtHomeFlag":false,"assignmentNumber":"EHDLWorker_190409_467490","timeUpdated":"2025-05-07T15:29:46.59Z","$id":"300000310085281","$context":{"etag":"90"},"personDetail":{"personNumber":"HDLWorker_190409_467490","$id":"100000127293313","$context":{"etag":""}},"globalName":{"firstName":"Martin-David","lastName":"Oestrovsky-Krein","$id":"300000310075057","$context":{"etag":""}},"department":{"id":"300000041568062","name":"GFIN Global Controlling-GROUP/GFINGC74155","title":null,"$id":"300000041568062","$context":{"etag":"13","links":{"$self":{"href":"/ora/hcmHrCore/workStructures/v1/$en-US/departments/300000041568062?$effectiveDate=2025-05-13"}}}},"legalEmployer":{"id":"300000046740247","name":"PSR_US_LE_1","$id":"300000046740247","$context":{"etag":"15","links":{"$self":{"href":"/ora/hcmHrCore/workStructures/v1/$en-US/legalEmployers/300000046740247?$effectiveDate=2025-05-13"}}}},"workRelationship":{"id":"100000127362395","$id":"100000127362395","$context":{"etag":"1"}}}
]}

Mais Recursos de Aprendizagem

Explore outros laboratórios em docs.oracle.com/learn ou acesse mais conteúdo de aprendizado gratuito no canal do Oracle Learning YouTube. Além disso, acesse education.oracle.com/learning-explorer para se tornar um Oracle Learning Explorer.

Para obter a documentação do produto, visite o Oracle Help Center.