SAP ABAP Class CL_CFDI_UTILITY_MX (CFDI Digital Invoice MX:Main Functions)

Hierarchy

☛ SAP_APPL (Software Component) Logistics and Accounting
   ⤷ FI-LOC (Application Component) Localization
     ⤷ ID-LO-MX (Package) Localization Mexico - CFDI

Properties

Class	CL_CFDI_UTILITY_MX
Short Description	CFDI Digital Invoice MX:Main Functions
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	ID-LO-MX	Localization Mexico - CFDI
Created	20130808	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CFDI_UTILITY_MX has no forward declaration.

Interfaces

Class CL_CFDI_UTILITY_MX has no interface implemented.

Friends

Class CL_CFDI_UTILITY_MX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	LC_SAP_BASIS	Constant	Public	☐	Type reference (TYPE)	DLVUNIT	'SAP_BASIS'	Software Component	20131203
2	LC_SPRAS	Constant	Public	☐	Type reference (TYPE)	SPRAS	'E'	Language Key	20131203
3	LC_SSFBIN_LINE_L	Constant	Public	☐	Type reference (TYPE)	I	255		20131203

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_DIGEST_VALUE	Static method	Public	Method	Build Digest Value	20131203
2	BUILD_FILE_PATH	Static method	Public	Method	Build File Path	20131203
3	BUILD_SERIALNR_STRING	Static method	Public	Method	Build the serail number string	20131203
4	BUILD_SIGNED_INFO_STRING	Static method	Public	Method	Build the signed infor string	20131203
5	CREATE_BLOCKS	Static method	Public	Method	Create blocks for structures in Original input message	20131203
6	CREATE_NESTED_TABLE	Static method	Public	Method	Create blocks for table types in Original input message	20131203
7	ENCODE_BASE64	Static method	Public	Method	Convert to base 64 format	20131203
8	FINAL_CANC_CHAIN_GEN	Static method	Public	Method	Final Cancel Chain Generation	20131203
9	GET_CERTIFICATE	Static method	Public	Method	Get Certificate Information	20131203
10	GET_ISO_8601_TIMESTAMP	Static method	Public	Method	Get Timestamp in ISO 8601 format	20131203
11	GET_LOCAL_TIME	Static method	Public	Method	Convert date and time to local time (Mexico)	20131203
12	GET_ORI_INPUT_MSG	Static method	Public	Method	Create the Original Input Message for CFDI 3.2 XML Version	20131203
13	GET_PROFILE_SYSPARAM	Static method	Public	Method	Get Profile Parameters of Application Server	20131203
14	GET_PSE_LOCAL_PATH	Static method	Public	Method	Get PSE Local Path	20131203
15	GET_XSTRING_FROM_RAW_TABLE	Static method	Public	Method	Create xtsring from raw table	20131203
16	PREPARE_CANC_REQ_DATA	Static method	Public	Method	Prepare Cancellation Request Data (CFDI)	20131203
17	PREPARE_CHAR_CHAIN_DATA	Static method	Public	Method	Prepare Character Chain data	20131203
18	REQ_IDOC_UPDATE_STATUS	Static method	Public	Method	Update the request and response table once IDOC triggered	20131203
19	SAVE_HEADER_TEXT_SD	Static method	Public	Method	Save Header Texts for Billing Documents	20131203
20	SIGN_SIGNED_INFO_STRING	Static method	Public	Method	Sign the Signed info string	20131203

Events

Class CL_CFDI_UTILITY_MX has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_IN_DATA_TABLE	Public	See coding			20131203	tt_in_data_table TYPE TABLE OF ssfbin
2	TT_SSFINFO	Public	See coding			20131203	tt_ssfinfo TYPE TABLE OF ssfinfo

Method Signatures

Method BUILD_DIGEST_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DIGEST_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20131203
2	Importing	IV_CODEPAGE	Call by reference	☐	Type reference (TYPE)	CPCODEPAGE		SAP Character Set ID	20131203
3	Importing	IV_INV_DATE	Call by reference	☐	Type reference (TYPE)	CFDI_DOC_DATE		(1.b) Time Stamp for Moment of Billing (ISO 8601)	20131203
4	Importing	IV_RFC	Call by reference	☐	Type reference (TYPE)	CFDI_CMPNY_TAX_N		(2.a) Tax Number of Company Code	20131203
5	Importing	IV_UUID	Call by reference	☐	Type reference (TYPE)	CFDI_UUID		UUID: Unique Identifier	20131203

#	Exception	Resumable	Description	Created on
1	CONV_ERROR	☐	Conversion Error	20131203
2	ERROR	☐	Error	20131203
3	NO_OPERATION	☐	No Operation	20131203

Method BUILD_FILE_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_VALUE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20131203
2	Importing	IV_FILENAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20131203
3	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20131203

Method BUILD_FILE_PATH on class CL_CFDI_UTILITY_MX has no exception.

Method BUILD_SERIALNR_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ISSUER_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20131203
2	Exporting	EV_SERIAL_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20131203
3	Importing	IV_CERTIFICATE	Call by reference	☐	Type reference (TYPE)	STRING			20131203
4	Importing	IV_SERIAL_NO	Call by reference	☐	Type reference (TYPE)	STRING			20131203

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error	20131203

Method BUILD_SIGNED_INFO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_ORI_SIGNED_INFO_STR	Call by reference	☐	Type reference (TYPE)	STRING			20131203
2	Importing	IV_ENCODE_DIGEST_STR	Call by reference	☐	Type reference (TYPE)	STRING			20131203

Method BUILD_SIGNED_INFO_STRING on class CL_CFDI_UTILITY_MX has no exception.

Method CREATE_BLOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_DATA_POS_CHAIN	Call by reference	☐	Type reference (TYPE)	ANY			20131203
2	Importing	IS_BLOCK_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20131203
3	Importing	IV_BLOCK_INDEX	Call by reference	☐	Type reference (TYPE)	I			20131203
4	Importing	IV_SEPARATOR	Call by reference	☐	Type reference (TYPE)	ANY			20131203

#	Exception	Resumable	Description	Created on
1	CUSTOM_ERROR	☐	invalid maintenance of SSF-profile or SSF-parameters	20131203
2	DATA_BLOCK_ERROR	☐	data error within a data block	20131203

Method CREATE_NESTED_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_DATA_POS_CHAIN	Call by reference	☐	Type reference (TYPE)	ANY			20131203
2	Importing	IS_BLOCK_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20131203
3	Importing	IV_SEPARATOR	Call by reference	☐	Type reference (TYPE)	ANY			20131203

Method CREATE_NESTED_TABLE on class CL_CFDI_UTILITY_MX has no exception.

Method ENCODE_BASE64 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FINAL_CHAIN	Call by reference	☐	Type reference (TYPE)	STRING			20131203
2	Importing	IV_FINAL_CHAIN	Call by reference	☐	Type reference (TYPE)	STRING			20131203

Method ENCODE_BASE64 on class CL_CFDI_UTILITY_MX has no exception.

Method FINAL_CANC_CHAIN_GEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FINAL_CHAIN	Call by reference	☐	Type reference (TYPE)	STRING			20131203
2	Importing	IV_CERTIFICATE	Call by reference	☐	Type reference (TYPE)	STRING			20131203
3	Importing	IV_CMPNY_TAX_NUM	Call by reference	☐	Type reference (TYPE)	CFDI_CMPNY_TAX_N		(2.a) Tax Number of Company Code	20131203
4	Importing	IV_ENCODE_DIGEST_STR	Call by reference	☐	Type reference (TYPE)	STRING			20131203
5	Importing	IV_FECHA	Call by reference	☐	Type reference (TYPE)	CFDI_DOC_DATE		(1.b) Time Stamp for Moment of Billing (ISO 8601)	20131203
6	Importing	IV_SERIAL_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20131203
7	Importing	IV_SIGNEDINFO_STR	Call by reference	☐	Type reference (TYPE)	STRING			20131203
8	Importing	IV_UUID	Call by reference	☐	Type reference (TYPE)	CFDI_UUID		UUID: Unique Identifier	20131203

Method FINAL_CANC_CHAIN_GEN on class CL_CFDI_UTILITY_MX has no exception.

Method GET_CERTIFICATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SIGNER	Call by reference	☐	Type reference (TYPE)	TT_SSFINFO			20131203
2	Exporting	EV_CERTIFICATE	Call by reference	☐	Type reference (TYPE)	STRING			20131203
3	Exporting	EV_SERIAL_NO	Call by reference	☐	Type reference (TYPE)	STRING			20131203
4	Exporting	EV_VALIDITY_FLAG	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20131203
5	Importing	IS_PSEPROF	Call by reference	☐	Type reference (TYPE)	IDMX_DI_PSEPROF		pse-file and parameter (entities)	20131203

#	Exception	Resumable	Description	Created on
1	CONV_ERROR	☐		20131203
2	NO_OPERATION	☐		20131203
3	PSEFILE_ACCESS_DENIED	☐		20131203
4	PSEFILE_INVALID	☐		20131203
5	PSEFILE_NOT_EXIST	☐		20131203
6	SAPCRYPTOLIB_NOT_INSTALLED	☐		20131203
7	SSF_PARAMETER_NOT_FOUND	☐		20131203
8	SSF_PARAMETER_WRONG	☐		20131203
9	UNKNOWN_ERROR	☐		20131203

Method GET_ISO_8601_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	CHAR19		19 Characters	20131203
2	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	DATUM		Date	20131203
3	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	TIMS		Time	20131203
4	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	TTZZ-TZONE		Time Zone	20131203

Method GET_ISO_8601_TIMESTAMP on class CL_CFDI_UTILITY_MX has no exception.

Method GET_LOCAL_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ERDAT	Call by reference	☐	Type reference (TYPE)	ERDAT		Date on Which Record Was Created	20131203
2	Exporting	EV_ERZET	Call by reference	☐	Type reference (TYPE)	ERZET		Entry time	20131203
3	Importing	IV_ERDAT	Call by reference	☐	Type reference (TYPE)	ERDAT		Date on Which Record Was Created	20131203
4	Importing	IV_ERZET	Call by reference	☐	Type reference (TYPE)	ERZET		Entry time	20131203
5	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	TTZZ-TZONE		Time Zone	20131203

Method GET_LOCAL_TIME on class CL_CFDI_UTILITY_MX has no exception.

Method GET_ORI_INPUT_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ORI_INPUT_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20131203
2	Importing	IS_DATA_EXTRACT_ORI_IN_MSG	Call by reference	☐	Type reference (TYPE)	CFDI_ORI_IN_MSG_TYPE_MX		CFDI Digital Invoice Mexico:data for Original input message	20131203

#	Exception	Resumable	Description	Created on
1	BLOCK_CREATION_ERROR	☐	error while creating a data block	20131203
2	CUSTOM_ERROR	☐	invalid maintenance of SSF-profile or SSF-parameters	20131203
3	DATA_BLOCK_ERROR	☐	data error within a data block	20131203
4	OIM_BLOCK_ERROR	☐	error in original input message ( number of blocks )	20131203

Method GET_PROFILE_SYSPARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_VALUE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20131203
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20131203

#	Exception	Resumable	Description	Created on
1	SSF_PARAMETER_NOT_FOUND	☐	SSF Parameter not found	20131203

Method GET_PSE_LOCAL_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PROFILE	Call by reference	☐	Type reference (TYPE)	SSFPARMS-PAB		Private Address Book for SSF	20131203
2	Importing	IS_PSEPROF	Call by reference	☐	Type reference (TYPE)	IDMX_DI_PSEPROF		pse-file and parameter (entities)	20131203

#	Exception	Resumable	Description	Created on
1	SSF_PARAMETER_NOT_FOUND	☐	SSF Parameter not found	20131203

Method GET_XSTRING_FROM_RAW_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_OUT_STRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20131203
2	Changing	CV_OUT_STRING_L	Call by reference	☐	Type reference (TYPE)	I			20131203
3	Importing	IT_IN_DATA_TABLE	Call by reference	☐	Type reference (TYPE)	TT_IN_DATA_TABLE			20131203

#	Exception	Resumable	Description	Created on
1	CONV_ERROR	☐	Conversion Error	20131203

Method PREPARE_CANC_REQ_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HEAD_XVBRK	Call by reference	☐	Type reference (TYPE)	VBRKVB		Reference Structure for XVBRK/YVBRP	20131203
2	Importing	IT_XKOMV	Call by reference	☐	Type reference (TYPE)	VA_KOMV_T		Table for structure KOMV	20131203
3	Importing	IT_XVBPA	Call by reference	☐	Type reference (TYPE)	VA_VBPAVB_T		Table for structure VBPAVB	20131203
4	Importing	IT_XVBRK	Call by reference	☐	Type reference (TYPE)	VBRKVB_T		Reference Structure for XVBRK/YVBRP	20131203
5	Importing	IT_XVBRP	Call by reference	☐	Type reference (TYPE)	VBRPVB_T		Billing Item Data	20131203
6	Importing	IV_XVBRK_TABIX	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index of Internal Tables	20131203

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error Occured	20131203

Method PREPARE_CHAR_CHAIN_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CFDI_CHAIN_DATA	Call by reference	☐	Type reference (TYPE)	CFDI_CHAIN_TT_MX		Table type for CFDI_CHAIN_MX	20131203
2	Exporting	EV_LEN	Call by reference	☐	Type reference (TYPE)	I			20131203
3	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	CFDI_GUID		GUID for Character Chain	20131203
4	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20131203

Method PREPARE_CHAR_CHAIN_DATA on class CL_CFDI_UTILITY_MX has no exception.

Method REQ_IDOC_UPDATE_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	VBDKR	Call by reference	☐	Type reference (TYPE)	VBDKR		Document Header View for Billing	20131203

Method REQ_IDOC_UPDATE_STATUS on class CL_CFDI_UTILITY_MX has no exception.

Method SAVE_HEADER_TEXT_SD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUKRS	Call by reference	☐	Type reference (TYPE)	BUKRS		Company Code	20131203
2	Importing	IV_CHAIN_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20131203
3	Importing	IV_DATAID	Call by reference	☐	Type reference (TYPE)	IDMX_DI_DATAID		Data ID	20131203
4	Importing	IV_VBELN	Call by reference	☐	Type reference (TYPE)	VBELN		Sales and Distribution Document Number	20131203

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error	20131203

Method SIGN_SIGNED_INFO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SIGNEDINFO_STR	Call by reference	☐	Type reference (TYPE)	STRING			20131203
2	Importing	IT_SIGNER	Call by reference	☐	Type reference (TYPE)	TT_SSFINFO			20131203
3	Importing	IV_CODEPAGE	Call by reference	☐	Type reference (TYPE)	CPCODEPAGE		SAP Character Set ID	20131203
4	Importing	IV_HASHALG	Call by reference	☐	Type reference (TYPE)	SSFHASH			20131203
5	Importing	IV_ORI_SIGNED_INFO_STR	Call by reference	☐	Type reference (TYPE)	STRING			20131203
6	Importing	IV_SSFFORMAT	Call by reference	☐	Type reference (TYPE)	IDMX_DI_FORMAT		Format of Digital Signature	20131203

#	Exception	Resumable	Description	Created on
1	CONV_ERROR	☐		20131203
2	NO_OPERATION	☐		20131203
3	SSF_CUSTOM_ERROR	☐		20131203

History

Last changed by/on	SAP	20140121
SAP Release Created in