Sei sulla pagina 1di 19

LAD Consulting Localizations

F031 Brazilian Electronic Billing


Integration
Technical Reference Manual
VERSION 2
RELEASE 12

DISCLAIMER:
CURRENTLY, ORACLE OFFERS CERTAIN RESALABLE ASSETS OR OTHER DEFINED SERVICE
DELIVERABLES (COLLECTIVELY REFERRED TO AS "SERVICE DELIVERABLES") UNDER A
LIMITED USE LICENSE. THE SERVICE DELIVERABLES CURRENTLY INCLUDE, BUT ARE NOT
LIMITED TO, ORACLE INTEGRATION HUB. YOU AGREE THAT :
(i) SERVICE DELIVERABLES ARE NOT ORACLE STANDARD SOFTWARE PROGRAMS,
(ii) TECHNICAL SUPPORT FOR SERVICE DELIVERABLES IS NOT AVAILABLE FROM OR
UNDER, OR PROVIDED BY OR THROUGH, ORACLE'S SUPPORT SERVICES ORGANIZATION OR
YOUR ORACLE PROGRAM LICENSE AGREEMENT,
(iii) YOUR RIGHT TO USE AND RECEIVE SUPPORT SERVICES FOR SERVICE DELIVERABLES IS
SOLELY AS DESCRIBED IN YOUR CONTRACT FOR SUCH SERVICE DELIVERABLES, AND
(iv) A SERVICE REQUEST REGARDING SERVICE DELIVERABLES, REGARDLESS OF HOW
INITIATED OR LOGGED, WILL BE ADDRESSED IN ACCORDANCE WITH THE TERMS OF YOUR
CONTRACT FOR SUCH SERVICE DELIVERABLES.

Document Control
Change Record
Date
06-DEC-07
09-MAY-12

Author
Odirley Davson Bolzam
Ricardo A Antonio

Version
1
2

Change Reference
Initial creation
Reference to new tecnology of Electronic Invoices screen, now
based on Framework

Reviewers
Name

Function

Distribution
Copy No.

Name

Local

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

Document Control

ii

Content

Document Control...................................................................................................................... ii
Change Record ................................................................................................................... ii
Reviewers ........................................................................................................................... ii
Distribution ......................................................................................................................... ii
CHAPTER 1

High Level Design .................................................................................................................... 1


General View of the High Level Design .................................................................................... 2
Summarized View of the EBI ............................................................................................. 2
Table Diagram .................................................................................................................... 2
List of Tables ...................................................................................................................... 2
List of Views....................................................................................................................... 2
Summarized View of the Brazilian Electronic Billing Integration............................................. 3
Rules Used in the Entity Relationship Diagram .................................................................. 3
Table Diagrams .......................................................................................................................... 4
Convention Used in the Table Diagram .............................................................................. 4
Diagram 1: Electronic Invoices tables relationships ........................................................... 5
List of Views .............................................................................................................................. 6
New Views.......................................................................................................................... 6
List of Tables ............................................................................................................................. 7
New Tables ......................................................................................................................... 7
List of Modules .......................................................................................................................... 8
Framework .......................................................................................................................... 8
Reports................................................................................................................................ 8
Concurrent Programs .......................................................................................................... 8
Packages ............................................................................................................................. 8

CHAPTER 2

Detailed Design......................................................................................................................... 9
General View of the Detailed Design ...................................................................................... 10
View and Table Definition ............................................................................................... 10
Table Definition ....................................................................................................................... 11
Objective........................................................................................................................... 11
Column Description .......................................................................................................... 11
Table Definition ....................................................................................................................... 12
CLL_F031_ELECTRONIC_TRX_ALL .......................................................................... 12
CLL_F031_ELECTRONIC_RET_ALL........................................................................... 13

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

Document Control

iii

Module Definition.................................................................................................................... 14
General View of the Module............................................................................................. 14
NFESEARCH ................................................................................................................... 14
CLL_F031_RNFE ............................................................................................................ 14
Quick Codes............................................................................................................................. 15
CLL_F031_ELECT_TRX_STATUS ............................................................................... 15
CLL_F031_ACTIONS ..................................................................................................... 15

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

Document Control

iv

CHAPTER

High Level Design


T

his chapter will show the High Level Design of the F031 Brazilian Electronic Billing

Integration, that satisfies the necessities of the the Strategy and Analysis development phase. A
general view of the application and diagrams of the tables and the main functions of the F031
Brazilian Electronic Billing Integration, list of tables, views and modules will be shown.
Note that this manual should be analyses together with the Oracle Receivables Technical
Reference Manual - Release 12.

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

General View of the High Level Design


The components of the application (tables, views and modules) are defined during the High Level
Design, these created to satisfy the necessaries functionalities for Brazil.
This chapter can be used to rapidly learn tables, views and modules which form part of the F031
Brazilian Electronic Billing Integration.

Summarized View of the EBI


Through the Entity Relationship Diagram it is possible to have a graphical view of the entities that
compose the application and its relationships.

Table Diagram
Graphically represents all the tables and foreign keys (relationship), grouped with EBIs primary
business functions. Examine the Table Definition section for more information.

List of Tables
List of Tables briefly describes each table contained in the EBI.

List of Views
List of Views briefly describes each view in EBI. Examine the View Definition of the Detailed
Design section in chapter 2 for more information.

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

Summarized View of the Brazilian Electronic Billing Integration


Through the Entity Relationship Diagram it is possible to have a graphical view of the entities that
are part of the application and the relationship between them. This diagram was prepared to
describe, at a conceptual level, the key informations that the F031 Brazilian Electronic Billing
Integration depend on.
See below the a Diagram with a Summarized View of the EBI

Rules Used in the Entity Relationship Diagram


To better understand the diagram, some rules where standardized for the better understanding of
the design:
Figure 1-1

Options
_______

-------

Obligatory Relationship
Opcional Relationship

Type of Relationship
A

# Each line of the A entity is obliged to have a relationship with


only one line of the B entity
# Each line of the B entity is obliged to have a relationship with
only one line of theA entity
A

# Each line of the A entity is obliged to have a relationship with


only one line of the B entity
# Each line of the B entity is obliged to have a relationship with
only one line of theA entity

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

Table Diagrams
This section graphically represents all the tables and the foreign keys (relationship at a conceptual
level) grouped by the main business functionalities in EBI. This section should be used to rapidly
learn what tables are part of the main business functions in do EBI e how they communicate. Read
the Definitions of Views and Definition of Tables sections in chapter 2 for further information of
each of these tables.
This section contains the following table diagrams:
Diagram 1: Electronic Invoices tables relationships.

Convention Used in the Table Diagram


To better understand the diagram, some rules where standardized for the better understanding of
the design:
Figure 1-2:
Options
_______

-------

Obligatory Relationship
Opcional Relationship

Type of Relationship
A

# Each line of the A entity is obliged to have a relationship with


only one line of the B entity
# Each line of the B entity is obliged to have a relationship with
only one line of theA entity
A

# Each line of the A entity is obliged to have a relationship with


only one line of the B entity
# Each line of the B entity is obliged to have a relationship with
only one line of theA entity

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

Diagram 1: Electronic Invoices tables relationships

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

List of Views
New Views
View Names

Description

CLL_F031_ELECT_TRX_ADD_INFO_V
CLL_F031_CUSTOMERS_V
CLL_F031_RET_INFO_UI_V
CLL_F031_TRX_INFO_UI_V
CLL_F031_TRX_INFO_V

Collection data out of the EBI tables


Customers available on F031 transactions
Return information used on screen
Transaction information used on screen
All information of Transactions on F031

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

List of Tables
This section list each of the tables in F031 Brazilian Electronic Billing Integration with a brief
description of each one of them.

New Tables
Table Name

Description

CLL_F031_ELECTRONIC_TRX_ALL
CLL_F031_ELECTRONIC_RET_ALL

Stores the information of the Electronic Invoice return headers


Stores the information of the Electronic Invoice return lines

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

List of Modules
This section lists each form, report, concurrent program, and stored procedure used in F031
Brazilian Electronic Billing Integration.

Framework
Name

Description

Field Name

nfesearch

Screen used to Analyze Electronic Invoice Returns

EBI Transactions Control

Report

Description

Field Name

CLL_F031_RNFE

Electronic Invoices Report

Electronic Invoices Report

Concurrent Programs

Descriptions

Title

CLL_F031_RNFE

Report used to Analyze Electronic Invoice Returns

Electronic Invoices Report

Reports

Concurrent Programs

Packages
Packages

Description

Name

CLL_F031_ELECTRONIC_API
CLL_F031_EBI_UTIL

All interface functions for partners


Utilities for F031 Brazilian
Electronic Billing Integration

CLL_F031_ELECTRONIC_API
CLL_F031_EBI_UTIL

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

CHAPTER

Detailed Design
T

his chapter presents a detailed design used during the F031 Brazilian Electronic Billing

Integration implementation. Here you will find detailed table definitions, modules and descriptive
flexfields.

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

General View of the Detailed Design


During the Detailed Design phase, each of the applications component has its functionality
detailed.
This chapter permits the understanding of the detailed structure and information flow of EBI.

View and Table Definition


The section View and Table Definition contains the detailed definition EBI tables and views. The
following information is available for each table: objective, column description, primary key,
unique key, check constraints, foreign key, quick codes, sequences, module access and database
triggers.

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

10

Table Definition
The Table Definition section contains a detailed definition of each table in EBI. For each table,
the following information are available: objective, column description, primary key, unique key,
check constraints, foreign key, indexes, quick codes, sequences
This section only documents the tables created for the EBI. To obtain further information about
the details of the tables and external views used, see the application manual to which it is
component of.

Objective
In this topic we will describe why this table will be used.

Column Description
This topic states the primary characteristic of the column or view. These characteristics include if
the F031 Brazilian Electronic Billing Integration needs a value for this column and what type of
data this is, together with a brief description on EBI uses this column .
Standard Who Column
Lots of tables in the F031 Brazilian Electronic Billing Integration application contain standard
columns to support Who rows. When a program or a SQL command selects lines in a table, these
columns are used to determine who did the last update in this line. If your program or your SQL
command inserts or updates a line in an interface table, you should update the 5 Standard Who
Columns:
LAST_UPDATE_DATE
LAST_UPDATED_BY
CREATION_DATE
CREATED_BY
LAST_UPDATE_LOGIN

Date in which the last user performed the last update in this
line
User that did the last update in this line ( Foreign Key
relative to FND_USER.USER_ID )
Creation date of this line
User that created this line
Operating System Login of the user that last updated this line
(Foreign Key relative to a FND_LOGINS.LOGIN_ID). You
should assign NULL or 0 if NULL isnt permitted

Once every line in this table contains the additional Standard Who Columns with various Foreign
Keys corresponding to the FND_USERS e FND_LOGINS tables, you then should not include
LAST_UPDATED_BY, CREATED_BY, or LAST_UPDATE_LOGIN columns in the Foreign
Keys list of the table.

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

11

Table Definition
The Table Definition section contains a detailed definition of each table in F031 Brazilian
Electronic Billing Integration. For each table, the following information are available: objective,
column description, primary key, unique key, check constraints, foreign key, indexes, quick codes,
sequences and database triggers.

CLL_F031_ELECTRONIC_TRX_ALL
Extension of the CLL_F031_ELECTRONIC_TRX_ALL table that Stores the information of the
Electronic Invoice return headers Columns Description.

Column
CUSTOMER_TRX_ID
STATUS
LAST_GENERATE_DATE
CM_CUSTOMER_TRX_ID
LAST_ELECTRONIC_RET_ID
ORG_ID
URL
ATTRIBUTE1
ATTRIBUTE2
ATTRIBUTE3
ATTRIBUTE4
ATTRIBUTE5
ATTRIBUTE6
ATTRIBUTE7
ATTRIBUTE8
ATTRIBUTE9
ATTRIBUTE10
ATTRIBUTE11
ATTRIBUTE12
ATTRIBUTE13
ATTRIBUTE14
ATTRIBUTE15
ATTRIBUTE16
ATTRIBUTE17
ATTRIBUTE18
ATTRIBUTE19
ATTRIBUTE20
ATTRIBUTE_CATEGORY
LAST_UPDATE_DATE
LAST_UPDATED_BY
CREATION_DATE
CREATED_BY
ELECTRONIC_TRX_ID

Option
NOT NULL
NOT NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NOT NULL
NOT NULL
NOT NULL
NOT NULL
NOT NULL

Data Type
NUMBER
VARCHAR2(20)
DATE
NUMBER
NUMBER
NUMBER
VARCHAR2(1000)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
DATE
NUMBER
DATE
NUMBER
NUMBER

Description
Transaction Header Identifier
Status of the transaction
Last Generate date in the flat file
Credit Memo reference
Last Return Created
Organization of the Invoice
URL reference to official site
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield Category
Who column
Who column
Who column
Who column

Indexes
Name
CLL_F031_ELECTRONIC_TRX_ALL_U1

Column
CUSTOMER_TRX_ID

Quick Codes
Column

Quick Code Type

Quick Code Table

STATUS

CLL_F031_ELECT_TRX_STATUS

FND_LOOKUPS

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

12

CLL_F031_ELECTRONIC_RET_ALL
Extension of the CLL_F031_ELECTRONIC_RET_ALL table that Stores the information of the
Electronic Invoice return lines.

Column
ELECTRONIC_RET_ID
CUSTOMER_TRX_ID
OCCURRENCE_DATE
ORG_ID
OWNER
ACTION
ATTRIBUTE1
ATTRIBUTE2
ATTRIBUTE3
ATTRIBUTE4
ATTRIBUTE5
ATTRIBUTE6
ATTRIBUTE7
ATTRIBUTE8
ATTRIBUTE9
ATTRIBUTE10
ATTRIBUTE11
ATTRIBUTE12
ATTRIBUTE13
ATTRIBUTE14
ATTRIBUTE15
ATTRIBUTE16
ATTRIBUTE17
ATTRIBUTE18
ATTRIBUTE19
ATTRIBUTE20
ATTRIBUTE_CATEGORY
LAST_UPDATE_DATE
LAST_UPDATED_BY
CREATION_DATE
CREATED_BY
ELECTORNIC_TRX_ID
MESSAGE

Option
NOT NULL
NOT NULL
NOT NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NOT NULL
NOT NULL
NOT NULL
NOT NULL
NOT NULL
NULL

Data Type
NUMBER
NUMBER
DATE
NUMBER
VARCHAR2(20)
VARCHAR2(20)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
VARCHAR2 (150)
DATE
NUMBER
DATE
NUMBER
NUMBER
CLOB

Description
Transaction Line Identifier
Transaction Header Identifier
Date of the return occurrence
Organization of the Invoice
Owner of the Action
Type of the Action
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield segment
Descriptive flexfield Category
Who column
Who column
Who column
Who column

Indexes
Name
CLL_F031_ELECTRONIC_RET_ALL_U1
CLL_F031_ELECTORNIC_RET_ALLN1

Column
ELECTRONIC_RET_ID
CUSTOMER_TRX_ID
ORG_ID

Quick Codes
Column
ACTION

Quick Code Type


CLL_F031_ACTIONS

Quick Code Table


FND_LOOKUPS

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

13

Module Definition
This section describes each form, report, concurrent program and stored procedure in the
F031 Brazilian Electronic Billing Integration. Read this section to learn what each module does
and when
Electronic Billing Integration uses them with each corresponding table.

General View of the Module


We will present a brief description of each module, pointing out its functionality and showing what
category it falls into, what language is used and what title is related to corresponding program
You will then see a summary of modules main functions and learn the role of specific business
activity that each module is part of.
Note that we list the modules in alphabetical order based on the there internal names, that
correspond to the form names, reports and concurrent programs registered in the Oracle
Application Object Library (AOL).

NFESEARCH
Description:
Type:
Language:
Title:

EBI Transaction Control


Framework
Java OAF
EBI Transaction Control

Description:
Type:
Language:
Name:

Report used to Analyze Electronic Invoice Returns


Reports
Reports v3.0
Electronic Invoices Report

CLL_F031_RNFE

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

14

Quick Codes
This section shows detail information for QuickCode in EBI, your Cod and meaning. This is
defined on FND_LOOKUPS table.

CLL_F031_ELECT_TRX_STATUS
Code
1
2
3
4

Meaning
Send
Finished
Error
Canceled

Code
100
200

Meaning
Sent
Print

CLL_F031_ACTIONS

TAG*
3
1234

The
TAG
field
was
used
to
indicate
(CLL_F031_ELECT_TRX_STATUS) valid to the Action.

the

Status

Ex: The Action Code 100 will be available for Transactions with Status like 3.

LAD Consulting Localizations


Technical Reference Manual
F031 Brazilian Electronic Billing Integration
Oracle Proprietary, Confidential Information - Use Restricted by Contract

15

Potrebbero piacerti anche