Difference between revisions of "Sending Service"

From E-fileWiki
Jump to navigation Jump to search
 
(166 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<small>''Page's last update : 21 August 2024''</small>
__TOC__
<span id="BackToTop"></span>
<div class="noprint" style="background-color:#FAFAFA; position:fixed; bottom:10%; right:0.25%; padding:0; margin:0;">
<span style="color:blue; border:0.3em outset #abd99f; padding:0.2em; font-weight:bolder; -moz-border-radius:8px; ">
[[#BackToTop|Back to the Top]]
</div>
<div style="text-align: right; direction: ltr; margin-left: 1em;">[[Welcome_to_e-file_and_Fundsquare_FAQ|Home page ]][[File:Home.png|Return homepage|link=Welcome_to_e-file_and_Fundsquare_FAQ]]</div>
<div style="text-align: right; direction: ltr; margin-left: 1em;">[[Welcome_to_e-file_and_Fundsquare_FAQ|Home page ]][[File:Home.png|Return homepage|link=Welcome_to_e-file_and_Fundsquare_FAQ]]</div>


= Operating principle =  
= Operating principle =  


The '''Sending Service''' is our solution for '''automatically sending reports and documents''' to authorities.
The '''Sending Service''' is our solution for the  '''automatic transmission''' of reports and documents to authorities.
 
This solution is useful if you have a '''large number of reports''' to submit or if the manual sending does not suit your needs.
 
Please be aware that, in this case you will have to provide the files yourself according to the authorities' file specifications.  


This tool is compatible with most of the current operating systems (Windows / Unix / Linux) and is usually <span style="color: #C00000">'''installed on a server'''</span> on your side.
This tool is compatible with most of the current operating systems (Windows / Unix / Linux) and is usually <span style="color: #C00000">'''installed on a server'''</span> on your side.
Line 10: Line 24:


The file is then automatically ''' encrypted and sent'''.
The file is then automatically ''' encrypted and sent'''.




Line 17: Line 32:


*Internet access
*Internet access
*Java Runtime Environment 1.7 or above
*<span style="color: #C00000">'''Java version 1.8 </span> <u>Note :</u> versions 8_351 and higher need a patch to be used with our system, see :[[Error_messages_list#JCE_cannot_authenticate_the_provider_BC]]'''
*If you use a proxy, authorize outgoing calls to [https://www.e-file.lu www.e-file.lu]. Ports 80 (HTTP) and 443 (HTTPS) must be open.
*If you use a proxy, authorize outgoing calls to [https://www.e-file.lu www.e-file.lu]. Port 443 (HTTPS) must be open.
*Administrator rights to install the Sending Service
*<span style="color: #C00000">'''Administrator rights''' </span> to install the Sending Service on the computer ''(Windows Start button > Control Panel > User Accounts > Manage User Accounts)''.
*OS: Windows or Linux
*OS: Windows or Linux
*Processor: Pentium 2 GHz or equivalent
*Processor: Pentium 2 GHz or equivalent
*1 GB of RAM
*8 GB of RAM
*1 GB of free space on hard disk drive if the files are downloaded by ftp. If files are locally stored, provide a free space of above 100 MB or a regular purges.
*1 GB of free space on hard disk drive if the files are downloaded by ftp. If files are locally stored, provide a free space of above 100 MB or a regular purges.
*1 GB of free space on hard disk drive for logs. Regular purges are necessary as well.
*1 GB of free space on hard disk drive for logs. Regular purges are necessary as well.
*A Sending Service e-file user, ''example: aacSD'', and his password, ''example: formation'', are available.  
*A <span style="color: #C00000">'''Sending Service user''' </span>, ''for example: aacSD'', and its password, ''for example: formation'', have to be available [[E-file_Administration#e-file_administrator_functions_.28e-file_v1.29|'''=> e-file administrator''']].
*The Sending Service user has to be linked to groups/modules, example FATCA reporting + profile "Sending Service".  
*The e-file account of the Sending Service user has to be linked to groups/modules, for example FATCA reporting + profile "Sending Service".  
*The Sending Service user has to be configured to receive alerts in order to be able to receive acknowledgement and feedback files.
*A valid <span style="color: #C00000">'''keystore''' </span> (keystore.ks) and its <span style="color: #C00000">'''password''' </span> must be available
*The Sending Service user has to be properly configured in the e-file user administration tool in order to be able to receive <span style="color: #C00000">'''alerts''' </span> (receipt of acknowledgement and feedback files).
 
 
Note that you can find the prerequisites for the manual transmission there : [[Transmission_Module#System_requirements]]
 
= Installation / update with Sending Service Installer =
 
The Sending Service Installer is a tool that helps you install or configure quickly your Sending Service.
 
It can be downloaded from these links:
 
'''[https://www.e-file.lu/WSEfileFlex/messagebroker/assistantSD?cdLangIso=EN English version]'''
 
'''[https://www.e-file.lu/WSEfileFlex/messagebroker/assistantSD?cdLangIso=FR French version]'''
 
Once you have downloaded the application you will have to run it with Java by clicking the Run button.
 
[[File:Doc_SDInstaller_01.png|border|400 px]]
 
 
''If the message'' unable to run the application ''occurs, [[Transmission_Module#Delete_Java_cache|delete the java cache.]]''
 
 
'''The front page of the Sending Service Installer opens and shows you the different functionalities you can select: '''
 
* Install a new Sending Service
* Configure an existing Sending Service
* Update an existing Sending Service
* Send logs
 
[[File:Doc_SDInstaller_02.png|border|600 px]]
 
 
 
 
 
== Installation ==
 
'''Controls before installation:'''
* Check that the connected user is administrator of the computer
* Have an e-file Sending service user (login and password) (e.g. : aacSD)
 
To check whether a Sending service user exists, log on as an e-file administrator.
<u>'''Step 2</u>:'''
 
Click the '''Administration module'''
 
[[File:AdminAccess.png|700px]]
 
The user linked to the Sending Service usually follows the bellow naming rules : three
letters referring to the company (in lower case) following by "SD" in upper case. (e.g. :
aacSD)
 
[[File:User Sending service.png|900px]]
If the user doesn't exist, please contact us.
 
 
 
'''Start installation:'''
To install a <u> new </u> Sending Service, click on the button Install on the front page.
 
 
<u>'''Step 1'''</u>: Select the folder where you want to install your Sending Service.
 
[[File:Doc_SDInstaller_03.png]]
 
 
 
 
 
<u>'''Step 2'''</u>: The Sending Service is downloaded and saved in the selected folder.
 
 
 
 
 
<u>'''Step 3'''</u>: Select the keystore file, containing your LuxTrust certificate.
 
[[File:Doc_SDInstaller_04.png]]
 
 
 
 
 
<u>'''Step 4'''</u>: The Sending Service is ready to be configured. By clicking the '''Configuration''' button, you will be redirected to the '''Configuration menu''' of the '''.properties file'''.
 
[[File:Doc_SDInstaller_05.png]]
 
==Configuration==
 
To configure an <u>existing</u> Sending Service you have to select the folder where it is stored and click on the '''Configuration''' button.
 
[[File:10 SendServConf.png|border|600 px]]
 
The '''configuration''' of an existing Sending Service is similar to a new Sending Service.
 
 
<span style="background:yellow"> '''IMPORTANT:''' </span> each time you make changes to the properties (configuration) file, you have to [[Sending Service#How to stop the Sending Service|stop the Sending Service]] before, make your changes and then install the Sending Service again.
 
 
'''Configuration''' menu of the '''.properties file''' ([[Sending_Service#Configuration of the properties file | => Help: Configuration of the properties file]]):
 
[[File:Doc_SDInstaller_06.png|border|500 px]]
 
 
The '''Configuration''' menu allows you to setup your Sending Service.
 
The message ''Error: There are errors in your setup'' indicates that nothing has been set-up so far.
 
You have to configure each field marked in red.
 
 
 
If you have a '''proxy''', select ''True'' in the dropdown list and select ''More'' to type in the proxy settings.
 
''Note: The passwords will be asked during the finalization of the installation, all passwords are encrypted.''
 
''Note 2: You can edit each field by clicking the More button''
 
[[File:Doc_SDInstaller_07.png|border|600 px]]
 
 
 
 
 
The '''listeners''' can be activated in one shot by clicking on the button ''Listener state : Activate all''.
 
''Note: This functionality will force the Sending Service to scan all the folders, if you do not want all listeners to be activated, please activate manually the listeners you need.
 
Please consult our [[Sending_Service#Listener_list | Listener list]].
 
 
[[File:Doc_SDInstaller_08.png|border|600 px]]
 
 
 
If you have to submit Investment Funds reporting O4.1; O4.2 (EDIFACT format), you must complete this fields :
 
'''domain.descr''': Not relevant. You can provide abbreviated name of the Central Administration.
 
'''domain.env.ac.id.bcl''': this code is composed of a letter and six digits and has been provided to you by the CSSF (Example: P123, should be written as “P000123”).
 
'''domain.env.ac.id.cssf''': this code is composed of a letter and six digits and has been provided to you by the CSSF (Example P123, should be written as “P000123”).
 
The two others will be asked when installing (domain.en.ac.cd_auth and domain.env.ac.pwd)
 
 
[[File:Doc_SDInstaller_09.png|border|500 px]]
 
 
 
 
 
Once the configuration finished, you can click on '''Control''' to check if there is a configuration error.
 
The message ''No error in your setup'' means that the setup is correct.
 
[[File:Doc_SDInstaller_10.png|border|500 px]]
 
 
 
If there are no errors, you can click on '''Save''' to save your actual configuration.
 
[[File:Doc_SDInstaller_11.png|border|500 px]]
 
 
 
To install the Sending Service, you have to click on the '''Install''' button.




Please consult our videos:
A pop-up window opens where you have to enter your passwords.


[[File:video.png]] Creation of an e-file user (e-file v1)
If you do not use a proxy, you can leave a blank for the proxy password<br/>
[https://www.e-file.lu/videos/Admin_Creation_Utilisateur_EN.htm Watch the video]
If you need to send O4.1 or O4.2 reports enter also those :<br/>
CA Password = '''domain.env.ac.pwd''': this '''authentication password''' has been provided to you by the CSSF (postal mail).<br/>
CA Code = '''domain.en.ac.cd_auth''': this '''authentication code''' has been provided to you by the CSSF (postal mail).<br/>


[[File:video.png]] Adding a group to a user (e-file v1)
[[File:Doc_SDInstaller_12.png|border|500 px]]
[https://www.e-file.lu/videos/Admin_Ajout_Groupe_Utilisateur_EN.htm Watch the video]




[[E-file_Administration#e-file_administrator_functions_.28e-file_v1.29|'''=> e-file administrator''']]
Once finished a pop-up windows opens stating that the installation has been successful:


[[File:Doc_SDInstaller_13.png|border|500 px]]


To start your Sending Service open the folder where you installed it and run the file '''run.bat''' or '''InstallServiceNT.bat''' if you want to install the Service as a '''Windows Service'''.


[[Sending Service#Installation as a Windows Service|=> Installation as a Windows Service]]


[[Sending Service#How to start the Sending Service|=> How to start the Sending Service]]


= Settings of the properties file =
[[Sending Service#How to stop the Sending Service|=> How to stop the Sending Service]]


A <b> ''Properties'' </b> file is located at the root folder of the Sending Service. <br>
==Update==


It contains all your personal information, all your needs and allows you to '''generate your configuration files''' during the physical installation. <br>
<span style="background:yellow"> '''IMPORTANT:''' </span> before updating your Sending Service you have to [[Sending Service#How to stop the Sending Service|stop the Sending Service]].


The latter are used to start and use the Sending Service. <br>
To update an <u> existing </u> Sending Service you have to click the ''Update'' button.
In other words :<br>
 
Then click on '''Check''' in order to verify if a new version is available.


* It contains all the '''variables''' needed to run the service.
[[File:Doc_SDInstaller_16.png|border|600 px]]
* <span style="color: #C00000">'''Any modification of this file must be followed by an installation to be really taken into account.'''</span>
 
<br>
 
 
 
If your Sending Service is up-to-date you will get the following message:
 
[[File:Doc_SDInstaller_17.png|border|600 px]]
 
 
 
 
If there is a new version of the Sending Service available the following window will appear:
 
[[File:Doc_SDInstaller_18.png|border|600 px]]
 
 
 
 
To continue the update, click on Ok.
 
 
During the first steps, the new version will be downloaded.
 
Once you have reached step 3, the tool will ask you to select your old '''configuration''' file ('''.properties file''')
 
[[File:Doc_SDInstaller_19.png|border|600 px]]
 
 
 
 
The tool will automatically back-up of your old Sending Service. You have to wait until the process is finished.
 
[[File:Doc_SDInstaller_20.png|border|600 px]]
 
 
 
 
Step 5 will be the '''configuration''' of the updated Sending Service. You have to click on '''Configuration''' to access the '''Configuration''' menu.
 
[[File:Doc_SDInstaller_21.png|border|600 px]]
 
 
 
 
If there are changes in the configuration file of the Sending Service with the new version, the fields will be marked in red. You will have to select the proper setup and save the changes.
 
[[File:Doc_SDInstaller_22.png|border|600 px]]
 
Once the configuration finished, you can click on '''Control''' to check if there is a configuration error.
 
The message ''No error in your setup'' means that the setup is correct.
 
[[File:Doc_SDInstaller_10.png|border|500 px]]
 
 
 
If there are no errors, you can click on '''Save''' to save your actual configuration.
 
[[File:Doc_SDInstaller_11.png|border|500 px]]
 
 
 
To install the Sending Service, you have to click on the '''Install''' button.
 
A pop-up window opens where you have to enter your passwords.
 
''Note : If you do not use a proxy, you can leave a blank for the proxy password''
 
[[File:Doc_SDInstaller_12.png|border|500 px]]
 
==Send logs==
 
If you encounter issues with your Sending Service, you can use the Help function to send an email to the [[How to contact us|'''Client Support & Operations Desk''']].
 
The tool will create automatically a zip file containing the log files of your Sending Service you can attach to the email.<br><br>


'''The [https://www.e-file.lu/docs/EN/ManuUtil_EFile_Installation_SD_EN.pdf  detailed documentation], at page 15''', precisely describes, field by field, the needs of this file.
[[File:Doc_SDInstaller_23.png]]
'''Do not hesitate to consult it'''.<br>
You will also find in the following paragraphs, a '''summary of information''', organized by blocks of information'', necessary for the proper configuration.<br>


<br>
[[File:Doc_SDInstaller_24.png]]
More generally, the principle is to '''replace all '????' with your own information'''


{| border="1" cellspacing="1" cellpadding="10"
= Manual installation with Command Prompt =  


|-  
* Download the latest Sending Service version here: [https://www.e-file.lu/WSEfileFlex/SD/SD.zip '''Download latest Sending Service version''']


|  [[File:Properties e-file hostname.jpg]] ||
* Extract and copy the entire content of the directory ServiceDeposant in the Sending Service directory. Ensure that the directory is <span style="color: #C00000">'''not read only''' </span>.
[[File:SD.png| 600 px]]


<b>''(-) e-file.hostname''</b> : <span style="color: #C00000">'''www.e-file.lu'''</SPAN> for production environment, or <span style="color: #C00000">'''homologation.e-file.lu'''</span> for test environment.<br>
* Copy your <span style="color: #C00000">'''keystore'''</span> in the keystores folder of the Sending Service.


<b>''(-) efile.userId.Login''</b> : e-file login of the Sending Service user.
* Copy the <span style="color: #C00000">'''template_configInstall.properties'''</span> file and rename it [sender''Name''].properties.


<b>''(-) keystore.path=@PROJECT_ROOT_PATH@/keystores/xxxx.ks''</b> : path of the keystore (xxxx.ks)
* Complete the <span style="color: #C00000">'''properties file'''</span> as explained in [[Sending Service#Configuration of the properties file|'''Configuration of the properties file''']] chapter.


<b>''(-) lang.code''</b> : language of the acknowledgement files
* Install the new Sending Service:
(-) Open Command Prompt
(-) Move to the root folder of your new Sending Service (for example: C:\Program Files\e-file\ServiceDeposant\)
(-) install.bat [sender''Name''].properties
(-) enter the root path of your JRE (for example: C:\Program Files\Java\jre1.8)
(-) Enter the password of the e-file Sending Service user
(-) Enter the password of your keystore
(-) Enter the password of your proxy if you use a proxy
(-) Enter the O4.x password for CSSF/BCL if needed
(-) Enter the O4.x authentication code for CSSF/BCL if needed
(-) Press the ENTER key
   
   


|-
<span style="background:yellow"> '''IMPORTANT:'''  </span>
 
SECURITY ENHANCEMENTS (june 2023)
 
The security settings of the Sending Service have been enhanced for O4.1 and O4.2 reports, the related passwords are now encrypted.
 
Please note that the installation procedure of the Sending Service slightly changed due to the implementation of this feature:
 
[[File:SD_CmdInstall.png | 800 px]]
 
 
At the end of the script you must get the following message: <span style="background:yellow"> '''BUILD SUCCESSFUL'''  </span> indicating that the installation was successful.
 
[[File:SD_CmdInstall_success.png | 200 px]]
 
 
<span style="background:yellow"> '''IMPORTANT:''' </span> each time you make changes to the properties (configuration) file, you have to [[Sending Service#How to stop the Sending Service|stop the Sending Service]] before, make your changes and then install the Sending Service again.
 
 
== Configuration of the properties file ==
 
The <u>.properties</u> file (''template_configInstall.properties'') contains important information which are necessary to '''generate your configuration files''' during the physical installation.
 
The latter are used to start and use the Sending Service.
 
In other words :
 
* <span style="color: #C00000">'''The <u>.properties</u> file contains all the variables needed to run the Service Service.'''</span>
 
* <span style="color: #C00000">'''Any modification of the <u>.properties</u> file must be followed by an installation of the Sending Service to be really applied.'''</span>
 
 
<span style="color: #C00000">'''Please find below important information on how to configure your <u>.properties</u> file.''' </span>
 
<span style="color: #C00000">'''Please note, that at the end of setup, no '?' should remain in this file. </span>
 


| [[File:Properties proxy.jpg]] ||<b>''proxy.required''</b> : <span style="color: #C00000">'''true'''</span> if a proxy is used to access the internet through HTTP or HTTPS.


All other parameters depend on your network infrastructure. All parameters are not mandatory.


Please consult your network team to get this information.
'''E-file configuration'''


{| class="wikitable;style="background:#112233"
|-
! Variable
! Description
|-
|style="width:20em"| '''''efile.hostname=????'''''
|style="width:20em"| <span style="color: #C00000">'''www.e-file.lu'''</SPAN> for production environment,<br> or <br><span style="color: #C00000">'''homologation.e-file.lu'''</span> for test environment.
|-
|-
| [[File:prop3.jpg]] ||<b>''(-) efile.listener.state=up??down <br> (-) efile.replies.listener.state=up??down </b>
|style="width:20em"| '''''efile.userId.Login=????'''''
|style="width:20em"| e-file login of the Sending Service user (Example: abcSD)
|-
|style="width:30em"| '''''keystore.path=@PROJECT_ROOT_PATH@/keystores/????.ks'''''
|style="width:20em"| path of the keystore (xxxx.ks)
|-
|style="width:20em"| '''''lang.code=FR??EN'''''
|style="width:100em"| language of the acknowledgement files
|}


These parameters are used to allow you (up) or not (down) to receive acknowledgment and feedback files from the authorities.


'''We recommand to leave these values at <span style="color: #C00000">up</span>'''


|-


| [[File:prop4.jpg]] || (-) All subsequent blocks <b>''reportingXXXXXX.state=up??down''</b> are coresponding to a particular type of reporting.


Please consult our [[Sending Service#Listener List|Listener list]] to verify which reporting type is linked to which listener.
'''Proxy configuration'''


Example: if you only have to sent FATCA reportings, the state of the listener reportingFATCA.state has to be up: '''reportingFATCA.state='''<span style="color: #C00000">'''up'''</span>'''
{| class="wikitable;style="background:#112233"
|-
! Variable
! Description
|-
|style="width:30em"| '''''proxy.required=false??true'''''
|style="width:50em"| <span style="color: #C00000">'''true'''</span> if a proxy is used to access the internet through HTTP or HTTPS.
|-
|style="width:30em"| '''''proxy.host=???? <br> proxy.port=???? <br> proxy.user=???? <br> proxy.domainNTLM=????'''''
|style="width:100em"| Complete all other parameters according your network infrastructure.
|}


The other listeners should be <span style="color: #C00000">'''down'''</span>.


<b>''reportingXXXXXX.remoteDir''</b> : <span style="color: #C00000">'''Path to file location'''</span> for the relevant reporting.




(-) <b>''@PROJECT_ROOT_PATH@''</b> : <span style="color: #C00000">'''Dynamic parameter'''</span> indicating the Sending Service installation path.<br>
To change if you want to locate the user working directory elsewhere on the server or another machine.
In this case, indicate the full path to file.(separator = '/')


'''Configuration of connection for authority acknowledgement / feedback files'''


(-) <b>''reportingXXXXXX.scheduleTime''</b> : <span style="color: #C00000">'''Execution frequency'''</span> of service to process files from this folder. (30mn by default).<br>
{| class="wikitable;style="background:#112233"
Feel free to '''reduce this value but do not fall below 5mn= <i><span style="color: #C00000">300000</span></i>'''
|-
! Variable
! Description
|-
|style="width:30em"| '''''reportingXXXXXX.state=up??down'''''
|style="width:50em"| All subsequent blocks in the .properties file corespond to a particular type of reporting.


Please consult our [[Sending Service#Listener list|'''Listener list''']] to verify which reporting type is linked to which listener.


(-) <b>''reportingXXXXXX.deeplevel''</b> : <span style="color: #C00000">Number of '''sub-levels'''</span> to scan.<br>
Example: if you only have to sent FATCA reportings, the state of the listener reportingFATCA.state has to be up: '''reportingFATCA.state='''<span style="color: #C00000">'''up'''</span>'''
By default the value is <span style="color: #C00000">'''0'''</span>, which means that only files at the root of the folder will be taken in account.


|-
The other listeners should be <span style="color: #C00000">'''down'''</span>.


| [[File:prop5.jpg]] ||  
|-
|style="width:30em"| '''''reportingXXXXXX.remoteDir'''''
|style="width:50em"| <span style="color: #C00000">'''Path to file location'''</span> for the relevant reporting.


(-) <b>''domain.descr''</b> : Not relevant. You can provide '''abbreviated name''' of the Central Administration.<br>
|-
|style="width:30em"| '''''@PROJECT_ROOT_PATH@'''''
|style="width:50em"| <span style="color: #C00000">'''Dynamic parameter'''</span> indicating the Sending Service installation path.<br>
To change if you want to locate the user working directory elsewhere on the server or another machine.
In this case, indicate the full path to file (separator = '/').


(-) <b>''domain.env.ac.id.cssf''</b> : <span style="color: #C00000">Your '''CSSF identifier''' of 7 characters, 1 letter and 6 numbers'''</span> (example : P000999).<br>
|-
|style="width:30em"| '''''reportingXXXXXX.scheduleTime'''''''
|style="width:50em"| <span style="color: #C00000">'''Execution frequency'''</span> of Window Service to process files from this folder (30mn by default).
Feel free to '''reduce this value, but do not fall below 5mn= <i><span style="color: #C00000">300000</span></i>'''.


(-) <b>''domain.env.ac.id.bcl''</b> : <span style="color: #C00000">Your '''BCL identifier'''
|-
|style="width:30em"| '''''reportingXXXXXX.deeplevel'''''''
|style="width:100em"| <span style="color: #C00000">Number of '''sub-levels'''</span> to scan.<br>
By default the value is <span style="color: #C00000">'''0'''</span>, which means that only files at the root of the folder will be taken in account.


(-) <b>''domain.env.ac.pwd''</b> : <span style="color: #C00000">'''Password'''</span> of the Central Administration provided by the CSSF
|}


(-) <b>''domain.env.ac.cd_auth''</b> : <span style="color: #C00000">'''Authentification code'''</span> of the Central Administration provided by the CSSF


The CSSF has provided you in an official letter your <span style="color: #C00000">'''password'''</span> and <span style="color: #C00000">'''authentification code'''</span>.


|-


| [[File:prop6.jpg]] || '''Sending Service monitoring system''' <br>
'''Business environment properties'''


If parameter is  <span style="color: #C00000">'''true'''</span>, we will be able to send you an alert if an interruption of your service is detected on our side (within 72 hours).<br>
{| class="wikitable;style="background:#112233"
|-
! Variable
! Description
|-
|style="width:20em"| '''''domain.descr'''''
|style="width:20em"| Not relevant. You can provide '''abbreviated name''' of the Central Administration.
|-
|style="width:20em"| '''''domain.env.ac.id.cssf'''''
|style="width:20em"| Your <span style="color: #C00000"> '''CSSF identifier'''</span> of 7 characters, 1 letter and 6 numbers'''
|-
|style="width:30em"| '''''domain.env.ac.id.bcl'''''
|style="width:20em"| Your <span style="color: #C00000"> '''BCL identifier'''</span>
|-
|style="width:20em"| domain.env.ac.pwd
|style="width:50em"| Doesn't appear anymore in the .properties, it will be asked when installing. <span style="color: #C00000">'''Password'''</span> of the Central Administration provided by the CSSF
|-
|style="width:20em"| domain.env.ac.cd_auth
|style="width:100em"| Doesn't appear anymore in the .properties, it will be asked when installing. <span style="color: #C00000">'''Authentication code'''</span> of the Central Administration provided by the CSSF.


<b>''mon.app.origin''</b> : <span style="color: #C00000">'''Unique name'''</span> , without space, to provide us to enable us to identify your Sending Service.
The CSSF has provided you in an official letter your <span style="color: #C00000">'''password'''</span> and <span style="color: #C00000">'''authentication code'''</span>. The above mentioned IDs, passwords and codes are necessary for the successful processing of the O4.1, O4.2; O1.2 and the former O1.1 reporting.
|}
|}


<u>'''IMPORTANT'''</u> : <span style="color: #C00000">'''At the end of setup, no '?' should remain in the configuration (.properties) file'''</span>






'''Configuration of monitoring'''


{| class="wikitable;style="background:#112233"
|-
! Variable
! Description
|-
|style="width:20em"| '''''mon.app.heartbeat=false'''''
|style="width:20em"| If parameter is "true", we will be able to send you an alert if an interruption of your service is detected on our side (within 72 hours).
'''Should you want to use this feature feel free to contact us'''
|-
|style="width:20em"| '''''mon.app.origin=????'''''
|style="width:20em"| <span style="color: #C00000">'''Unique name'''</span> , without space, to enable us to identify your Sending Service. Not mandatory.
|-
|style="width:30em"| '''''mon.task.dist.period=60000'''''
|style="width:100em"| Frequency of the heartbeat (here 60000 milliseconds, 1 min). The monitoring window is set to 9 minutes. At  least  one  heartbeat  must  have been registered during this interval otherwise the Sending Service is considered as down.
|-
|}


== Listener list ==
== Listener list ==
Line 161: Line 530:
|<span style="color: #868686"> <small>''Internal <br /> Technical <br /> Business ID''</small/> </span>
|<span style="color: #868686"> <small>''Internal <br /> Technical <br /> Business ID''</small/> </span>
|-
|-
| efile.listener.state= up
|<span style="color: #868686"> <small>''Please be informed that the listener '''efile.listener.state''' is no longer available in the properties file''</small/> </span>                   
| n/a
|<span style="color: #868686"> <small>''-''</small/> </span>
|Configuration of connection for authority acknowledgement
|<span style="color: #868686"> <small>''-''</small/> </span>
| n/a
|<span style="color: #868686"> <small>''-''</small/> </span>   
| <span style="color: #868686"> <small>''n/a''</small/> </span>
|<span style="color: #868686"> <small>''-''</small/> </span>
|-
|<span style="color: #868686"> <small>''Please be informed that the listener '''efile.replies.listener.state''' is no longer available in the properties file''</small/> </span>                   
|<span style="color: #868686"> <small>''-''</small/> </span>
|<span style="color: #868686"> <small>''-''</small/> </span>
|<span style="color: #868686"> <small>''-''</small/> </span>   
|<span style="color: #868686"> <small>''-''</small/> </span>
|-
|-
| efile.replies.listener.state= up
| reportingMMF=up
| n/a
|(-) ReportingDiffusion/MMF''
| Configuration of connection for feedback
| <small>CSSF - MMF
| n/a
| Money Market Fund Reporting
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| <span style="color: #868686"> <small>''83-Money Market Fund Reporting''</small/> </span>
|-
|-
| reportingOPC.automatique.state=up
| reportingOPC.automatique.state=up
Line 191: Line 566:
| <span style="color: #868686"> <small>''8-Transmission of UCI regulatory reports''</small/> </span>
| <span style="color: #868686"> <small>''8-Transmission of UCI regulatory reports''</small/> </span>
|-
|-
| <span style="color: #868686"> <small>''OBSOLETE : reportingOPC.semiAuto.state=up''</small/> </span>
| reportingOPC.semiAuto.state=up
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| n/a
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| n/a
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| n/a
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| n/a
|-
|-
|reportingVni.state=up
|reportingVni.state=up
Line 218: Line 593:
| <span style="color: #868686"> <small>''71-MiFIR reporting''</small/> </span>
| <span style="color: #868686"> <small>''71-MiFIR reporting''</small/> </span>
|-
|-
| reportingTAFEncrypted.state=up
|-
| ReportingDiffusion/TAF/ENCRYPTED
| reportingTAF.state=up
| <small>CSSF - Transactions in financial instruments (TAF)</small/>
| (-) ReportingDiffusion/TAF<br>
<span style="color: #868686"> <small>''(-) OBSOLETE:  ReportingDiffusion/TAF/declaration_Transaction''</small/> </span><br>
<span style="color: #868686"> <small>''(-) OBSOLETE: ReportingDiffusion/TAF/annulation_Transaction''</small/> </span><br>
<span style="color: #868686"> <small>''(-) OBSOLETE: ReportingDiffusion/TAF/annulation_Rapport''</small/> </span>
| <small>CSSF: transactions in financial instruments (TAF)</small/>
| Report TAF-MIFID
| Report TAF-MIFID
| <span style="color: #868686"> <small>''71-MiFIR reporting''</small/> </span>
| <span style="color: #868686"> <small>''71-MiFIR reporting''</small/> </span>
|-
| reportingIORP.state=up
| ReportingDiffusion/IORP
| <small>CSSF - Annual and quarterly reporting according to Circular CSSF 19/726 of 26 July 2019 </small/>
| Report IORP
| <span style="color: #868686"> <small>''80''</small/> </span>
|-
|-
| reportingCOREP.state=up
| reportingCOREP.state=up
| ReportingDiffusion/COREP
| ReportingDiffusion/COREP
| <small>CSSF:<br> SCOREP; SLAREX; SLCRXX; SNSFRX; SALMXX; CCOREP;<br>CLAREX; LCRXX; CNSFRX; CALMXX; CFINRP; SFINRP;<br>AEXXX; SAEXXX; CFPXXX; SFPXXX; CSBPXX;<br>SSBPXX; CSBPIM; SSBPIM; CLCRDA; SLCRDA</small/>
| <small>CSSF:<br> SCOREP; SLAREX; SLCRXX; SNSFRX; SALMXX; CCOREP;<br>CLAREX; LCRXX; CNSFRX; CALMXX; CFINRP; SFINRP;<br>AEXXX; SAEXXX; CFPXXX; SFPXXX; CSBPXX;<br>SSBPXX; CSBPIM; SSBPIM; CLCRDA; SLCRDA; ALMXXX</small/>
| Rapport COREP
| Rapport COREP
| <span style="color: #868686"> <small>''72-COREP reporting''</small/> </span>
| <span style="color: #868686"> <small>''72-COREP reporting''</small/> </span>
Line 232: Line 617:
| reportingFINREP.state=up
| reportingFINREP.state=up
| ReportingDiffusion/FINREP
| ReportingDiffusion/FINREP
| <small>CSSF: B2.4; B2.5</small/>
| <small>CSSF: B2.4; B2.5; LCRDAX</small/>
| Rapport FINREP
| Rapport FINREP
| <span style="color: #868686"> <small>''73-FINREP reporting''</small/> </span>
| <span style="color: #868686"> <small>''73-FINREP reporting''</small/> </span>
Line 250: Line 635:
| reportingBCLStat.state=up
| reportingBCLStat.state=up
| ReportingDiffusion/BCL_Statistics
| ReportingDiffusion/BCL_Statistics
| <small>BCL - Credit institutions: S0.1; S1.1; S1.4; S1.5; S1.8; S1.9;<br>S2.5-L; S2.5-N; S2.8; S2.9-L; S2.9-N; S3.2</small/>
| <small>BCL - Credit institutions: S0.1; S1.1; S1.4; S1.5; S1.8; S1.9;S1.12<br>S2.5-L; S2.5-N; S2.8; S2.9-L; S2.9-N; S3.2</small/>
| Statistiques BCL
| Statistiques BCL
| <span style="color: #868686"> <small>''13-BCL statistics''</small/> </span>
| <span style="color: #868686"> <small>''13-BCL statistics''</small/> </span>
|-
| reportingAnacredit.state=up
| ReportingDiffusion/Anacredit
| <small>ANTREF; ANTT1M; ANTT2M; ANTT2Q</small/>
| Rapport Anacredit
| <span style="color: #868686"> <small>''74 ANACREDIT reporting''</small/> </span>
|-
|-
| reportingSecurisation.state=up
| reportingSecurisation.state=up
Line 307: Line 700:
| Doc OPC et FIS (circ. CSSF)
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
|-
|-
| reportingRAFIS.state=up
| reportingRAFIS.state=up
| ReportingDiffusion/DOC_FIS_OPC/REPORT_FIS
| ReportingDiffusion/DOC_FIS_OPC/REPORT_FIS
| <small>CSSF SIF:  <br /> (-) Annual Report (AR) <br /> (-) Semi-annual report (SR) <br /> (-) Letter of explanation (LE) <br /> (-) Other periodic report (RO) <br /> (-) Movements in the securities portfolios (PM)</small/>  
| <small> CSSF SIF:  <br />  
(-) Annual Report (AR) <br />  
(-) Semi-annual report (SR) <br />  
(-) Letter of explanation (LE) <br />  
(-) Other periodic report (RO) <br />  
(-) Movements in the securities portfolios (PM)</small/> <br />
<small> SICAR: <br />
(-) Annual Report (AR) <br />
(-) Annual Report (RO) </small/>  
| Doc OPC et FIS (circ. CSSF)
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
Line 316: Line 720:
| reportingPOPC.state=up
| reportingPOPC.state=up
| ReportingDiffusion/DOC_FIS_OPC/PROSP_OPC
| ReportingDiffusion/DOC_FIS_OPC/PROSP_OPC
| <small>CSSF UCI: <br /> (-) Prospectus (PC) <br /> (-) Simplified prospectus (PS) <br /> (-) Letter of explanation (LE)</small/>
| <small>CSSF UCI: <br /> (-) Prospectus (PC) <br /> (-) Simplified prospectus (PS) <br /> (-) Letter of explanation (LE)</small/>
| Doc OPC et FIS (circ. CSSF)
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
Line 322: Line 726:
| reportingPFIS.state=up
| reportingPFIS.state=up
| ReportingDiffusion/DOC_FIS_OPC/PROSP_FIS
| ReportingDiffusion/DOC_FIS_OPC/PROSP_FIS
| <small>CSSF SIF: <br /> (-) Prospectus (PC) <br /> (-) Simplified prospectus (PS) <br /> (-) Offering document (DE) <br /> (-) Letter of explanation (LE)</small/>  
| <small>CSSF SIF: <br /> (-) Prospectus (PC) <br /> (-) Offering document (DE) <br /> (-) Letter of explanation (LE)</small/>  
| Doc OPC et FIS (circ. CSSF)
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
Line 328: Line 732:
| reportingKID.state=up
| reportingKID.state=up
| ReportingDiffusion/DOC_FIS_OPC/KID_OPC
| ReportingDiffusion/DOC_FIS_OPC/KID_OPC
| <small>CSSF: <br /> (-) Key Investor Information Document (KIID) <br /> (-) [[Sending Service#Automating process for KIID packages|Automated process for KIID packages]]</small/>
| <small> Key Investor Information Document (KID) <br />  
(-) O: OPC Law 2010 and Law 2007 <br />
(-) K: SICAR <br />  
(-) V: non-reglem. <br />
[[Sending Service#Automating process for KID packages|=> Automated process for KID packages]]</small/>
| Doc OPC et FIS (circ. CSSF)
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
Line 346: Line 754:
| reportingML.state=up
| reportingML.state=up
| ReportingDiffusion/DOC_FIS_OPC/MGMT_LETTER
| ReportingDiffusion/DOC_FIS_OPC/MGMT_LETTER
| <small>CSSF - Management Letters (ML) <br /> CSSF - Other auditor report (RR)</small/>
| <small>CSSF - Management Letters (ML) <br />
(-) O: OPC Law 2010 and Law 2007 <br />
(-) K: SICAR <br />
(-) V: non-reglem. <br />  
| Doc OPC et FIS (circ. CSSF)
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
Line 352: Line 763:
| reportingLF.state=up
| reportingLF.state=up
| ReportingDiffusion/DOC_FIS_OPC/LONG_FORM
| ReportingDiffusion/DOC_FIS_OPC/LONG_FORM
| <small>CSSF - Long Form reports (LF) <br /> CSSF - Other auditor report (RR)</small/>
| <small>CSSF - Long Form reports (LF)
(-) O: OPC Law 2010
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
|-
|reportingMLGFI.state=up
| ReportingDiffusion/DOC_FIS_OPC/MGMT_GFI
|<small> CSSF <br />
CSSF-Management Letter of Investment Fund Managers (IFM EN) <br />
Gestionnaires des fonds d'investissement (GFI FR)</small/>
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
|-
| reportingRGFI.state=up
| ReportingDiffusion/DOC_FIS_OPC/REPORT_GFI
|<small> CSSF <br />
Annual management company report <br />
Management company report, other frequency <br />
Explanation letter</small/>
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
|-
| reportingDOC_OTH.state=up
| ReportingDiffusion/DOC_FIS_OPC/OTHER
|<small> CSSF <br />
Auditor's report (RR) <br />
Explanation letter (LE) (for funds or Sicar, CSSF codification S or A) <br />
Report Hong Kong Securities and Futures (HK)</small/>
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
|-
| reportingCSDR.state=up
| ReportingDiffusion/CSDR
|<small> CSSF <br />
Report CSDR</small/>
| Reporting CSDR-9
| <span style="color: #868686"> <small>''78-Reporting CSDR''</small/> </span>
|-
| reportingGFI.state=up
| ReportingDiffusion/DOC_FIS_OPC/DOC_GFI
| <small> CSSF <br />
CSSF-Management Letter of Investment Fund Managers (IFM EN) <br />
Gestionnaires des fonds d'investissement (GFI FR)
 
(-) Risk management function(GR) <br />
(-) OPCVM instruments information (ID) <br />
(-) Compliance Function (FC)<br />
(-) Internal audit function report (IA)<br />
(-) Complaints handling (TP) <br />
(-) Authorized third party complaints (LP) <br />
(-) Risk Management Procedure (PG)<br /> 
(-) Organization chart (OG) <br />
(-) Mandates table (TM) <br /> 
(-) Delegates of RFI (RD) <br />
(-) Branch activity (AS), <br />
(-) Own funds ratio (FP) <br />
(-) Risk management procedure AIFM (PN) <br />
 
</small/>
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
|-
| reportingAML-AIFM-REG.state=up
| ReportingDiffusion/DOC_FIS_OPC/AML_AIFM_REG
| <small> CSSF <br />
CSSF-Management Letter of Investment Fund Managers (IFM EN) <br />
Gestionnaires des fonds d'investissement (GFI FR)
 
(-) Letter of explanation (LE) <br />
 
</small/>
| Doc OPC et FIS (circ. CSSF)
| Doc OPC et FIS (circ. CSSF)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
Line 370: Line 851:
| reportingDOCBNK.state=up
| reportingDOCBNK.state=up
| ReportingDiffusion/DOC_BNK
| ReportingDiffusion/DOC_BNK
| <small>CSSF: <br /> Annual Report (AR); Compliance Report (CO); Governance Report (GR); <br /> Internal Audit Report (IA), (ICAAP IC); Long Form Report (LF); Management Letter (ML); <br /> Risk Control Report (RC); Recovery Plan (RP); Single Customer View (SC)</small/>
| <small> AR: Annual Report <br />  
AS: Annual report consolidated <br />
CO: Compliance Report <br />
GR: Governance Report <br />  
IA: Internal Audit Report <br />
IC: ICAAP <br />
ID: ICAAP Consolidated <br /> 
LF: Long Form Report <br />
LC: Long Form consolidated <br />
LD: Long form branch or specific participation <br />
ML: ManagementLetter <br /> 
MC: Management letter consolidated <br />  
RC: Risk Control Report <br />
RP: Recovery Plan <br />
SC: Single Customer View <br /> 
LG: Reconciliation LuxGAAP FINREP <br />
RR: Results distribution <br />
BD: AC member list <br /> IL: ILAAP <br /> IM: ILAAP consolidated
<br />
AC: Audit report on AML/CTF <br />
MF: Audit report on rules of conduct <br />
MM: Head quarter annual report <br />
RE: Report on out-of-court complaint resolution <br />
TR: Table on out-of-court complaint resolution <br />
AD: Circ. 18/697 annexe1 <br />
 
| Reporting  des  établissements  de  crédit
| Reporting  des  établissements  de  crédit
| <span style="color: #868686"> <small>''27-Reporting of credit institutions''</small/> </span>
| <span style="color: #868686"> <small>''27-Reporting of credit institutions''</small/> </span>
Line 394: Line 900:
| reportingOPCNONLU.state=up
| reportingOPCNONLU.state=up
| ReportingDiffusion/DOC_OPC_NOT_LU/LOCAL_REGISTRATION<br>ReportingDiffusion/DOC_OPC_NOT_LU/LOCAL_NOTIFICATION
| ReportingDiffusion/DOC_OPC_NOT_LU/LOCAL_REGISTRATION<br>ReportingDiffusion/DOC_OPC_NOT_LU/LOCAL_NOTIFICATION
| <small>HOST_UPDATE: [[Sending Service#Automating process for KIID packages|Automated process for KIID packages]]</small/>
| <small>HOST_UPDATE: [[Sending Service#Automating process for KID packages|Automated process for KID packages]]</small/>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''30-Enregistrement pour OPC non LU''<br>''31-Notification pour OPC non LU''    </small/> </span>
| <span style="color: #868686"> <small>''30-Enregistrement pour OPC non LU''<br>''31-Notification pour OPC non LU''    </small/> </span>
Line 499: Line 1,005:
| Reporting CRS
| Reporting CRS
| <span style="color: #868686"> <small>''68-CRS reporting''</small/> </span>
| <span style="color: #868686"> <small>''68-CRS reporting''</small/> </span>
|-
| reportingGRP_BNK.state=up
| ReportingDiffusion/GRP_BNK
| <small>«SHS-Group» report </small/>
| BCL SHS report
| <span style="color: #868686"> <small>''75-SHS Reporting''</small/> </span>
|-
| reportingUCIAR.state=up
| ReportingDiffusion/UCIAR
| <small>CSSF UCIAR </small/>
| UCIAR Reporting
| <span style="color: #868686"> <small>''86-UCIAR Reporting''</small/> </span>
|}
|}


= Installation as a Windows Service =


Once the installation the Sending Service is completed, the <span style="color: #C00000">'''InstallServiceNT.bat'''</span> file is available and you can complete your Sending Service installation by creating the Windows Service <span style="color: #C00000">'''ServiceDeposant'''</span>.


Execution frequency of Window Service ServiceDeposant to process files from this folder is 30mn by default [[Sending_Service#Configuration of the properties file | => Configuration of the properties file]].




= Sending Service Installer =
Double click the <span style="color: #C00000">'''InstallServiceNT.bat'''</span> file.


The Sending Service Installer is a tool that helps you install or configure quickly your Sending Service.
[[File:InstallServiceNT.png|600 px]]


It can be downloaded from these links:


'''[https://www.e-file.lu/WSEfileFlex/messagebroker/assistantSD?cdLangIso=EN English version]'''
A Command Prompt window opens up and closes as quickly as it popped up. The new Windows Service <span style="color: #C00000">'''ServiceDeposant'''</span> is now available.


'''[https://www.e-file.lu/WSEfileFlex/messagebroker/assistantSD?cdLangIso=FR French version]'''
[[Sending Service#How to start the Sending Service|=> How to start the Sending Service]]


Once you have downloaded the application you will have to run it with Java by clicking the Run button.
[[Sending Service#How to stop the Sending Service|=> How to stop the Sending Service]]


[[File:Doc_SDInstaller_01.png|border|400 px]]
[[File:WindowsService.png]]




<u>IMPORTANT</u>: Please ensure the '''Sending Service user''' that is linked to this Windows Service has <span style="color: #C00000">'''Internet rights'''</span>  (=> Right click on ''Service deposant'' > select ''Properties'' > select ''Log On'' tab).




If you want to uninstall the Windows Service, please double click the <span style="color: #C00000">'''UninstallServiceNT.bat'''</span> file.


'''The front page of the Sending Service Installer opens and shows you the different functionalities you can select: '''


* Install a new Sending Service
* Configure an existing Sending Service
* Update an existing Sending Service
* Send logs


[[File:Doc_SDInstaller_02.png|border|600 px]]


= Installation on Unix/Linux =


*Move to the ServiceDeposant directory
<u> Example </u>: /opt/ServiceDeposant/




*Check that you have execution rights (x) on the Install.sh file
<u> Example </u>: ls -l


==Installation==


To install a <u> new </u> Sending Service, click on the button Install on the front page.
*If not, just add this right using the chmod command
<u> Example </u>: chmod 755 install.sh


<u>'''Step 1'''</u>: Select the folder where you want to install your Sending Service.


[[File:Doc_SDInstaller_03.png]]
*Launch Install.sh with the configuration file as parameter
<u> Example </u>: install.sh config.properties


*Press the Enter key and enter the Java path when requested


*Press the Enter key again and wait for the ‘BUILD SUCCESSFUL’ message.




* Once installed, launch the run.sh to run the sending service


<u>'''Step 2'''</u>: The Sending Service is downloaded and saved in the selected folder.
= How to start the Sending Service =


* Double click the <span style="color: #C00000">'''run.bat'''</span> command available at the root folder of your Sending Service




In the case you created a '''Windows Service'''


* Double click the <span style="color: #C00000">'''StartService NT.bat'''</span> command available at the root folder of your Sending Service


<u>'''Step 3'''</u>: Select the keystore file, containing your LuxTrust certificate.
or


[[File:Doc_SDInstaller_04.png]]
* Browse to the <span style="color: #C00000">'''Windows Services'''</span> console (''Start > Control Panel > Administrative Tools > Services'') and right click the '''ServiceDeposant''' service and start the service.


[[File:WindowsService.png]]






The message *Fin Ok* means that the installation was successful.


<u>'''Step 4'''</u>: The Sending Service is ready to be configured. By clicking the '''Configuration''' button, you will be redirected to the '''Configuration menu''' of the '''.properties file'''.


[[File:Doc_SDInstaller_05.png]]




'''Configuration''' menu of the '''.properties file''':


[[File:Doc_SDInstaller_06.png|border|500 px]]
= How to stop the Sending Service =


* If you launched the Sending Service using the <span style="color: #C00000">'''run.bat'''</span> command, you can stop it pressing the keys Ctrl+C+Y.


The '''Configuration''' menu allows you to setup your Sending Service.


The message ''Error: There are errors in your setup'' indicates that nothing has been set-up so far.
In the case you created a '''Windows Service'''  


You have to configure each field marked in red.
* Double click the <span style="color: #C00000">'''StopService NT.bat'''</span> command available at the root folder of your Sending Service


or


* Browse to the <span style="color: #C00000">'''Windows Services'''</span> console (''Start > Control Panel > Administrative Tools > Services'') and right click the '''ServiceDeposant''' service and stop the service.


If you have a '''proxy''', select ''True'' in the dropdown list and select ''More'' to type in the proxy settings.
[[File:WindowsService.png]]


''Note: The passwords will be asked during the finalization of the installation, all passwords are encrypted.''


''Note 2: You can edit each field by clickin the More button''


[[File:Doc_SDInstaller_07.png|border|600 px]]


= Automatic and semi-automatic sending of O4.1 and O4.2 reports =


<span style="color: red;>'''Changed on July 2023'''</span>


For [http://www.cssf.lu/en/supervision/ivm/ucits/legal-reporting/ '''O4.1 and O4.2 reports'''] the [http://www.cssf.lu/en/supervision/'''CSSF'''] is expecting  '''EDIFACT''' file format (ISO 9735).


Please note that you have to generate yourself a '''flat text file''' for these reports, which, once dropped into the dedicated directory of the Sending Service, will be transformed into the expected EDIFACT format.


The '''listeners''' can be activated in one shot by clicking on the button ''Listener state : Activate all''.
'''The structure of the flat file is detailed in the document [[Media:StructMess_EN.pdf|Structure of messages for interface files from fund manager host system]], pages 8 to 14.'''


''Note: This functionality will force the Sending Service to scan all the folders, if you do not want all listeners to be activated, please activate manually the listeners you need.


Please consult our [[Sending_Service#Listener_list | Listener list]] for all reporting types.


[[File:Doc_SDInstaller_08.png|border|600 px]]
The Sending Service provides two sending ways :


<u>Automatic sending</u>


In this case, the flat files must be dropped into the '''OPC\envoi_Automatique\fichiersCCLUX''' folder of your Sending Service.


You might have to type your '''CSSF/BCL''' logins for Investment Funds reporting O4.1; O4.2; O1.2.
If the flat file is well formed, the reports are '''changed to ''.T62'' for O4.1, respectively ''.T63'' for O4.2''' into the subfolder '''Edifact''' by default ([[#IdBothCasesEdifact |see how to change it]]).


[[File:Doc_SDInstaller_09.png|border|500 px]]
On sending, the ''.T6x'' is transformed into ''.trt''.
If the sending is OK, a ''.acq'' is generated otherwise a ''.err''. All this in the Edifact subdirectory.<br/>
If nothing appears in the Edifact subdirectory, it means that things are not going well.<br/>
<blockquote>You must check the Edifact subfolder for .acq or .err</blockquote>


Note : The .err that may be temporary generated within the PDF file for O4.2 reports must be ignored.


Once the configuration finished, you can click on '''Control''' to check if there is a configuration error.


The message ''No error in your setup'' means that the setup is correct.
<u>Semi-automatic sending</u>


[[File:Doc_SDInstaller_10.png|border|500 px]]
If you want to use this kind of sending, you have to drop your flat file into the '''OPC\envoi_SemiAutomatique\fichiersCCLUX_aTraiter''' folder of your Sending Service, where it will be converted to a PDF file and stored in the '''OPC\envoi_SemiAutomatique\fichiersPDF_aValider''' folder.


The PDF file allows you to check the data of your flat file in a more user friendly way before you transmit it to the supervisory authority.


Once checked/validated, the PDF file must be dragged into '''OPC\envoi_SemiAutomatique\fichiersPDF_aEnvoyer''' folder.


If there are no errors, you can click on '''Save''' to save your actual configuration.
After being checked for errors,  the reports are '''changed to ''.T62'' for O4.1, respectively ''.T63'' for O4.2''' into the subfolder '''Edifact''', <span style="color: red;>BE CAREFUL : this folder is in OPC\envoi_Automatique\fichiersCCLUX\'''Edifact''' by default.</span>([[#IdBothCasesEdifact |see how to change it]])


[[File:Doc_SDInstaller_11.png|border|500 px]]
On sending, the ''.T6x'' is transformed into ''.trt''.
If the sending is OK, a ''.acq'' is generated otherwise a ''.err''. All this in the Edifact subdirectory.<br/>
If nothing appears in the Edifact subdirectory, it means that things are not going well.<br/>
<blockquote>You must check the Edifact folder for .acq or .err</blockquote>




<div id="IdBothCasesEdifact"></div>
<u>In both cases</u>


To install the Sending Service, you have to click on the '''Install''' button.
* The reports sent are .T62, resp. .T63, you will find them into the transmission follow-up with such names. The CSSF answsers with EDOFBR....xml files as feedbacks.<br/>


A pop-up window opens where you have to enter your passwords.


''Note : If you do not use a proxy, you can leave a blank for the proxy password''
* The .ack files are not sent anymore, even for the O4.1 Fundsquare file.


[[File:Doc_SDInstaller_12.png|border|500 px]]


* The '''Edifact results subfolder''' is the same for the two ways of sending : automatic and semi-automatic. You can choose the one you want by changing the property '''''reportingOPC.automatique.edifact.remoteDir''''' into the .properties file. In the installation assistant (assistantSD), this property is under reportingOPC.automatic.state's button 'More'. <br>Then install again to enable it.


= Automating process for KID packages =


Once finished a pop-up windows opens stating that the installation has been successful:
In the context of KID updates to be filed to the CSSF, it is possible to set up the automatic sending of KIDs packages (.zip files) from our server to your Sending Service. Once the Sending Service has received the KIDs, they are copied in one of the following directory:


[[File:Doc_SDInstaller_13.png|border|500 px]]
'''Luxembourgish fund'''
\ReportingDiffusion\DOC_FIS_OPC\KID_OPC


To start your Sending Service open the folder where you installed it and run the file '''run.bat'' or '''InstallServiceNT.bat''' if you want to install the Service as a '''Windows Service'''.


'''Foreign fund'''
\ReportingDiffusion\DOC_OPC_NOT_LU\HOST_UPDATE


Then the files are sent to the CSSF in the usual way.




If you want to use this feature, please
* Install the Sending Service [[Sending Service#Installation with Sending Service Installer|'''=> Installation with Sending Service Installer''']] or [[Sending Service#Manual installation with Command Prompt|'''=>  Manual installation with Command Prompt''']]
* Ensure that the listeners <span style="color: #C00000">'''reportingOPCNONLU.state'''</span> and  <span style="color: #C00000">'''reportingKID.state''' </span> in your properties file are <span style="color: #C00000">'''=up'''</span>
* Contact our Regulatory Service department and request the installation of this specific feature.
* Generate the KID package (.zip file) in the UCITS IV Document Management application (https://www.e-file.lu). Please note that in some cases an automated process on our servers can be installed.


==Configuration==
Do not hesitate to contact our [[How to contact us|'''Client Support & Operations Desk''']] if you need further assistance.


To configure an <u>existing</u> Sending Service you have to select the folder where it is stored and click on the '''Configuration''' button.


[[File:10 SendServConf.png|border|600 px]]


The '''configuration''' of an existing Sending Service is similar to a new Sending Service.


Please refer to '''Step 4''' in the previous '''Installation''' chapter.


= Sending progress and follow up =


== Transmission following ==


Here are the default transmission followup files that are created depending on the state in the transmission workflow.


<div style="text-align: left;">
{| border="1" cellspacing="2" cellpadding="10"
|-
! scope="col" | '''File extension'''
! scope="col" | '''Description'''
|-
||<span style="color: #C00000">''' .trt'''</SPAN>
|| <u> Example </u>: file processing of '''FileName.ext'''
Once the file has been dropped into the appropriate folder, the Sending Service will start processing it and rename it as follows:


==Update==
'''FileName.ext_YYYYMMDDhhmmssmmm.'''<span style="color:#C00000">'''trt'''</SPAN>
|-
|| <span style="color: #C00000">'''.acq'''</SPAN>
|| Once the processing finished an <span style="color:#C00000">'''.acq'''</SPAN> file will be generated in the same folder by the Sending Service in order to confirm the transmission:


'''FileName.ext_YYYYMMDDhhmmssmmm.'''<span style="color:#C00000">'''acq'''</SPAN>


To update an <u> existing </u> Sending Service you have to click the ''Update'' button.
|-
||<span style="color: #C00000">'''.err'''</SPAN>
||An <span style="color: #C00000">'''.err</SPAN> file is created in case or an error:


Then click on '''Check''' in order to verify if a new version is available.
'''FileName.ext_YYYYMMDDhhmmssmmm'''<span style="color:#C00000">'''.err'''</SPAN>


[[File:Doc_SDInstaller_16.png|border|600 px]]
Please open this file and analyse the error message.


|-


|}


</div>
<br/>


If your Sending Service is up-to-date you will get the following message:
== Feedback files (Replies folder) ==


[[File:Doc_SDInstaller_17.png|border|600 px]]
For some reporting, the administration will give you more detailed feedback. In this case, those feedback will replace the corresponding ones in the previous section.


By default, <u> feedback files</u> are dropped into <span style="color:#C00000">'''Replies'''</span> sub-folders. <span style="color:#C00000">'''Replies'''</SPAN> folders are created dynamically in the initial transmission folder of the files. They only appear when feedback files, sent by the supervisory authorities, have to be stored. If the folder is deleted, it will be automatically recreated upon receipt of new feedback files.


The  name  and  location  of  the <span style="color:#C00000">'''Replies'''</SPAN> folder  may  be  configured  differently  from  the implementation  of  the  solution with  your company’s project coordinator [[Sending_Service#Configuration|=> Configuration .properties file.]]




If there is a new version of the Sending Service available the following window will appear:
<div style="text-align: left;">
{| border="1" cellspacing="2" cellpadding="10"
|-
! scope="col" | '''Autority'''
! scope="col" | '''Description'''


[[File:Doc_SDInstaller_18.png|border|600 px]]
|-
||<span style="color: #C00000">'''CSSF'''</SPAN>
||Feedback files generated and sent by the CSSF.


Please click the picture below to access the '''Naming convention for CSSF reportings''' document:


[[File:FBR CSSF.png|500 px|link=http://www.cssf.lu/fileadmin/files/Reporting_legal/transport_securisation_reporting/Convention_de_nom.pdf]]


|-
||<span style="color: #C00000">'''BCL'''</SPAN>
||Feedback files generated and sent by the BCL.


To continue the update, click on Ok.
The BCL sends feedback with the following naming convention :


FDBTECH_[OK/KO]_[YYYYMMDD]_[SENT FILE NAME]_[RANDOM CARACTERS].xml


During the first steps, the new version will be downloaded.
With
* [OK/KO] : replaced either by OK (if the files has been transmitted and processed successfully) or KO (if there has been an error)
* [YYYYMMDD] : replaced by the date of the feedback
* [SENT FILE NAME] : replaced by the complete name of the original file (including it's extension)
* [RANDOM CARACTERS] : replaced by a random and unique caracters.
|}


Once you have reached step 3, the tool will ask you to select your old '''configuration''' file ('''.properties file''')


[[File:Doc_SDInstaller_19.png|border|600 px]]


* '''For other reporting''' (08/371 / VNI...), '''there is no additionnal acknowledgment'''. <br>
This means that only <span style="color: #C00000">'''acq'''</span> will be created. <br><br>




<u>'''Conclusion'''</u> : <span style="color: #C00000">'''Checking that both trt and acq files were generated is a good way to ensure the good working of the Sending Service'''</span>. Doing this way, you can be sure that your data was correctly sent and '''e-file will be in charge of forwarding them to authoritites'''.


The tool will automatically back-up of your old Sending Service. You have to wait until the process is finished.
= Sending Service versions and updates =


[[File:Doc_SDInstaller_20.png|border|600 px]]
Please be informed that our system is able to check the version of the program you are running. This information is sent to our database when the service is launched.


Please note that the <b>''RELEASE_README.txt''</b> file, located at the root folder provides you information on the different Sending Service versions.
The example below indicates that the Sending Service version 4.5.6 is being used:
[[File:SD evol.png| 800 px]]


In case of major Sending Service changes, our [[How to contact us|'''Client Support & Operations Desk''']] will notify you by sending an INFO-email to your local e-file administrator.




Step 5 will be the '''configuration''' of the updated Sending Service. You have to click on '''Configuration''' to access the '''Configuration''' menu.


[[File:Doc_SDInstaller_21.png|border|600 px]]




= Functional testing and test environment =


In fact, it is not necessary to test the working of the Sending Service by performing a test sending.


If there are changes in the configuration file of the Sending Service with the new version, the fields will be marked in red. You will have to select the proper setup and save the changes.
Indeed, all '''technical checks''' are performed during the startup process.
 
[[File:Doc_SDInstaller_22.png|border|600 px]]
 
 
 
 
 
==Send logs==
 
If you encounter issues with your Sending Service, you can use the Help function to send an email to the Helpdesk (helpdesk@fundsquare.net).
 
The tool will create automatically a zip file containing the log files of your Sending Service you can attach to the email.<br><br>
 
[[File:Doc_SDInstaller_23.png]]
 
[[File:Doc_SDInstaller_24.png]]
 
 
 
 
 
= Manual installation of the Sending Service =
 
A '''[https://www.e-file.lu/docs/EN/ManuUtil_EFile_Maj_SD_EN.pdf simplified update guide]''', easily adaptable to a new installation is available. <br>
It describes step by step''' the manipulations to be performed to update or establish such a service.''' <br><br>
 
In addition, for more detailed information about ''' the architecture and the principle of operation''' of this tool, we invite you to consult our [https://www.e-file.lu/docs/EN/ManuUtil_EFile_Installation_SD_EN.pdf exhaustive documentation]. <br>
 
 
<span style="color: #C00000">'''You will also find further information and sufficient explanations for the proper implementation and use of the service in the following chapters.''' </span>
 
 
 
 
 
== Installing and running ==
 
The installation of the sending service is '''quick and easy'''. Simply :<br><br>
 
* '''Download''' [https://www.e-file.lu/download/SD.zip this file] and '''uncompress''' it on a server
* '''Copy your keystore''' in the 'keystore' folder of Service Deposant.
* '''Complete the properties file''' as explained in previous chapter.
* '''Install the service''' as explained at page 5 of [https://www.e-file.lu/docs/EN/ManuUtil_EFile_Maj_SD_EN.pdf update documentation].
 
<span style="background:yellow"> '''IMPORTANT:'''  </span>
 
NEW SECURITY ENHANCEMENTS as of 11th April 2017


The security settings of the Sending Service have been enhanced, and the different passwords previously written in clear text in the configuration file (‘.properties’) are now encrypted.
In other words, if the startup process does not generate any error message, then the Sending Service is running properly.


Please note that the installation procedure of the Sending Service slightly changed due to the implementation of this new feature:
* Launch the Sending Service through the dos <b>''run.bat''</b> file or through the Windows Service.
* '''Check the log files''' generated in the  <b>''log''</b> folder of Service Deposant.
* The Sending Service is running properly if the '''error.log file''' is empty or if it does not contain any line in relation to the starting process.


[[File:CMD cryp mots de passe.jpg]]
<u>'''Remark'''</u> : If a problem occurs after this check, it would certainly be a functional problem or could also be linked to the e-file configuration.
 
1. Enter the password of the e-file user (example password of the e-file user "Sending Service" (abcSD): formation)
 
2. Enter the password of your keystore
 
3. Enter the password of your proxy if you use a proxy
 
 
Once the installation is completed, it remains to you to '''create the Windows service''' by running the <b>''InstallServiceNT.bat''</b> file. The latter is automatically generated by the installation script.<br>
The service can be launched through the new service named <b>''Service Déposant''</b> or by running the <b>''StartServiceNT.bat''</b> file.<br>
<br>
<u>'''Remark'''</u> : In case of '''Unix''' installation, simply use the files with <b>''.sh''</b> extension .
 
== Version and update ==
We are able to check the version of the program you are running. This information is sent to our database when the service is launched.<br>
On your side, the <b>''RELEASE_README.txt''</b> file, located at the root folder provides you information on the latest changes.<br>
The current version is indicated by the '''first date''' of file. The example below indicates a version of Oktober 2012 18th : <br>
 
[[File:releaseRdme.jpg| left]]
<br style="clear:both;" />
<br>
In all cases, if a major change occurs and if the latter has a direct impact for you, our internal process invites us to notify you via email to your local e-file administrator.
 
 
 
 
 
= Functional testing and test environment =


In fact, there is no really use to test the working of the sending service by performing a test sending.<br>
Indeed, all '''technical checks''' are performed during the startup process.<br>
In other words, if the startup process doesn't generate any error message, then the service is running properly.<br>
<br>
* Launch the sending service through the dos <b>''run.bat''</b> file or through the Windows service.
* Wait until the end of start procedure and '''check the log files''' from <b>''log''</b> folder of Service Deposant.
* The sending service is running properly if the '''error.log file''' is empty or contains no line about starting process.
<br>
<u>'''Remark'''</u> : If a problem occurs after this check, it would certainly be a functional problem or could also be linked to the e-file configuration.<br>
In this case, we recommand to '''check the ''.err'' file''' automatically generated during the sending process.
In this case, we recommand to '''check the ''.err'' file''' automatically generated during the sending process.
<br><br><br>
In addition, you probably will be interested by '''having a test environment''' to validate the development of your source files or to anticipate a migration procedure.<br>
In this case, simply :
<br>
* '''Duplicate the production service''' by copying the whole ''Service Deposant'' folder to another location.
* '''Adjust the properties file''' to redirect the service to our test environment : Homologation. <b>''e-file.hostname''</b> = <span style="color: #C00000">'''homologation.e-file.lu'''</span><br>
Please note that, if the user login may remain the same, the password will be changed to <b>''formation''</b> for our test environment.<br>
Don't forget to '''modify the path''' to your test files if these ones are stored in a specific location. <br>
Finally, to identify cleary both Windows services, we recommand to adjust the paramaters used to declare the Windows service name : <b>''wrapper.app.long.name and wrapper.app.name''</b>
* <span style="color: #C00000">'''Relaunch the sending service installation'''</span>
= Sending progress and follow up =
The '''processing mode''' of the sending service is always the same except for '''[[Finesti Station#semiAuto|semi automatic mode]]''' described in the dedicated section of  [[Fundsquare Station|Fundsquare Station]]'''
<br><br>
As an example to process a file named ''nomFichier.ext'' :
# '''When processed, the source file is renamed with <span style="color: #C00000">.trt</span>''' extension => ''nomFichier.ext'''_YYYYMMDDhhmmssmmm.trt'''''
# In the same folder, a '''<span style="color: #C00000">.acq</span>''' file is created to '''acknowledge''' the sending --> ''nomFichier.ext'''_YYYYMMDDhhmmssmmm.acq'''''
# A <span style="color: #C00000">'''.err'''</span> file is created in case or error --> nomFichier.ext'''_YYYYMMDDhhmmssmmm.err'''.<br>
To understand the origin of the problem, we recommand to check the content of this file with a standard text editor.<br><br>
Authorithies may also send you '''feedback or acknowledgment files''' :
* '''FUNDSQUARE Reporting ''' = Ox.x + Sx.xx + TPT = '''Reception of an <span style="color: #C00000">ack</span> file''' => nomFichier.ext_'''YYYYMMDDhhmmssmmm.ack'''<br>This file completes the '''.acq''' file with only confirms the sending<br>
           
* '''CSSF Reporting'''  listed in [http://www.cssf.lu/fileadmin/files/Reporting_legal/transport_securisation_reporting/Convention_de_nom.pdf this document]''' = Reception of a '''technical feedback'''= <span style="color: #C00000">FBR</span>''' with is sometimes completed by a '''<span style="color: #C00000">FDB</span> = business feedback ''' for example in case of feebback of a signed prospectus.<br>
These feedbacks are stored in the <b>''Replies''</b> subfolder.<br>
You will find additionnal information on this process in [http://www.cssf.lu/fileadmin/files/Reporting_legal/transport_securisation_reporting/Convention_de_nom.pdf CSSF documentation]. <br>
* '''For other reporting''' (08/371 / VNI...), '''there is no additionnal acknowledgment'''. <br>
This means that only <span style="color: #C00000">'''acq'''</span> will be created. <br><br>




<u>'''Conclusion'''</u> : <span style="color: #C00000">'''Checking that both trt & acq files were generated is a good way to ensure the good working of the sending service.'''</span>. Doing this way, you can be sure that your data was correctly sent and '''e-file will be in charge of forwarding them to authoritites'''.
<br><br>


<u>'''Remark'''</u> : For each sending a procedure is created in [http://www.e-file.lu www.e-file.lu] and can be retrieved through the advanced search.<br>
If you want to install a '''test environment''' in order to validate the your source files or to anticipate a migration procedure, please follow the steps below:


* '''Duplicate the production Sending Service''' by copying the whole ''Service Deposant'' folder to another location.
* '''Adjust the properties file''' to redirect the service to our test environment : Homologation. <b>''e-file.hostname''</b> = <span style="color: #C00000">'''homologation.e-file.lu'''</span>


Please note that, if the user login may remain the same, the password will be changed in our test environment.
Feel free to set a new password


Do not forget to '''modify the path''' to your test files if these ones are stored in a specific location.


Finally, to identify cleary both Windows services, you must adjust the parameters used to identify the Windows Service name : <b>''wrapper.app.long.name''</b> and <b>''wrapper.app.name''</b>


= Automating process for KIID packages =
* <span style="color: #C00000">'''Relaunch the Sending Service installation'''</span>
 
In the context of the updates of KIIDs to the CSSF, it is possible to set up the automatic sending of KIIDs packages from our server to the Sending Service. Once the Sending Service have received the KIIDs, they are copied in one of the following directory: <br/>
'''Luxembourgish fund'''
\ReportingDiffusion\DOC_FIS_OPC\KID_OPC
'''Foreign fund'''
\ReportingDiffusion\DOC_OPC_NOT_LU\HOST_UPDATE
The files are sent to the CSSF in the usual way.
 
In order to use this feature:
* You must install a version of the Sending Service greater than the one of 18/03/2013. See [[#Installation_of_the_Sending_Service | installation of the Sending Service]]
* You have to request the feature to the ClientService (a specific parameter have to be setup): [[How_to_contact_us|contact details]]
* Finally, the package must be initiated by the UCITS IV Document Management application (https://www.e-file.lu/e-file) or in some cases by an automated process on our servers.
<br/>
 
 
 
 


= Common Problems =  
= Common Problems =  
Line 882: Line 1,339:
<br>
<br>


'''If the sending service runs properly''' through this DOS command, without generating error logs, we recommand to follow [[Sending Service#windows|this solving method]]'''.<br>
'''If the sending service runs properly''' through this DOS command, without generating error logs, we recommand to follow [[Sending Service#IdSolve|this solving method]]'''.<br>
<span style="color: #C00000">'''Otherwise, a log analysis is necessary'''</span><br><br>
<span style="color: #C00000">'''Otherwise, a log analysis is necessary'''</span><br><br>


Line 895: Line 1,352:
'''You will find below the most common known problems.'''<br>
'''You will find below the most common known problems.'''<br>
<br>
<br>
In all cases, we are at your disposal to assist you in this analysis. Feel free to <span style="color: #C00000">'''[[How to contact us|send your error log files to our SDI team]]'''.</span><br>
In all cases, we are at your disposal to assist you in this analysis. Feel free to contact our <span style="color: #C00000">'''[[How to contact us|'''Client Support & Operations Desk''']].'''</span><br>
 
 
 




Line 905: Line 1,359:
<u>'''Error 1'''</u> : <span style="color: blue">Error when webservice's call 'obtenirVersionsDocument'.Unrecognized SSL message, plaintext connection.</span><br><br>
<u>'''Error 1'''</u> : <span style="color: blue">Error when webservice's call 'obtenirVersionsDocument'.Unrecognized SSL message, plaintext connection.</span><br><br>


<u>'''Solving Method'''</u><br><br>
  <u>'''Solving Method'''</u><br>
* Check the proxy parameters of your properties file
  * Check the proxy parameters of your properties file
* '''Relaunch  the sending service installation process''' so that the changes are taken into account.<br><br>
  * '''Relaunch  the sending service installation process''' so that the changes are taken into account.


<u>'''Error 2'''</u> : <span style="color: blue">java.net.ConnectException: Connection timed out: connect.</span><br>
<u>'''Error 2'''</u> : <span style="color: blue">java.net.ConnectException: Connection timed out: connect.</span><br>
<u>'''Error 3'''</u> : <span style="color: blue">Connection timed out: connect [TIP: The machine can be unauthorized by the proxy]</span><br><br>
<u>'''Error 3'''</u> : <span style="color: blue">Connection timed out: connect [TIP: The machine can be unauthorized by the proxy]</span><br><br>


<u>'''Solving Method'''</u><br><br>
  <u>'''Solving Method'''</u><br>
* Check the configuration of your proxy with your network team.<br>
  * Check the configuration of your proxy with your network team : It must be correctly configured to allow outbound connections to our server [http://www.e-file.lu www.e-file.lu] HTTP and HTTPS.
It must be correctly configured to allow outbound connections to our server [http://www.e-file.lu www.e-file.lu] HTTP and HTTPS.
 
 
 
 


==== Other time out problem====
==== Other time out problem====


<u>'''Error'''</u> : <span style="color: blue">Startup failed: Timed out waiting for signal from JVM.</span><br><br>
<u>'''Error'''</u> : <span style="color: blue">Startup failed: Timed out waiting for signal from JVM.</span><br>
 
<u>'''Solving Method'''</u><br><br>
* '''Increase''' the value of <b>''wrapper.startup.timeout''</b> parameter from your properties file.<br>As an example, increase from 300 to 600.
* '''Relaunch the sending service installation''' to take the changes in account.
<br>
This parameters indicates the duration allocated to the service startup. Is some cases, 5 mn may not be enough, particularly with slow proxy connectionsto e-file.
 
 
<span id="windows">  </span>
 


  <u>'''Solving Method'''</u><br>
  * '''Increase''' the value of <b>''wrapper.startup.timeout''</b> parameter from your properties file. As an example, increase from 300 to 600.
  * '''Relaunch the sending service installation''' to take the changes in account.


This parameters indicates the duration allocated to the service startup. Is some cases, 5 mn may not be enough, particularly with slow proxy connections to e-file.




Line 945: Line 1,388:
Then simply change this setting this way: <br>
Then simply change this setting this way: <br>


<br>
  <div id="IdSolve"></div>
<u>'''Solving Method'''</u><br><br>
  <u>'''Solving Method'''</u><br>
 
  * Open the '''Windows services''' window. (Start > Control Panel > Administrative tools > Services)
* Open the '''Windows services''' window. (Start > Control Panel > Administrative tools > Services)
  * Right click on the service named <b>''ServiceDéposant''</b>
* Right click on the service named <b>''ServiceDéposant''</b>
  * Select the <b>''Properties''</b> item
* Select the <b>''Properties''</b> item
  * Indicate an administrator user account and password in <b>''LogOn''</b> tag.
* Indicate an administrator user account and password in <b>''LogOn''</b> tag.
  * Relaunch the service
* Relaunch the service
 
<br style="clear:both;" />
 
 
 
 


== Errors are raised during sending ==  
== Errors are raised during sending ==  
Line 969: Line 1,405:


'''You will find below the most common problems.'''<br>
'''You will find below the most common problems.'''<br>
In all cases, we are at your disposal to assist you in this analysis. Feel free to <span style="color: #C00000">'''[[How to contact us|send your error log files to our SDI team]]'''.</span><br>
In all cases, we are at your disposal to assist you in this analysis. Feel free to contact <span style="color: #C00000">'''[[How to contact us|'''Client Support & Operations Desk''']].'''</span><br>




Line 980: Line 1,416:
<u>'''Error 2'''</u> : <span style="color: blue">All error indicating a data problem</span><br><br>
<u>'''Error 2'''</u> : <span style="color: blue">All error indicating a data problem</span><br><br>


<u>'''Solving Method'''</u><br><br>
  <u>'''Solving Method'''</u><br>
* '''Correct the source file''' according to the erro messages indicated in the <b>''.err''</b> file.
  * '''Correct the source file''' according to the error messages indicated in the <b>''.err''</b> file.
* '''Resend the file'''.<br><br>
  * '''Resend the file'''.
 
==== User account problem ====
 
<u>'''Error 1'''</u> : <span style="color: blue">Getting addressees information Une erreur est survenue lors de l'execution du Workflow</span><br>


  <u>'''Solving Method'''</u><br>
  * '''Link''' the sending service user account to the right '''User Group''' according to the kind of reporting your are trying to send. His profils should be <b>''SD with response''</b>


= Certificate Update =


Once your Luxtrust certificate is activate in E-file, you need to replace de new keystore in the sending service.
Please find below what you need to do:
* Stop your sending service
* Copy your new keystore in the keystores folder of the Sending Service.
* Update the configuration: It is possible that your new Keystore has a different name than the previous Keystore therefore it is necessary to update the configuration.
  '''E-file configuration'''


  {| class="wikitable;style="background:#112233"
  |-
  ! Variable
  ! Description
  |-
  |style="width:30em"| '''''keystore.path=@PROJECT_ROOT_PATH@/keystores/????.ks'''''
  |style="width:20em"| path of the keystore (xxxx.ks)
  |-
  |}


==== User account problem ====


<u>'''Error 1'''</u> : <span style="color: blue">Getting addressees information Une erreur est survenue lors de l'execution du Workflow</span><br>
* Install the sending service: To install the Sending Service, you have to click on the '''Install''' button. A pop-up window opens where you have to enter your passwords.
 
''Note : If you do not use a proxy, you can leave a blank for the proxy password''
 
[[File:Doc_SDInstaller_12.png|border|500 px]]
 
 
 
Once finished a pop-up windows opens stating that the installation has been successful:
 
[[File:Doc_SDInstaller_13.png|border|500 px]]
 
To start your Sending Service open the folder where you installed it and run the file '''run.bat''' or '''InstallServiceNT.bat''' if you want to install the Service as a '''Windows Service'''.
 
[[Sending Service#Installation as a Windows Service|=> Installation as a Windows Service]]
 
[[Sending Service#How to start the Sending Service|=> How to start the Sending Service]]


<u>'''Solving Method'''</u><br><br>
[[Sending Service#How to stop the Sending Service|=> How to stop the Sending Service]]
* '''Link''' the sending service user account to the right '''User Group''' according to the kind of reporting your are trying to send.que vous cherchez à envoyer. His profils should be <b>''SD with response''</b>

Latest revision as of 14:20, 29 August 2024

Page's last update : 21 August 2024

Back to the Top

Home page Return homepage

Operating principle

The Sending Service is our solution for the automatic transmission of reports and documents to authorities.

This solution is useful if you have a large number of reports to submit or if the manual sending does not suit your needs.

Please be aware that, in this case you will have to provide the files yourself according to the authorities' file specifications.

This tool is compatible with most of the current operating systems (Windows / Unix / Linux) and is usually installed on a server on your side.

With a suitable network mapping, users can simply drop the file to be sent into the appropriate directory.

The file is then automatically encrypted and sent.



Prerequisites

  • Internet access
  • Java version 1.8 Note : versions 8_351 and higher need a patch to be used with our system, see :Error_messages_list#JCE_cannot_authenticate_the_provider_BC
  • If you use a proxy, authorize outgoing calls to www.e-file.lu. Port 443 (HTTPS) must be open.
  • Administrator rights to install the Sending Service on the computer (Windows Start button > Control Panel > User Accounts > Manage User Accounts).
  • OS: Windows or Linux
  • Processor: Pentium 2 GHz or equivalent
  • 8 GB of RAM
  • 1 GB of free space on hard disk drive if the files are downloaded by ftp. If files are locally stored, provide a free space of above 100 MB or a regular purges.
  • 1 GB of free space on hard disk drive for logs. Regular purges are necessary as well.
  • A Sending Service user , for example: aacSD, and its password, for example: formation, have to be available => e-file administrator.
  • The e-file account of the Sending Service user has to be linked to groups/modules, for example FATCA reporting + profile "Sending Service".
  • A valid keystore (keystore.ks) and its password must be available
  • The Sending Service user has to be properly configured in the e-file user administration tool in order to be able to receive alerts (receipt of acknowledgement and feedback files).


Note that you can find the prerequisites for the manual transmission there : Transmission_Module#System_requirements

Installation / update with Sending Service Installer

The Sending Service Installer is a tool that helps you install or configure quickly your Sending Service.

It can be downloaded from these links:

English version

French version

Once you have downloaded the application you will have to run it with Java by clicking the Run button.

Doc SDInstaller 01.png


If the message unable to run the application occurs, delete the java cache.


The front page of the Sending Service Installer opens and shows you the different functionalities you can select:

  • Install a new Sending Service
  • Configure an existing Sending Service
  • Update an existing Sending Service
  • Send logs

Doc SDInstaller 02.png



Installation

Controls before installation:

  • Check that the connected user is administrator of the computer
  • Have an e-file Sending service user (login and password) (e.g. : aacSD)

To check whether a Sending service user exists, log on as an e-file administrator. Step 2:

Click the Administration module

AdminAccess.png

The user linked to the Sending Service usually follows the bellow naming rules : three letters referring to the company (in lower case) following by "SD" in upper case. (e.g. : aacSD)

User Sending service.png 

If the user doesn't exist, please contact us.


Start installation: 

To install a  new  Sending Service, click on the button Install on the front page.


Step 1: Select the folder where you want to install your Sending Service.

Doc SDInstaller 03.png



Step 2: The Sending Service is downloaded and saved in the selected folder.



Step 3: Select the keystore file, containing your LuxTrust certificate.

Doc SDInstaller 04.png



Step 4: The Sending Service is ready to be configured. By clicking the Configuration button, you will be redirected to the Configuration menu of the .properties file.

Doc SDInstaller 05.png

Configuration

To configure an existing Sending Service you have to select the folder where it is stored and click on the Configuration button.

10 SendServConf.png

The configuration of an existing Sending Service is similar to a new Sending Service.


IMPORTANT: each time you make changes to the properties (configuration) file, you have to stop the Sending Service before, make your changes and then install the Sending Service again.


Configuration menu of the .properties file ( => Help: Configuration of the properties file):

Doc SDInstaller 06.png


The Configuration menu allows you to setup your Sending Service.

The message Error: There are errors in your setup indicates that nothing has been set-up so far.

You have to configure each field marked in red.


If you have a proxy, select True in the dropdown list and select More to type in the proxy settings.

Note: The passwords will be asked during the finalization of the installation, all passwords are encrypted.

Note 2: You can edit each field by clicking the More button

Doc SDInstaller 07.png



The listeners can be activated in one shot by clicking on the button Listener state : Activate all.

Note: This functionality will force the Sending Service to scan all the folders, if you do not want all listeners to be activated, please activate manually the listeners you need.

Please consult our Listener list.


Doc SDInstaller 08.png


If you have to submit Investment Funds reporting O4.1; O4.2 (EDIFACT format), you must complete this fields :

domain.descr: Not relevant. You can provide abbreviated name of the Central Administration.

domain.env.ac.id.bcl: this code is composed of a letter and six digits and has been provided to you by the CSSF (Example: P123, should be written as “P000123”).

domain.env.ac.id.cssf: this code is composed of a letter and six digits and has been provided to you by the CSSF (Example P123, should be written as “P000123”).

The two others will be asked when installing (domain.en.ac.cd_auth and domain.env.ac.pwd)


Doc SDInstaller 09.png



Once the configuration finished, you can click on Control to check if there is a configuration error.

The message No error in your setup means that the setup is correct.

Doc SDInstaller 10.png


If there are no errors, you can click on Save to save your actual configuration.

Doc SDInstaller 11.png


To install the Sending Service, you have to click on the Install button.


A pop-up window opens where you have to enter your passwords.

If you do not use a proxy, you can leave a blank for the proxy password
If you need to send O4.1 or O4.2 reports enter also those :
CA Password = domain.env.ac.pwd: this authentication password has been provided to you by the CSSF (postal mail).
CA Code = domain.en.ac.cd_auth: this authentication code has been provided to you by the CSSF (postal mail).

Doc SDInstaller 12.png


Once finished a pop-up windows opens stating that the installation has been successful:

Doc SDInstaller 13.png

To start your Sending Service open the folder where you installed it and run the file run.bat or InstallServiceNT.bat if you want to install the Service as a Windows Service.

=> Installation as a Windows Service

=> How to start the Sending Service

=> How to stop the Sending Service

Update

IMPORTANT: before updating your Sending Service you have to stop the Sending Service.

To update an existing Sending Service you have to click the Update button.

Then click on Check in order to verify if a new version is available.

Doc SDInstaller 16.png



If your Sending Service is up-to-date you will get the following message:

Doc SDInstaller 17.png



If there is a new version of the Sending Service available the following window will appear:

Doc SDInstaller 18.png



To continue the update, click on Ok.


During the first steps, the new version will be downloaded.

Once you have reached step 3, the tool will ask you to select your old configuration file (.properties file)

Doc SDInstaller 19.png



The tool will automatically back-up of your old Sending Service. You have to wait until the process is finished.

Doc SDInstaller 20.png



Step 5 will be the configuration of the updated Sending Service. You have to click on Configuration to access the Configuration menu.

Doc SDInstaller 21.png



If there are changes in the configuration file of the Sending Service with the new version, the fields will be marked in red. You will have to select the proper setup and save the changes.

Doc SDInstaller 22.png

Once the configuration finished, you can click on Control to check if there is a configuration error.

The message No error in your setup means that the setup is correct.

Doc SDInstaller 10.png


If there are no errors, you can click on Save to save your actual configuration.

Doc SDInstaller 11.png


To install the Sending Service, you have to click on the Install button.

A pop-up window opens where you have to enter your passwords.

Note : If you do not use a proxy, you can leave a blank for the proxy password

Doc SDInstaller 12.png

Send logs

If you encounter issues with your Sending Service, you can use the Help function to send an email to the Client Support & Operations Desk.

The tool will create automatically a zip file containing the log files of your Sending Service you can attach to the email.

Doc SDInstaller 23.png

Doc SDInstaller 24.png

Manual installation with Command Prompt

  • Extract and copy the entire content of the directory ServiceDeposant in the Sending Service directory. Ensure that the directory is not read only .

SD.png

  • Copy your keystore in the keystores folder of the Sending Service.
  • Copy the template_configInstall.properties file and rename it [senderName].properties.
  • Install the new Sending Service:
(-) Open Command Prompt
(-) Move to the root folder of your new Sending Service (for example: C:\Program Files\e-file\ServiceDeposant\)
(-) install.bat [senderName].properties 
(-) enter the root path of your JRE (for example: C:\Program Files\Java\jre1.8) 
(-) Enter the password of the e-file Sending Service user 
(-) Enter the password of your keystore 
(-) Enter the password of your proxy if you use a proxy
(-) Enter the O4.x password for CSSF/BCL if needed
(-) Enter the O4.x authentication code for CSSF/BCL if needed
(-) Press the ENTER key

IMPORTANT:

SECURITY ENHANCEMENTS (june 2023)

The security settings of the Sending Service have been enhanced for O4.1 and O4.2 reports, the related passwords are now encrypted.

Please note that the installation procedure of the Sending Service slightly changed due to the implementation of this feature:

SD CmdInstall.png


At the end of the script you must get the following message: BUILD SUCCESSFUL indicating that the installation was successful.

SD CmdInstall success.png


IMPORTANT: each time you make changes to the properties (configuration) file, you have to stop the Sending Service before, make your changes and then install the Sending Service again.


Configuration of the properties file

The .properties file (template_configInstall.properties) contains important information which are necessary to generate your configuration files during the physical installation.

The latter are used to start and use the Sending Service.

In other words :

  • The .properties file contains all the variables needed to run the Service Service.
  • Any modification of the .properties file must be followed by an installation of the Sending Service to be really applied.


Please find below important information on how to configure your .properties file.

Please note, that at the end of setup, no '?' should remain in this file.



E-file configuration

Variable Description
efile.hostname=???? www.e-file.lu for production environment,
or
homologation.e-file.lu for test environment.
efile.userId.Login=???? e-file login of the Sending Service user (Example: abcSD)
keystore.path=@PROJECT_ROOT_PATH@/keystores/????.ks path of the keystore (xxxx.ks)
lang.code=FR??EN language of the acknowledgement files



Proxy configuration

Variable Description
proxy.required=false??true true if a proxy is used to access the internet through HTTP or HTTPS.
proxy.host=????
proxy.port=????
proxy.user=????
proxy.domainNTLM=???? 		Complete all other parameters according your network infrastructure.



Configuration of connection for authority acknowledgement / feedback files

Variable Description
reportingXXXXXX.state=up??down All subsequent blocks in the .properties file corespond to a particular type of reporting.

Please consult our Listener list to verify which reporting type is linked to which listener.

Example: if you only have to sent FATCA reportings, the state of the listener reportingFATCA.state has to be up: reportingFATCA.state=up

The other listeners should be down.

reportingXXXXXX.remoteDir Path to file location for the relevant reporting.
@PROJECT_ROOT_PATH@ Dynamic parameter indicating the Sending Service installation path.

To change if you want to locate the user working directory elsewhere on the server or another machine. In this case, indicate the full path to file (separator = '/').

reportingXXXXXX.scheduleTime'' Execution frequency of Window Service to process files from this folder (30mn by default).

Feel free to reduce this value, but do not fall below 5mn= 300000.

reportingXXXXXX.deeplevel'' Number of sub-levels to scan.

By default the value is 0, which means that only files at the root of the folder will be taken in account.



Business environment properties

Variable Description
domain.descr Not relevant. You can provide abbreviated name of the Central Administration.
domain.env.ac.id.cssf Your CSSF identifier of 7 characters, 1 letter and 6 numbers
domain.env.ac.id.bcl Your BCL identifier
domain.env.ac.pwd Doesn't appear anymore in the .properties, it will be asked when installing. Password of the Central Administration provided by the CSSF
domain.env.ac.cd_auth Doesn't appear anymore in the .properties, it will be asked when installing. Authentication code of the Central Administration provided by the CSSF.

The CSSF has provided you in an official letter your password and authentication code. The above mentioned IDs, passwords and codes are necessary for the successful processing of the O4.1, O4.2; O1.2 and the former O1.1 reporting.



Configuration of monitoring

Variable Description
mon.app.heartbeat=false If parameter is "true", we will be able to send you an alert if an interruption of your service is detected on our side (within 72 hours).

Should you want to use this feature feel free to contact us

mon.app.origin=???? Unique name , without space, to enable us to identify your Sending Service. Not mandatory.
mon.task.dist.period=60000 Frequency of the heartbeat (here 60000 milliseconds, 1 min). The monitoring window is set to 9 minutes. At least one heartbeat must have been registered during this interval otherwise the Sending Service is considered as down.

Listener list

Listener Sending Service folder Reporting type Business group Internal
Technical
Business ID
Please be informed that the listener efile.listener.state is no longer available in the properties file - - - -
Please be informed that the listener efile.replies.listener.state is no longer available in the properties file - - - -
reportingMMF=up (-) ReportingDiffusion/MMF CSSF - MMF Money Market Fund Reporting 83-Money Market Fund Reporting
reportingOPC.automatique.state=up (-) ReportingDiffusion/OPC/envoi_Automatique/fichiersCCLUX
(-) ReportingDiffusion/OPC/envoi_Automatique/fichiersCCLUX/Enrichment
(-) ReportingDiffusion/OPC/envoi_Automatique/TPT_FINESTI 		CSSF - Investment Funds: O4.1, O4.2, O1.2, U1.1
BCL : S1.3, S1.6, S2.13, TPTOBS 		Station Finesti 8-Transmission of UCI regulatory reports
reportingOPCExportXLS.automatique.state=up ReportingDiffusion/OPC/envoi_Automatique/ExportXLS CSSF - Investment Funds: O4.1, O4.2, O1.2, U1.1
BCL : S1.3, S1.6, S2.13, TPTOBS 		Station Finesti 8-Transmission of UCI regulatory reports
reportingOPC.envoi_Historique.state=up ReportingDiffusion/OPC/envoi_Historique/fichiersCCLUX CSSF - Investment Funds: O4.1, O4.2, O1.2, U1.1
BCL: S1.3, S1.6, S2.13, TPTOBS 		Station Finesti 8-Transmission of UCI regulatory reports
reportingOPC.semiAuto.state=up n/a n/a n/a n/a
reportingVni.state=up ReportingDiffusion/VNI tbd tbd tbd
reportingDividende.state=up ReportingDiffusion/Dividendes tbd tbd tbd
reportingTAF.state=up (-) ReportingDiffusion/TAF

(-) OBSOLETE: ReportingDiffusion/TAF/declaration_Transaction
(-) OBSOLETE: ReportingDiffusion/TAF/annulation_Transaction
(-) OBSOLETE: ReportingDiffusion/TAF/annulation_Rapport

CSSF: transactions in financial instruments (TAF) Report TAF-MIFID 71-MiFIR reporting
reportingTAF.state=up (-) ReportingDiffusion/TAF

(-) OBSOLETE: ReportingDiffusion/TAF/declaration_Transaction
(-) OBSOLETE: ReportingDiffusion/TAF/annulation_Transaction
(-) OBSOLETE: ReportingDiffusion/TAF/annulation_Rapport

CSSF: transactions in financial instruments (TAF) Report TAF-MIFID 71-MiFIR reporting
reportingIORP.state=up ReportingDiffusion/IORP CSSF - Annual and quarterly reporting according to Circular CSSF 19/726 of 26 July 2019 Report IORP 80
reportingCOREP.state=up ReportingDiffusion/COREP CSSF:
SCOREP; SLAREX; SLCRXX; SNSFRX; SALMXX; CCOREP;
CLAREX; LCRXX; CNSFRX; CALMXX; CFINRP; SFINRP;
AEXXX; SAEXXX; CFPXXX; SFPXXX; CSBPXX;
SSBPXX; CSBPIM; SSBPIM; CLCRDA; SLCRDA; ALMXXX 		Rapport COREP 72-COREP reporting
reportingFINREP.state=up ReportingDiffusion/FINREP CSSF: B2.4; B2.5; LCRDAX Rapport FINREP 73-FINREP reporting
reportingFINREP.EDIFACT.state=up ReportingDiffusion/FINREP/EDIFACT_CSSF CSSF: B4.4 Reporting EDIFACT 16-Edifact
reportingBOP.state=up ReportingDiffusion/BOP BCL - Credit institutions: Balance of payments (BOP1.1; BOP1.2) Balance des Paiements 12-Edifact reporting
reportingBCLStat.state=up ReportingDiffusion/BCL_Statistics BCL - Credit institutions: S0.1; S1.1; S1.4; S1.5; S1.8; S1.9;S1.12
S2.5-L; S2.5-N; S2.8; S2.9-L; S2.9-N; S3.2 		Statistiques BCL 13-BCL statistics
reportingAnacredit.state=up ReportingDiffusion/Anacredit ANTREF; ANTT1M; ANTT2M; ANTT2Q Rapport Anacredit 74 ANACREDIT reporting
reportingSecurisation.state=up ReportingDiffusion/Securisation BCL - Securitation vehicles: S2.14; S2.15; TPTTBS Véhicule titrisation 23-Véhicule titrisation
reportingSecurisationS2.14ExportXLS.state=up
reportingSecurisationS2.15ExportXLS.state=up
reportingSecurisationTPTTBSExportXLS.state=up 		ReportingDiffusion/Securisation/ExportXLS BCL - Securitation vehicles:S2.14; S2.15; TPTTBS Véhicule titrisation 23-Securitisation vehicule
reportingTPTB.state=up ReportingDiffusion/TPT BCL - Credit institutions: TPTBBL; TPTBBN; TPTBHR; TPTBHN Titre par Titre Bancaire 20-Security by security reporting
reportingTPTBExportXLS.state=up ReportingDiffusion/TPT/ExportXLS BCL - Credit institutions: TPTBBL; TPTBBN; TPTBHR; TPTBHN Titre par Titre Bancaire 20-Security by security reporting
reportingESP.state=up ReportingDiffusion/ESP CSSF: Special Enquiries (ESPREP) Rapport Enquête 15-CSSF polls
reportingPSF.state=up ReportingDiffusion/PSF CSSF - Professional of the financial sector (PSFREP) Rapport PSF 18-PSF reporting
reportingSICAR.state=up ReportingDiffusion/SICAR CSSF - SICAR Rapport SICAR 17-SICAR reporting
reportingOTH.state=up ReportingDiffusion/OTH CSSF - Other reporting (OTHREP) Reporting OTHER (CSSF) 19-OTHER reporting (CSSF)
reportingRFOPC.state=up ReportingDiffusion/DOC_FIS_OPC/REPORT_OPC CSSF UCI:
(-) Annual Report (AR)
(-) Semi-annual report (SR)
(-) Letter of explanation (LE)
(-) Other periodic report(RO)
(-) Movements in the securities portfolios (MP) 		Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423


reportingRAFIS.state=up ReportingDiffusion/DOC_FIS_OPC/REPORT_FIS CSSF SIF:

(-) Annual Report (AR)
(-) Semi-annual report (SR)
(-) Letter of explanation (LE)
(-) Other periodic report (RO)
(-) Movements in the securities portfolios (PM) 

 SICAR:

(-) Annual Report (AR)
(-) Annual Report (RO)

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingPOPC.state=up ReportingDiffusion/DOC_FIS_OPC/PROSP_OPC CSSF UCI:
(-) Prospectus (PC)
(-) Simplified prospectus (PS)
(-) Letter of explanation (LE) 		Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingPFIS.state=up ReportingDiffusion/DOC_FIS_OPC/PROSP_FIS CSSF SIF:
(-) Prospectus (PC)
(-) Offering document (DE)
(-) Letter of explanation (LE) 		Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingKID.state=up ReportingDiffusion/DOC_FIS_OPC/KID_OPC Key Investor Information Document (KID)

(-) O: OPC Law 2010 and Law 2007
(-) K: SICAR
(-) V: non-reglem.
=> Automated process for KID packages

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingMR.state=up ReportingDiffusion/DOC_FIS_OPC/MGMT_REGUL CSSF - Management Regulations of UCITS (MR) Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingAI.state=up ReportingDiffusion/DOC_FIS_OPC/ART_INCORP CSSF - Articles of Incorporation of UCITS (AI) Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingML.state=up ReportingDiffusion/DOC_FIS_OPC/MGMT_LETTER CSSF - Management Letters (ML)

(-) O: OPC Law 2010 and Law 2007
(-) K: SICAR
(-) V: non-reglem.

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingLF.state=up ReportingDiffusion/DOC_FIS_OPC/LONG_FORM CSSF - Long Form reports (LF)

(-) O: OPC Law 2010

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingMLGFI.state=up ReportingDiffusion/DOC_FIS_OPC/MGMT_GFI CSSF

CSSF-Management Letter of Investment Fund Managers (IFM EN)
Gestionnaires des fonds d'investissement (GFI FR)

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingRGFI.state=up ReportingDiffusion/DOC_FIS_OPC/REPORT_GFI CSSF

Annual management company report
Management company report, other frequency
Explanation letter

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingDOC_OTH.state=up ReportingDiffusion/DOC_FIS_OPC/OTHER CSSF

Auditor's report (RR)
Explanation letter (LE) (for funds or Sicar, CSSF codification S or A)
Report Hong Kong Securities and Futures (HK)

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingCSDR.state=up ReportingDiffusion/CSDR CSSF

Report CSDR

Reporting CSDR-9 78-Reporting CSDR
reportingGFI.state=up ReportingDiffusion/DOC_FIS_OPC/DOC_GFI CSSF

CSSF-Management Letter of Investment Fund Managers (IFM EN)
Gestionnaires des fonds d'investissement (GFI FR)

(-) Risk management function(GR)
(-) OPCVM instruments information (ID)
(-) Compliance Function (FC)
(-) Internal audit function report (IA)
(-) Complaints handling (TP)
(-) Authorized third party complaints (LP)
(-) Risk Management Procedure (PG)
(-) Organization chart (OG)
(-) Mandates table (TM)
(-) Delegates of RFI (RD)
(-) Branch activity (AS),
(-) Own funds ratio (FP)
(-) Risk management procedure AIFM (PN)

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingAML-AIFM-REG.state=up ReportingDiffusion/DOC_FIS_OPC/AML_AIFM_REG CSSF

CSSF-Management Letter of Investment Fund Managers (IFM EN)
Gestionnaires des fonds d'investissement (GFI FR)

(-) Letter of explanation (LE)

Doc OPC et FIS (circ. CSSF) 21-Métier des circulaires CSSF 08/371 et 09/423
reportingCD.state=up ReportingDiffusion/Various_Correspondence BCL - Other reporting (OTX) Reporting OTHER (BCL) 22-Various correspondence (OTH=> BCL)
reportingSGO.state=up ReportingDiffusion/SGO CSSF - Management company reporting (SGOREP) Rapport Société de Gestion 26-Management company
reportingDOCBNK.state=up ReportingDiffusion/DOC_BNK AR: Annual Report

AS: Annual report consolidated
CO: Compliance Report
GR: Governance Report
IA: Internal Audit Report
IC: ICAAP
ID: ICAAP Consolidated
LF: Long Form Report
LC: Long Form consolidated
LD: Long form branch or specific participation
ML: ManagementLetter
MC: Management letter consolidated
RC: Risk Control Report
RP: Recovery Plan
SC: Single Customer View
LG: Reconciliation LuxGAAP FINREP
RR: Results distribution
BD: AC member list
IL: ILAAP
IM: ILAAP consolidated
AC: Audit report on AML/CTF
MF: Audit report on rules of conduct
MM: Head quarter annual report
RE: Report on out-of-court complaint resolution
TR: Table on out-of-court complaint resolution
AD: Circ. 18/697 annexe1

Reporting des établissements de crédit 27-Reporting of credit institutions
reportingEDP.state=up ReportingDiffusion/EDP CSSF - Payment instituions (EDPREP): Z1.1; Z1.2; Z1.4; Z2.1 Reporting EDP 29-Periodic reporting scheme for payment instituions (EDP)
reportingEME.state=up ReportingDiffusion/EME CSSF - Electronic money instituions (EMEREP): W1.1; W1.2; W1.3; W1.4; W2.1 Reporting EDP 34-Electronic money reporting (EME)
reportingPubDiffu.state=up ReportingDiffusion/DOC_FIS_OPC/PUB_FINESTI
ReportingDiffusion/DOC_OPC_NOT_LU/PUB_FINESTI 		tbd tbd 32-Envoi pour publication/diffusion
33-Envoi pour publication/diffusion OPC non LU
reportingOPCNONLU.state=up ReportingDiffusion/DOC_OPC_NOT_LU/LOCAL_REGISTRATION
ReportingDiffusion/DOC_OPC_NOT_LU/LOCAL_NOTIFICATION 		HOST_UPDATE: Automated process for KID packages tbd 30-Enregistrement pour OPC non LU
31-Notification pour OPC non LU
reportingMAJDOCLU.state=up ReportingDiffusion/DOC_FIS_OPC/HOST_UPDATE tbd tbd 37-Enregistrement/Mise à jour de documents Fond LU vers pays HOST
reportingSE.state=up ReportingDiffusion/SE BCL - Financial companies: S2.16; S2.17; TPTIBS Reporting des sociétés émettrices 35-Issuing companies reporting
reportingSEExportXLS.state=up ReportingDiffusion/SE/ExportXLS BCL - Financial companies: S2.16; S2.17; TPTIBS Reporting des sociétés émettrices 35-Issuing companies reporting
reportingSETransfoXLS.state=up ReportingDiffusion/SE BCL - Financial companies: S2.16; S2.17; TPTIBS Reporting des sociétés émettrices 35-Issuing companies reporting
reportingASS.state=up ReportingDiffusion/ASS BCL - Insurance companies: S0218-L; S0219-L; S0403-L; TPTASS Reporting BCL pour les assurances 63-Reporting BCL pour les assurances
reportingASSExportXLS.state=up ReportingDiffusion/ASS/ExportXLS BCL - Insurance companies: S0218-L; S0219-L; S0403-L; TPTASS Reporting BCL pour les assurances 63-BCL report for insurances
reportingASSTransfoXLS.state=up ReportingDiffusion/ASS BCL - Insurance companies: S0218-L; S0219-L; S0403-L; TPTASS Reporting BCL pour les assurances 63-BCL report for insurances
reportingDP.state=up ReportingDiffusion/CDP BCL - Data on payment operation: V 1.1 - V 1.14 Collecte des données de paiement (CDP) 36-Data on payment instruments and operations
reportingNotifUcitsIV.state=up ReportingDiffusion/DOC_FIS_OPC/NOTIFICATIONS_UCITSIV tbd tbd 28-UCITS IV notification
reportingFINESTI.state=up
reportingLIBFINLU.state=up 		ReportingDiffusion/DOC_FIS_OPC/LIBRARY_FINESTI tbd tbd tbd
reportingLIBFINNOTLU.state=up ReportingDiffusion/DOC_OPC_NOT_LU/LIBRARY_FINESTI tbd tbd tbd
OBSOLETE : reportingCRF.state=up n/a n/a n/a n/a
OBSOLETE : reportingCRFEncrypted.state=up n/a n/a n/a n/a
reportingAIF.state=up ReportingDiffusion/AIF CSSF - Alternative Investment Fund managers: AIF / AIFM (-) AIF
(-) AMfine 		54-AIFMD reporting
reportingFATCA.state=up ReportingDiffusion/FATCA ACD - Financial Institutions - Foreign Account Tax Compliance Act (FATCA) Rapport FATCA 60-FATCA reporting
reportingCAA.state=up ReportingDiffusion/CAA (-) CAA - Rapports narratifs (N01-N10
(-) CAA - XBRL reports Solvency II (S01-S23)
reportingCRS.state=up ReportingDiffusion/CRS ACD - Financial Institutions - Common Reporting Standard (CRS) Reporting CRS 68-CRS reporting
reportingGRP_BNK.state=up ReportingDiffusion/GRP_BNK «SHS-Group» report BCL SHS report 75-SHS Reporting
reportingUCIAR.state=up ReportingDiffusion/UCIAR CSSF UCIAR UCIAR Reporting 86-UCIAR Reporting

Installation as a Windows Service

Once the installation the Sending Service is completed, the InstallServiceNT.bat file is available and you can complete your Sending Service installation by creating the Windows Service ServiceDeposant.

Execution frequency of Window Service ServiceDeposant to process files from this folder is 30mn by default => Configuration of the properties file.


Double click the InstallServiceNT.bat file.

InstallServiceNT.png


A Command Prompt window opens up and closes as quickly as it popped up. The new Windows Service ServiceDeposant is now available.

=> How to start the Sending Service

=> How to stop the Sending Service

WindowsService.png


IMPORTANT: Please ensure the Sending Service user that is linked to this Windows Service has Internet rights (=> Right click on Service deposant > select Properties > select Log On tab).


If you want to uninstall the Windows Service, please double click the UninstallServiceNT.bat file.



Installation on Unix/Linux

  • Move to the ServiceDeposant directory

Example : /opt/ServiceDeposant/


  • Check that you have execution rights (x) on the Install.sh file

Example : ls -l


  • If not, just add this right using the chmod command

Example : chmod 755 install.sh


  • Launch Install.sh with the configuration file as parameter

Example : install.sh config.properties

  • Press the Enter key and enter the Java path when requested
  • Press the Enter key again and wait for the ‘BUILD SUCCESSFUL’ message.


  • Once installed, launch the run.sh to run the sending service

How to start the Sending Service

  • Double click the run.bat command available at the root folder of your Sending Service


In the case you created a Windows Service

  • Double click the StartService NT.bat command available at the root folder of your Sending Service

or

  • Browse to the Windows Services console (Start > Control Panel > Administrative Tools > Services) and right click the ServiceDeposant service and start the service.

WindowsService.png


The message *Fin Ok* means that the installation was successful.



How to stop the Sending Service

  • If you launched the Sending Service using the run.bat command, you can stop it pressing the keys Ctrl+C+Y.


In the case you created a Windows Service

  • Double click the StopService NT.bat command available at the root folder of your Sending Service

or

  • Browse to the Windows Services console (Start > Control Panel > Administrative Tools > Services) and right click the ServiceDeposant service and stop the service.

WindowsService.png



Automatic and semi-automatic sending of O4.1 and O4.2 reports

Changed on July 2023

For O4.1 and O4.2 reports the CSSF is expecting EDIFACT file format (ISO 9735).

Please note that you have to generate yourself a flat text file for these reports, which, once dropped into the dedicated directory of the Sending Service, will be transformed into the expected EDIFACT format.

The structure of the flat file is detailed in the document Structure of messages for interface files from fund manager host system, pages 8 to 14.


The Sending Service provides two sending ways :

Automatic sending

In this case, the flat files must be dropped into the OPC\envoi_Automatique\fichiersCCLUX folder of your Sending Service.

If the flat file is well formed, the reports are changed to .T62 for O4.1, respectively .T63 for O4.2 into the subfolder Edifact by default (see how to change it).

On sending, the .T6x is transformed into .trt. If the sending is OK, a .acq is generated otherwise a .err. All this in the Edifact subdirectory.
If nothing appears in the Edifact subdirectory, it means that things are not going well.

You must check the Edifact subfolder for .acq or .err

Note : The .err that may be temporary generated within the PDF file for O4.2 reports must be ignored.


Semi-automatic sending

If you want to use this kind of sending, you have to drop your flat file into the OPC\envoi_SemiAutomatique\fichiersCCLUX_aTraiter folder of your Sending Service, where it will be converted to a PDF file and stored in the OPC\envoi_SemiAutomatique\fichiersPDF_aValider folder.

The PDF file allows you to check the data of your flat file in a more user friendly way before you transmit it to the supervisory authority.

Once checked/validated, the PDF file must be dragged into OPC\envoi_SemiAutomatique\fichiersPDF_aEnvoyer folder.

After being checked for errors, the reports are changed to .T62 for O4.1, respectively .T63 for O4.2 into the subfolder Edifact, BE CAREFUL : this folder is in OPC\envoi_Automatique\fichiersCCLUX\Edifact by default.(see how to change it)

On sending, the .T6x is transformed into .trt. If the sending is OK, a .acq is generated otherwise a .err. All this in the Edifact subdirectory.
If nothing appears in the Edifact subdirectory, it means that things are not going well.

You must check the Edifact folder for .acq or .err


In both cases

  • The reports sent are .T62, resp. .T63, you will find them into the transmission follow-up with such names. The CSSF answsers with EDOFBR....xml files as feedbacks.


  • The .ack files are not sent anymore, even for the O4.1 Fundsquare file.


  • The Edifact results subfolder is the same for the two ways of sending : automatic and semi-automatic. You can choose the one you want by changing the property reportingOPC.automatique.edifact.remoteDir into the .properties file. In the installation assistant (assistantSD), this property is under reportingOPC.automatic.state's button 'More'.
    Then install again to enable it.

Automating process for KID packages

In the context of KID updates to be filed to the CSSF, it is possible to set up the automatic sending of KIDs packages (.zip files) from our server to your Sending Service. Once the Sending Service has received the KIDs, they are copied in one of the following directory:

Luxembourgish fund 

\ReportingDiffusion\DOC_FIS_OPC\KID_OPC


Foreign fund 

\ReportingDiffusion\DOC_OPC_NOT_LU\HOST_UPDATE

Then the files are sent to the CSSF in the usual way.


If you want to use this feature, please

Do not hesitate to contact our Client Support & Operations Desk if you need further assistance.



Sending progress and follow up

Transmission following

Here are the default transmission followup files that are created depending on the state in the transmission workflow.

File extension Description
.trt Example : file processing of FileName.ext

Once the file has been dropped into the appropriate folder, the Sending Service will start processing it and rename it as follows:

FileName.ext_YYYYMMDDhhmmssmmm.trt

.acq Once the processing finished an .acq file will be generated in the same folder by the Sending Service in order to confirm the transmission:

FileName.ext_YYYYMMDDhhmmssmmm.acq

.err An .err file is created in case or an error:

FileName.ext_YYYYMMDDhhmmssmmm.err

Please open this file and analyse the error message.


Feedback files (Replies folder)

For some reporting, the administration will give you more detailed feedback. In this case, those feedback will replace the corresponding ones in the previous section.

By default, feedback files are dropped into Replies sub-folders. Replies folders are created dynamically in the initial transmission folder of the files. They only appear when feedback files, sent by the supervisory authorities, have to be stored. If the folder is deleted, it will be automatically recreated upon receipt of new feedback files.

The name and location of the Replies folder may be configured differently from the implementation of the solution with your company’s project coordinator => Configuration .properties file.


Autority Description
CSSF Feedback files generated and sent by the CSSF.

Please click the picture below to access the Naming convention for CSSF reportings document:

FBR CSSF.png

BCL Feedback files generated and sent by the BCL.

The BCL sends feedback with the following naming convention :

FDBTECH_[OK/KO]_[YYYYMMDD]_[SENT FILE NAME]_[RANDOM CARACTERS].xml

With

  • [OK/KO] : replaced either by OK (if the files has been transmitted and processed successfully) or KO (if there has been an error)
  • [YYYYMMDD] : replaced by the date of the feedback
  • [SENT FILE NAME] : replaced by the complete name of the original file (including it's extension)
  • [RANDOM CARACTERS] : replaced by a random and unique caracters.


  • For other reporting (08/371 / VNI...), there is no additionnal acknowledgment.

This means that only acq will be created.


Conclusion : Checking that both trt and acq files were generated is a good way to ensure the good working of the Sending Service. Doing this way, you can be sure that your data was correctly sent and e-file will be in charge of forwarding them to authoritites.

Sending Service versions and updates

Please be informed that our system is able to check the version of the program you are running. This information is sent to our database when the service is launched.

Please note that the RELEASE_README.txt file, located at the root folder provides you information on the different Sending Service versions. The example below indicates that the Sending Service version 4.5.6 is being used: SD evol.png

In case of major Sending Service changes, our Client Support & Operations Desk will notify you by sending an INFO-email to your local e-file administrator.



Functional testing and test environment

In fact, it is not necessary to test the working of the Sending Service by performing a test sending.

Indeed, all technical checks are performed during the startup process.

In other words, if the startup process does not generate any error message, then the Sending Service is running properly.

  • Launch the Sending Service through the dos run.bat file or through the Windows Service.
  • Check the log files generated in the log folder of Service Deposant.
  • The Sending Service is running properly if the error.log file is empty or if it does not contain any line in relation to the starting process.

Remark : If a problem occurs after this check, it would certainly be a functional problem or could also be linked to the e-file configuration.

In this case, we recommand to check the .err file automatically generated during the sending process.


If you want to install a test environment in order to validate the your source files or to anticipate a migration procedure, please follow the steps below:

  • Duplicate the production Sending Service by copying the whole Service Deposant folder to another location.
  • Adjust the properties file to redirect the service to our test environment : Homologation. e-file.hostname = homologation.e-file.lu

Please note that, if the user login may remain the same, the password will be changed in our test environment. Feel free to set a new password

Do not forget to modify the path to your test files if these ones are stored in a specific location.

Finally, to identify cleary both Windows services, you must adjust the parameters used to identify the Windows Service name : wrapper.app.long.name and wrapper.app.name

  • Relaunch the Sending Service installation

Common Problems

The service does not start

Please refer to following procedure if a Sending Service, launched through the Windows Services does not start in order to analyze the origin of the problem.



Attempt to start it with the DOS command line

  • Open a DOS window and make sure to have administrator rights on the computer (Start>run : cmd)
  • Move to the folder where the sending service is installed
  • Run the command : run.bat


If the sending service runs properly through this DOS command, without generating error logs, we recommand to follow this solving method.
 Otherwise, a log analysis is necessary



Log Analysis

The error.log file located in the log folder at the root of Sending Service, contains the error trace causing this dysfunction.

You will find below the most common known problems.

In all cases, we are at your disposal to assist you in this analysis. Feel free to contact our Client Support & Operations Desk.


Network Problem

Error 1 : Error when webservice's call 'obtenirVersionsDocument'.Unrecognized SSL message, plaintext connection.

  Solving Method

  * Check the proxy parameters of your properties file
  * Relaunch  the sending service installation process so that the changes are taken into account.

Error 2 : java.net.ConnectException: Connection timed out: connect.
Error 3 : Connection timed out: connect [TIP: The machine can be unauthorized by the proxy]

  Solving Method

  * Check the configuration of your proxy with your network team : It must be correctly configured to allow outbound connections to our server www.e-file.lu HTTP and HTTPS.

Other time out problem

Error : Startup failed: Timed out waiting for signal from JVM.

  Solving Method

  * Increase the value of wrapper.startup.timeout parameter from your properties file. As an example, increase from 300 to 600.
  * Relaunch the sending service installation to take the changes in account.

This parameters indicates the duration allocated to the service startup. Is some cases, 5 mn may not be enough, particularly with slow proxy connections to e-file.


Administrator rights issue with Windows service

SDadmin.jpg

By default, a windows service runs through a non administrator system user.
Depending on your architecture, it is possible that this user account has not enough rights to ensure a proper start of the Sending Service. (proxy issue for example)

Then simply change this setting this way: 

  Solving Method

  * Open the Windows services window. (Start > Control Panel > Administrative tools > Services)
  * Right click on the service named ServiceDéposant
  * Select the Properties item
  * Indicate an administrator user account and password in LogOn tag.
  * Relaunch the service

Errors are raised during sending

The generation of an .err file during the processing of your report indicates an issue during the sending.

In this case, it is necessary to analyze the problem because the data could not be transmitted to the authorities.

The .err file contains the explanation of the error that generates this dysfunction.

You will find below the most common problems.
In all cases, we are at your disposal to assist you in this analysis. Feel free to contact Client Support & Operations Desk.



Functional Problem

Error 1 : Failed to validate XML
Error 2 : All error indicating a data problem

  Solving Method

  * Correct the source file according to the error messages indicated in the .err file.
  * Resend the file.

User account problem

Error 1 : Getting addressees information Une erreur est survenue lors de l'execution du Workflow

  Solving Method

  * Link the sending service user account to the right User Group according to the kind of reporting your are trying to send. His profils should be SD with response

Certificate Update

Once your Luxtrust certificate is activate in E-file, you need to replace de new keystore in the sending service. Please find below what you need to do:

  • Stop your sending service
  • Copy your new keystore in the keystores folder of the Sending Service.
  • Update the configuration: It is possible that your new Keystore has a different name than the previous Keystore therefore it is necessary to update the configuration.
 E-file configuration
Variable Description
keystore.path=@PROJECT_ROOT_PATH@/keystores/????.ks path of the keystore (xxxx.ks)


  • Install the sending service: To install the Sending Service, you have to click on the Install button. A pop-up window opens where you have to enter your passwords.

Note : If you do not use a proxy, you can leave a blank for the proxy password

Doc SDInstaller 12.png


Once finished a pop-up windows opens stating that the installation has been successful:

Doc SDInstaller 13.png

To start your Sending Service open the folder where you installed it and run the file run.bat or InstallServiceNT.bat if you want to install the Service as a Windows Service.

=> Installation as a Windows Service

=> How to start the Sending Service

=> How to stop the Sending Service

Retrieved from "http://www.e-file.lu/wiki/index.php?title=Sending_Service&oldid=7304"