Professional Documents
Culture Documents
Version 5
06 Jul 2021
DISCLAIMER:
This guide may contain screen shots and output reports to facilitate the user comprehension about the topic. The content
represents a fictitious sample. Any similarity to actual persons, living or dead, or company names, active or inactive, is
purely coincidental and not intended in any manner.
TABLE OF CONTENTS
TABLE OF CONTENTS ..............................................................................................................................................2
INTENDED AUDIENCE...................................................................................................................................................... 4
2
REVISION HISTORY
This document will continue to evolve as existing sections change and new information is added. All
updates are logged below:
3
LATIN AMERICA CLOUD LOCAL SOLUTION FOR MEXICO
This document intends to guide the Implementers to setup the Oracle Integration Cloud - OIC and Oracle
Fusion Cloud in order to provide the Integration between the ERP Fusion Cloud and LACLS for Mexico
Additional Withholding Information.
INTENDED AUDIENCE
Welcome to Oracle Integration Cloud - OIC of the Latin America Cloud Local Solution for Mexico.
BIP architecture
If you have never used Oracle Integration Cloud - OIC, we suggest you attend one or more of the Oracle
Fusion training classes available through Oracle University.
PREPARING TO INSTALL/UPDATE
This chapter provides instructions for obtaining the latest version of Mexico solution and assists in
creating a stage area for installation.
To download the latest Mexico Update Pack available, please refer to the Note Latin America Cloud Local
Solutions (LACLS) - How to get the latest Pack (Doc ID 2588752.1) and search for Mexico component in
Table 3.1.1. "Latest quarterly cumulative pack" column contains the link to download the latest Pack
released. Example:
5
6
INSTALLATION/UPDATE TASKS
This chapter provides a guide for Installing/Updating Mexico Additional Withholding Information
Solutions artifacts. Mandatory for all customers who are installing/upgrading Mexico Additional
Withholding Information solution.
For customers using Maintenance Assistant (MNT), please skip this chapter since all manual procedures
will be replaced by MNT processing.
After apply the Pack manually or using MNT please follow to "CONFIGURATION TASKS – INSTALL AND
UPDATE STEPS" chapter.
Important:
It is mandatory do not create or update any report or folder below the Shared Folders Custom
Local Solution MX since updates from Latin America Cloud Local Solution for Mexico will overwrite
the files in this folder, every time the upload process be executed.
Verify if BI folders structure required for Mexico Additional Withholding Information is already available.
In this case, the steps describe in this section can be skipped and you can follow to the “BI FILES
UPLOAD TO CLOUD” steps.
1. Access BI Publisher Enterprise Tool (including /xmlpserver after URL used to access the Cloud
environment). Example: https://XXXX.XX.XXX>.oraclecloud.com/xmlpserver
1. Click on Catalog option
2. Click on Expand Shared Folders option
3. Click on Expand Custom option
4. Under the Custom folder, verify if there is a folder called Local Solution
5. Under the Local Solution folder, verify if there is a folder called MX
/Custom/Local Solution/MX/E-INVOICE
/Custom/Local Solution/MX/E-INVOICE/Process
7
CREATE BI FOLDERS STRUCTURE
If the structure required for Mexico Additional Withholding Information is not available, create it. The
steps below assumes the Local Solution folder is not available but you must follow the steps according
the structure available in your environment.
1. Under the folder Custom, create a new folder called Local Solution. To do that, click on Create
icon.
2. Choose the Folder option
Enter the name exactly as bellow and press Create button.
Create Local Folder Solution
*Folder Name Local Solution
8
BI PUBLISHER FILES
This step requires you have downloaded the pack, has created the Pack stage area and had the BI Folders
Structure created.
Who are installing or updating Additional Withholding Information LACLS for Mexico must upload files
with the extension “xdoz” and “xdmz” files in order to have Additional Withholding Information running
successfully.
Additional Withholding Information Layout Templates “xdoz”:
1. Pack source files:
<PACK_PATH>\MX\E-INVOICE\CA\BI\Process\template
2. BI destination Folder:
/Shared Folders/Custom/Local Solution/MX/E-INVOICE/Process
1. Access BI Publisher Enterprise Tool (including /xmlpserver after URL used to access the Cloud
environment). Example: https://XXXX.XX.XXX>.oraclecloud.com/xmlpserver
2. Go to /Shared Folders/Custom/Local Solution/MX/E-INVOICE/Process folder and click on
Upload Resource icon
3. Press “Choose File” button and select the file to be uploaded in the following path:
<PACK_PATH>\MX\E-INVOICE\CA\BI\Process\template\<File Name>.xdoz
Check the “Overwrite existing file” and then Click on the Upload button
9
4. IMPORTANT:
In case of Additional Withholding Information new Installation repeat the previous step for
all the files available in the <PACK_PATH>\MX\E-INVOICE\CA\BI\Process\template;
In case of Additional Withholding Information Update you may apply only the modified files
since your last installation or update. Make sure to read carefully the Packs’s readme to
identify the list of files to be uploaded. If you don’t have all the packs applied so far then
you may need to evaluate the delivered packs since your last installation or update to build
a list of files to be updated. In case of doubts upload all the files available in the folder
<PACK_PATH>\MX\E-INVOICE\CA\BI\Process\template;
5. Click on Expand the folder Process to confirm all files available in pack directory were
successfully uploaded.
7. Press “Choose File” button and select the file to be uploaded in the following path:
<PACK_PATH>\MX\E-INVOICE\CA\BI\Process\<File Name>.xdmz
Check the “Overwrite existing file” and then Click on the Upload button
8. IMPORTANT:
In case of Additional Withholding Information new Installation repeat the previous step for
all the files available in the <PACK_PATH>\MX\E-INVOICE\CA\BI\Process\datamodel;
In case of Additional Withholding Information Update you may apply only the modified files
since your last installation or update. Make sure to read carefully the Packs’s readme to
identify the list of files to be uploaded. If you don’t have all the packs applied so far then
you may need to evaluate the delivered packs since your last installation or update to build
a list of files to be updated. In case of doubts upload all the files available in the folder
<PACK_PATH>\MX\E-INVOICE\CA\BI\Process\datamodel;
10
9. Click on Expand the folder Data Models to confirm all files available in pack directory were
successfully uploaded.
Customers that are installing the LACLS for Mexico must install the database objects included in the
LACLS Mexican Pack. In your database will be stored elements like, tables, types, PL/SQL code, etc.
Before importing Database objects to create LACLS for Mexico structure, it is required that the Agent
has already been created and running successfully. The information required to create the Agent is
available in The Infrastructure Installation Guide available for download under Latin America Cloud Local
Solutions (LACLS) - Installation and Maintenance Notes (Doc ID 2568812.1) available in My Oracle
Support.
This chapter show the steps to upload the scripts into Oracle Database
Or
11
3. Connect to DBCS using LACLS user
Or
@< PACK_PATH>/MX/DB/sql/install_mx_efd.sql
5. The install_mx_efd.sql script will invoke all other statements needed to install the database
objects solution.
6. To verify if the objects were successfully created please run the following statement:
SELECT * FROM ALL_OBJECTS
WHERE OBJECT_NAME LIKE ‘LACLS_MX_EFD%’
It can not have INVALID objects.
OIC Integrations are the part of the solution which orchestrate all the process’s phases.
12
In this chapter you will see the installation instructions for this component.
If you are doing the installation for the first time in your environment then you can skip to the IMPORTING
OIC INTEGRATION PACKAGE FILE.
For Additional Withholding Information solution update it is necessary deactivate all OIC integrations
LACLS_MX_EFD_<integration name> before proceed the .par import.
The following steps guide you to how import OIC components package for Additional Withholding
Information Solution.
Artifact Description
This document show the steps to import an configure the OIC artifacts in order to enable Additional
Withholding Information.
1. Log into Oracle Integration Cloud Service, click on the Integrations icon.
13
2. On the left panel option, choose the Packages icon
14
DEPLOYING VISUAL BUILDER APPLICATIONS FILES (OIC-VBCS FILES)
Visual Builder components are the User Interface. Additional Withholding Information solution is
composed by a set of User Interface (UI). The UI will be used by the users to enter complementary
information required by SAT, according to the Withholding Complement Type.
In this topic you will see the installation instructions for this component.
1. After logged into Oracle Integration Cloud Service, click on the Visual Builder icon.
15
4. Click on “Upload a file or drag it here” and select file
<PACK_PATH>/MX/ E-INVOICE/OIC/visualbuilder/LACLS_MX_EFD_AP_ADDITIONALS.zip
16
CONFIGURATION TASKS – INSTALL AND UPDATE STEPS
After the installation / update of the artifacts is complete, this chapter provides a guide for setting up
the Mexican solution. (Mandatory for Install and Update).
After the upload the artefacts will be available in OIC. However, some configuration must be done in order
the Integration can run successfully.
17
5. Fill the Email Address with an Email Account that be responsible for OIC
7. In the Connection Properties page, set the URL to reach the BI run service:
18
In the Connection Properties page, put the field property Vale associated to (*WSDL URL) value
according to the URL provide by the ERP Cloud
https://< DOMAIN_NAME >/xmlpserver/services/PublicReportService?wsdl
8. Click on the OK
9. Go to Security option. Click on the Configure Security button
19
CONFIGURE LACLS_MX_EFD_REST REST CONNECTION
Now go to configure the REST connection. This type of connection will be used internally when a service
needs to call other OIC service.
5. Fill the Email Address with an Email Account that be responsible for OIC
6. Click on the Configure Connectivity button. The follow page will be displayed:
20
In the Connection Properties page, put the field property Vale associated to (*Connection URL)
value according to the URL provide by the ERP Cloud
The domain name is according to domain Oracle Integration Cloud Service – PaaS defined to the
company.
7. Click on OK button
8. Scroll down to Security option. Click on the Configure Security button
9. In the Credentials page, choose the Security Policy called Basic Authentication
21
10. Put an Username and Password that belong to an user with permissions to use the OIC Platform
Web Service process
Important:
It must be the Oracle Integration Cloud user (lacls_oic_user).
When the User Credentials (password) be updated, the Connection password must be
changed also.
We recommend be created a specific user to be used as “OIC Integration User” instead
of use a regular natural person user.
11. Click on the OK
12. Click on Test option, at the up right corner. A Confirmation message will be displayed. Click on
Validate and Test button
It is mandatory that the Infrastructure Installation Guide has already been verified before continuing with
this installation step. The Infrastructure Installation Guide is available for download under Latin America
Cloud Local Solutions (LACLS) - Installation and Maintenance Notes (Doc ID 2568812.1) available in My
Oracle Support.
Setting up the connection to the Oracle database. This type of connection will be used internally when a
service, used in Withholding Additional Information solution flows, needs to call the PaaS database.
22
1. Navigate to Connections in order to manage some needs configuration.
5. Fill the Email Address with an Email Account that be responsible for OIC
6. If you are using a DBCS instance, please follow instructions described in step 6.1, otherwise, if you
are using an Autonomous database, please follow instructions described in step 6.2
23
b. In the Connection Properties page, put the database connection information:
Host=<DBCS Server IP address>
Port=<Database Listener Port>
Service Name=<Database PDB1 connection string>
Note:
These information can be found in the DBCS Instance details panel, through the Oracle Cloud
services console.
c. Click on OK button
d. Scroll down to Security option. Click on the Configure Security button to provide the
LACLS database user credentials
24
Security properties required:
e. Click on OK button
f. Go to Agent Group option. Click on the Configure Agents button
g. In the Agent Group list, select the Agent configured previously and click on Use button
Note: This Agent must be linked to the database which that will store the LACLS MX
database objects.
Note:
This information can be found in the ATB Instance details panel DB Connection, through the
Oracle Cloud services console.
25
c. Click on OK button
d. Scroll down to Security option. Click on the Configure Security button to provide the
LACLS database user credentials
e. Click on OK button
7. Click on Test option, at the up right corner. A Confirmation message will be displayed. Click on
Validate and Test button
26
8. The successfully message will be shown
9. Click on Save. There will be displayed a message indicating every Integration that use this
Connection. Choose Save.
10. The successfully message will be shown
11. Click on Close button. It returns to the Connections page
In the OIC lookup we configure constant values for the solution mapping.
1. Navigate to Integrations/Lookups
3. To edit the connection, click on the Action icon. It will show the list, click on the Edit option
27
4. A similar page to the follow will be displayed. To change the values, click on the Value area and
then put the information needs
5. These are the complete mapping for the lookup values. Almost all the values are provided by
default.
For Additional Withholding Information Installation verify the instructions in the Value column
to configure it.
For Additional Withholding Information Update make sure you have all the ParameterName and
Value in your lookup. In negative case add a line in your lookup and include the ParameterName
and Value accordingly to the table below:
Note: Do the following to add a line in the lookup:
a. Go to the last page by pressing the Last Page button;
28
b. Press the Add Row button and insert the ParameterName and Value in the new row;
ParameterName Value
AP_AttributeFormat xml
/Custom/Local Solution/MX/E-INVOICE/Process/EFD
APLookup_ReportAbsolutPath
AP Lookups.xdo
/Custom/Local Solution/MX/E-INVOICE/Process/EFD
APCountries_ReporttAbsolutePath
AP Countries.xdo
/Custom/Local Solution/MX/E-INVOICE/Process/EFD
APStates_ReporttAbsolutePath
AP States.xdo
29
Important:
After the procedures to uploading and configuring the artefacts, it is time to activate the flow and put
the integration to run. It is recommended to enable the trace, including the payload option. It is useful
in situation when the Integration gets error, eventually. The payload allows the analysis more accurately
and faster.
1. To activate the flow, it needs to switch the button in the same line where the flow appears, or
to access the Action and, when the list is displayed, click on the Activate.
30
There is other way to Activate an Integration is Click on Action, and then, choose Activate
2. After clicking on the Activate option, a page similar to the follow will be displayed:
31
Note that only the option Enable tracing is available. Just after clicking on this option, the
Include payload will be available too.
32
5. The flows will be activated and it will be displayed similar page:
This topic show the steps to configure the VBCS Service Connection in order the LACLS for Mexico get
available. The Service Connection is responsible for calling the ICS flows.
33
4. Navigate to Authentication
In the Authentication Mechanism, choose Basic option
Then put your OIC User and Password
Important:
It must be the Oracle Integration Cloud user (lacls_oic_user).
When the User Credentials (password) be updated, the Connection password must be
changed also.
34
5. In the left panel, click in “lACLS_MX_EFD_AP_HcmRestApi”.
6. Go to Service folder and change the domain, pointing to your SaaS domain.
35
Important:
It must be the Oracle Integration Cloud user (lacls_oic_user).
When the User Credentials (password) be updated, the Connection password must be
changed also.
8. Done
36
Copyright © 2021, Oracle and/or its affiliates. All rights reserved.
This document is provided for information purposes only, and the contents hereof are subject to change without notice. This document is not warranted to be error-free, nor subject
to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose.
We specifically disclaim any liability with respect to this document, and no contractual obligations are formed either directly or indirectly by this document. This document may not
be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without our prior written permission.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of
SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered
trademark of The Open Group.
37