SAP ABAP Class CL_CIAP_FACTORY (CIAP - Main control methods)

Hierarchy

☛ SAP_APPL (Software Component) Logistics and Accounting
   ⤷ FI-LOC (Application Component) Localization
     ⤷ INT_TMF_CIAP (Package) TMF Integration Features: CIAP

Properties

Class	CL_CIAP_FACTORY
Short Description	CIAP - Main control methods
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	INT_TMF_CIAP	TMF Integration Features: CIAP
Created	20130913	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_CIAP_DA	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_CIAP_FACTORY has no interface implemented.

Friends

Class CL_CIAP_FACTORY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_CTE_MODEL	Constant	Public	☐	Type reference (TYPE)	J_1BMODEL	57	Model of Nota Fiscal	20131118
2	MC_DIRECT_INCOMING	Constant	Public	☐	Type reference (TYPE)	J_1BDIRECT	1	Direction of the movement	20131118
3	MC_DIRECT_OUTGOING	Constant	Public	☐	Type reference (TYPE)	J_1BDIRECT	2	Direction of the movement	20131118
4	MC_DOCTYPE_NF	Constant	Public	☐	Type reference (TYPE)	J_1BDOCTYP	1	Document type	20131118
5	MC_ITMCAT_ST	Constant	Public	☐	Type reference (TYPE)	PSTYP	7	Item Category in Purchasing Document	20131118
6	MC_TX_DIFAL	Constant	Public	☐	Type reference (TYPE)	J_1BTAXGRP	'ICOP'	Tax group	20131118
7	MC_TX_ICMS	Constant	Public	☐	Type reference (TYPE)	J_1BTAXGRP	'ICMS'	Tax group	20131118
8	MC_TX_SUBTRIB	Constant	Public	☐	Type reference (TYPE)	J_1BTAXGRP	'ICST'	Tax group	20131118

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALCULATE_VALUES_FROM_RECORDS	Instance method	Private	Method	Calculate ICMS values using a table of record id's	20131118
2	CHECK_CFOP_BY_NF_ITEM	Instance method	Private	Method	Check if Nota Fiscal is relevant for CIAP	20131118
3	CHECK_NF_STO	Instance method	Private	Method	Check if Nota Fiscal is relevant for retirement update	20131118
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20131118
5	CREATE_RECORDS_BY_NF_ITEM	Instance method	Private	Method	Call Record class and database controller	20131118
6	GET_ICMS_LINES	Instance method	Private	Method	Check if Nota Fiscal has any relevant tax	20131118
7	PROCESS_CIAP	Instance method	Public	Method	Process CIAP Records	20131118
8	PROCESS_CTE	Instance method	Private	Method	Change the record adding CTe information	20131118
9	PROCESS_FINAL_ASSET	Instance method	Public	Method	Create the Record from the WBS number	20131118
10	PROCESS_NF	Instance method	Private	Method	Create the Record	20131118
11	RETIRE_RECORD	Instance method	Private	Method	Retire a CIAP record.	20131118
12	UPDATE_CIAP	Instance method	Public	Method	Update CIAP Records	20131118

Events

Class CL_CIAP_FACTORY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_CL_CIAP_RECORD	Public	See coding			20131118	tt_cl_ciap_record TYPE TABLE OF ty_cl_ciap_record
2	TT_ID	Public	See coding			20131118	tt_id TYPE TABLE OF guid
3	TT_RECORD_ID	Public	See coding			20131118	tt_record_id TYPE SORTED TABLE OF ty_record_id WITH UNIQUE KEY id
4	TY_CL_CIAP_RECORD	Public	Object reference (TYPE REF TO)	CL_CIAP_RECORD	Class for a CIAP "ficha".	20131118
5	TY_RECORD_ID	Public	See coding			20131118	BEGIN OF ty_record_id, id TYPE guid, END OF ty_record_id

Method Signatures

Method CALCULATE_VALUES_FROM_RECORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_FINAL_ASSET_VALUES	Value transfer	☐	Type reference (TYPE)	CL_CIAP_RECORD=>TY_FINAL_ASSET_VALUES			20131118
2	Exporting	EV_ICMS_TO_CREDIT	Value transfer	☐	Type reference (TYPE)	CIAP_ICMS_TO_CREDIT		CIAP ICMS to credit value	20131118
3	Importing	IT_RECORDS	Call by reference	☐	Type reference (TYPE)	TT_RECORD_ID		table of record id's	20131118

Method CALCULATE_VALUES_FROM_RECORDS on class CL_CIAP_FACTORY has no exception.

Method CHECK_CFOP_BY_NF_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NFHEADER	Call by reference	☐	Type reference (TYPE)	J_1BNFDOC		Nota Fiscal Header	20131118
2	Importing	IS_NFITEM	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN		Table of Nota Fiscal Items (J_1BNFLIN)	20131118
3	Returning	RV_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20131118

Method CHECK_CFOP_BY_NF_ITEM on class CL_CIAP_FACTORY has no exception.

Method CHECK_NF_STO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NFITEM	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN		Nota Fiscal line items	20131118
2	Returning	RV_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20131118

Method CHECK_NF_STO on class CL_CIAP_FACTORY has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_CIAP_FACTORY has no parameter.
Method CONSTRUCTOR on class CL_CIAP_FACTORY has no exception.

Method CREATE_RECORDS_BY_NF_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NFHEADER	Call by reference	☐	Type reference (TYPE)	J_1BNFDOC		Nota Fiscal Header	20131118
2	Importing	IS_NFITEM	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN		Nota Fiscal line items	20131118
3	Importing	IT_NFTAXES	Call by reference	☐	Type reference (TYPE)	J_1BNFSTX_TAB		Nota Fiscal tax per item	20131118

#	Exception	Resumable	Description	Created on
1	CX_CIAP_QUOTA_CUSTOMIZING	☐	Number of quotas exception	20131118

Method GET_ICMS_LINES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_NFTAXES	Call by reference	☐	Type reference (TYPE)	J_1BNFSTX_TAB		Table of Nota Fiscal Tax Lines (J_1BNFSTX)	20131118
2	Importing	IV_ITMNUM	Call by reference	☐	Type reference (TYPE)	J_1BITMNUM		Document Item Number	20131118
3	Returning	RT_TAXES	Value transfer	☐	Type reference (TYPE)	J_1BNFSTX_TAB		Table of Nota Fiscal Tax Lines (J_1BNFSTX)	20131118

Method GET_ICMS_LINES on class CL_CIAP_FACTORY has no exception.

Method PROCESS_CIAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NFHEADER	Call by reference	☐	Type reference (TYPE)	J_1BNFDOC		Nota Fiscal Header	20131118
2	Importing	IT_CTE_DOCREF	Call by reference	☐	Type reference (TYPE)	J_1BCTE_T_DOCREF		Reference to the NF-e being transported	20131118
3	Importing	IT_NFITEMS	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN_TAB		Table of Nota Fiscal Items (J_1BNFLIN)	20131118
4	Importing	IT_NFTAXES	Call by reference	☐	Type reference (TYPE)	J_1BNFSTX_TAB		Table of Nota Fiscal Tax Lines (J_1BNFSTX)	20131118
5	Importing	IV_NFDOCNUM	Call by reference	☐	Type reference (TYPE)	J_1BDOCNUM		Document Number	20131118

Method PROCESS_CIAP on class CL_CIAP_FACTORY has no exception.

Method PROCESS_CTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CTEHEADER	Call by reference	☐	Type reference (TYPE)	J_1BNFDOC		Nota Fiscal Header	20131118
2	Importing	IS_CTEITEM	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN		Nota Fiscal line items	20131118
3	Importing	IT_CTEDOCREF	Call by reference	☐	Type reference (TYPE)	J_1BCTE_T_DOCREF		Reference to the NF-e being transported	20131118
4	Importing	IT_CTETAXES	Call by reference	☐	Type reference (TYPE)	J_1BNFSTX_TAB		Table of Nota Fiscal Tax Lines (J_1BNFSTX)	20131118

#	Exception	Resumable	Description	Created on
1	CX_CIAP_CTE_TOTAL_VALUE	☐	Exception class for invalid CT-e total value.	20131118

Method PROCESS_FINAL_ASSET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RECORDS	Call by reference	☐	Type reference (TYPE)	TT_RECORD_ID		Table of Record IDs	20131118
2	Importing	IV_BUSINESS_PLACE	Call by reference	☐	Type reference (TYPE)	J_1BBRANC_		Business Place	20131118
3	Importing	IV_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Company Code	20131118
4	Importing	IV_ORDER	Call by reference	☑	Type reference (TYPE)	AUFNR		Order Number	20131118
5	Importing	IV_WBS	Call by reference	☑	Type reference (TYPE)	PS_PSP_PNR		Work Breakdown Structure Element (WBS Element)	20131118

#	Exception	Resumable	Description	Created on
1	CX_CIAP_NO_PLANT_FOR_COMP_CODE	☐	No plant found for Company Code	20131118
2	CX_CIAP_NO_REC_FOUND_FOR_WBSIO	☐	No Records found for WBS / IO	20131118
3	CX_CIAP_QUOTA_CUSTOMIZING	☐	Number of quotas exception	20131118
4	CX_CIAP_SETTLEMENT_NOT_FOUND	☐	Asset Settlement Rule not found	20131118
5	CX_CIAP_STATE_NOT_FOUND	☐	State not found.	20131118

Method PROCESS_NF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NFHEADER	Call by reference	☐	Type reference (TYPE)	J_1BNFDOC		Nota Fiscal Header	20131118
2	Importing	IT_NFITEMS	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN_TAB		Nota Fiscal line items	20131118
3	Importing	IT_NFTAXES	Call by reference	☐	Type reference (TYPE)	J_1BNFSTX_TAB		Nota Fiscal tax per item	20131118

#	Exception	Resumable	Description	Created on
1	CX_CIAP_QUOTA_CUSTOMIZING	☐	Number of quotas exception	20131118

Method RETIRE_RECORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NFHEADER	Call by reference	☐	Type reference (TYPE)	J_1BNFDOC		Nota Fiscal Header	20131118
2	Importing	IS_NFITEM	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN		Nota Fiscal line items	20131118

Method RETIRE_RECORD on class CL_CIAP_FACTORY has no exception.

Method UPDATE_CIAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NFHEADER	Call by reference	☐	Type reference (TYPE)	J_1BNFDOC		Nota Fiscal Header	20131118
2	Importing	IT_NEW_NFITEM	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN_TAB		Table of Nota Fiscal Items (J_1BNFLIN)	20131118
3	Importing	IT_NFTAXES	Call by reference	☐	Type reference (TYPE)	J_1BNFSTX_TAB		Table of Nota Fiscal Tax Lines (J_1BNFSTX)	20131118
4	Importing	IT_OLD_NFITEM	Call by reference	☐	Type reference (TYPE)	J_1BNFLIN_TAB		Table of Nota Fiscal Items (J_1BNFLIN)	20131118

Method UPDATE_CIAP on class CL_CIAP_FACTORY has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in