View source for Sending Service

<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 = 

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.

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
*<span style="color: #C00000">'''Java version 1.8 or above''' </span>
*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.
*<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
*Processor: Pentium 2 GHz or equivalent
*1 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 <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 e-file account of the Sending Service user has to be linked to groups/modules, for example FATCA reporting + profile "Sending Service". 
*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).

= Installation or 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]]





'''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==

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''' 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]]



You must complete the fields below, if you have to submit Investment Funds reporting O4.1; O4.2 (EDIFACT format).

'''domain.en.ac.cd_auth''': this '''authentication code''' has been provided to you by the CSSF (postal mail).

'''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”).

'''domain.env.ac.pwd''': this '''authentication password''' has been provided to you by the CSSF (postal mail).


[[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.

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]]

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





==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.

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

<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.





==Update==

<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]].

To update an <u> existing </u> Sending Service you have to click the ''Update'' button.

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

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




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]]





==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>

[[File:Doc_SDInstaller_23.png]]

[[File:Doc_SDInstaller_24.png]]

= Manual installation with Command Prompt = 

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

* 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]]

* Copy your <span style="color: #C00000">'''keystore'''</span> in the keystores folder of the Sending Service.

* Copy the <span style="color: #C00000">'''template_configInstall.properties'''</span> file and rename it [sender''Name''].properties.

* 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.

* 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
 (-) Press the ENTER key
 

<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.

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

[[File:CMD cryp mots de passe.jpg]]


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.


<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.


[https://www.e-file.lu/docs/EN/ManuUtil_EFile_Installation_SD_EN.pdf  => Sending Service Installation Procedure.pdf]'''

[https://www.e-file.lu/docs/EN/ManuUtil_EFile_Maj_SD_EN.pdf => Sending Service Update Procedure.pdf]

[https://www.e-file.lu/docs/FR/ManuUtil_EFile_Installation_SD_FR.pdf  => Service Déposant Procédure d’Installation.pdf]'''

[https://www.e-file.lu/docs/FR/ManuUtil_EFile_Maj_SD_FR.pdf => Procédure de Mise à Jour du Service Déposant.pdf]

= 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]].


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

[[File:InstallServiceNT.png|600 px]]


 
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.

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

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

[[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.





= 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 taken into account.'''</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>




'''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.
|-
|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
|}





'''Proxy configuration'''

{| 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. 
|}





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

{| class="wikitable;style="background:#112233"
|-
! 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.

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>'''

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

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

|-
|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 = '/').

|-
|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>'''.

|-
|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.

|}




'''Business environment properties'''

{| 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"| <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"| <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>. 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'''

{| 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 ==

{|border="1" cellspacing="2" cellpadding="10"
|-
! Listener
! Sending Service folder
! Reporting type
! Business group
|<span style="color: #868686"> <small>''Internal <br /> Technical <br /> Business ID''</small/> </span>
|-
|<span style="color: #868686"> <small>''Please be informed that the listener '''efile.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>
|-
|<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>
|-
| reportingOPC.automatique.state=up
|(-) ReportingDiffusion/OPC/envoi_Automatique/fichiersCCLUX<br><span style="color: #868686"> <small>''(-) ReportingDiffusion/OPC/envoi_Automatique/fichiersCCLUX/Enrichment''</small/> </span><br><span style="color: #868686"> <small>''(-) ReportingDiffusion/OPC/envoi_Automatique/TPT_FINESTI''</small/> </span>
| <small>CSSF - Investment Funds: O4.1, O4.2, O1.2, U1.1<br>BCL : S1.3, S1.6, S2.13, TPTOBS </small/>
| Station Finesti
| <span style="color: #868686"> <small>''8-Transmission of UCI regulatory reports''</small/> </span>
|-
| reportingOPCExportXLS.automatique.state=up
| ReportingDiffusion/OPC/envoi_Automatique/ExportXLS
| <small>CSSF - Investment Funds: O4.1, O4.2, O1.2, U1.1<br>BCL : S1.3, S1.6, S2.13, TPTOBS</small/>
| Station Finesti
| <span style="color: #868686"> <small>''8-Transmission of UCI regulatory reports''</small/> </span>
|-
| reportingOPC.envoi_Historique.state=up
| ReportingDiffusion/OPC/envoi_Historique/fichiersCCLUX
| <small>CSSF - Investment Funds: O4.1, O4.2, O1.2, U1.1<br>BCL: S1.3, S1.6, S2.13, TPTOBS</small/>
| Station Finesti
| <span style="color: #868686"> <small>''8-Transmission of UCI regulatory reports''</small/> </span>
|-
| reportingOPC.semiAuto.state=up
| n/a
| n/a
| n/a
| n/a
|-
|reportingVni.state=up
|ReportingDiffusion/VNI
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
|- 
| reportingDividende.state=up
| ReportingDiffusion/Dividendes
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
|-
| reportingTAF.state=up
| (-) 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
| <span style="color: #868686"> <small>''71-MiFIR reporting''</small/> </span>
|-
| reportingTAFEncrypted.state=up
| ReportingDiffusion/TAF/ENCRYPTED
| <small>CSSF - Transactions in financial instruments (TAF)</small/>
| Report TAF-MIFID
| <span style="color: #868686"> <small>''71-MiFIR reporting''</small/> </span>
|-
| reportingCOREP.state=up
| 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/>
| Rapport COREP
| <span style="color: #868686"> <small>''72-COREP reporting''</small/> </span>
|-
| reportingFINREP.state=up
| ReportingDiffusion/FINREP
| <small>CSSF: B2.4; B2.5</small/>
| Rapport FINREP
| <span style="color: #868686"> <small>''73-FINREP reporting''</small/> </span>
|-
| reportingFINREP.EDIFACT.state=up
| ReportingDiffusion/FINREP/EDIFACT_CSSF
| <small>CSSF: B4.4</small/>
| Reporting EDIFACT
| <span style="color: #868686"> <small>''16-Edifact''</small/> </span>
|-
| reportingBOP.state=up
| ReportingDiffusion/BOP
| <small>BCL - Credit institutions: Balance of payments (BOP1.1; BOP1.2)</small/>
| Balance des Paiements
| <span style="color: #868686"> <small>''12-Edifact reporting''</small/> </span>
|-
| reportingBCLStat.state=up
| ReportingDiffusion/BCL_Statistics
| <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
| <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
| ReportingDiffusion/Securisation
| <small>BCL - Securitation vehicles: S2.14; S2.15; TPTTBS</small/>
| Véhicule titrisation
| <span style="color: #868686"> <small>''23-Véhicule titrisation''</small/> </span>
|-
|reportingSecurisationS2.14ExportXLS.state=up<br>reportingSecurisationS2.15ExportXLS.state=up<br>reportingSecurisationTPTTBSExportXLS.state=up
| ReportingDiffusion/Securisation/ExportXLS
| <small>BCL - Securitation vehicles:S2.14; S2.15; TPTTBS</small/>
| Véhicule titrisation
| <span style="color: #868686"> <small>''23-Securitisation vehicule''</small/> </span>
|-
| reportingTPTB.state=up
| ReportingDiffusion/TPT
| <small>BCL - Credit institutions: TPTBBL; TPTBBN; TPTBHR; TPTBHN</small/>
| Titre par Titre Bancaire
| <span style="color: #868686"> <small>''20-Security by security reporting''</small/> </span>
|-
| reportingTPTBExportXLS.state=up
| ReportingDiffusion/TPT/ExportXLS
| <small>BCL - Credit institutions: TPTBBL; TPTBBN; TPTBHR; TPTBHN</small/>
| Titre par Titre Bancaire
| <span style="color: #868686"> <small>''20-Security by security reporting''</small/> </span>
|-
| reportingESP.state=up
| ReportingDiffusion/ESP
| <small>CSSF: Special Enquiries (ESPREP)</small/>
| Rapport Enquête
| <span style="color: #868686"> <small>''15-CSSF polls''</small/> </span>
|-
| reportingPSF.state=up
| ReportingDiffusion/PSF
| <small>CSSF - Professional of the financial sector (PSFREP)</small/>
| Rapport PSF
| <span style="color: #868686"> <small>''18-PSF reporting''</small/> </span>
|-
| reportingSICAR.state=up
| ReportingDiffusion/SICAR
| <small>CSSF - SICAR</small/>
| Rapport SICAR
| <span style="color: #868686"> <small>''17-SICAR reporting''</small/> </span>
|-
| reportingOTH.state=up
| ReportingDiffusion/OTH
| <small>CSSF - Other reporting (OTHREP)</small/>
| Reporting OTHER (CSSF)
| <span style="color: #868686"> <small>''19-OTHER reporting (CSSF)''</small/> </span>
|-
| reportingRFOPC.state=up
| ReportingDiffusion/DOC_FIS_OPC/REPORT_OPC
| <small>CSSF UCI: <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 (MP)</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>



|-
| reportingRAFIS.state=up
| 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/> <br /> 
<small> <span style="background:yellow"> '''NEW'''</span></small/>  <small> SICAR: <br />
(-) Annual Report (AR) <br />
(-) Annual Report (RO) </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>
|-
| reportingPOPC.state=up
| ReportingDiffusion/DOC_FIS_OPC/PROSP_OPC
| <small>CSSF UCI: <br /> (-) Prospectus (PC)  <br /> (-) Simplified prospectus (PS) <br /> (-) Letter of explanation (LE)</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>
|-
| reportingPFIS.state=up
| ReportingDiffusion/DOC_FIS_OPC/PROSP_FIS
| <small>CSSF SIF: <br /> (-) Prospectus (PC)  <br /> (-) Offering document (DE) <br /> (-) Letter of explanation (LE)</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>
|-
| reportingKID.state=up
| ReportingDiffusion/DOC_FIS_OPC/KID_OPC
| <small> Key Investor Information Document (KIID) <br /> 
(-) O: OPC Law 2010 and Law 2007 <br /> 
(-) K: SICAR <br /> 
(-) V: non-reglem. <br /> 
[[Sending Service#Automating process for KIID packages|=> Automated process for KIID packages]]</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>
|-
| reportingMR.state=up
| ReportingDiffusion/DOC_FIS_OPC/MGMT_REGUL
| <small>CSSF - Management Regulations of UCITS (MR)</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>
|-
| reportingAI.state=up
| ReportingDiffusion/DOC_FIS_OPC/ART_INCORP
| <small>CSSF - Articles of Incorporation of UCITS (AI)</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>
|-
| reportingML.state=up
| ReportingDiffusion/DOC_FIS_OPC/MGMT_LETTER
| <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)
| <span style="color: #868686"> <small>''21-Métier des circulaires CSSF 08/371 et 09/423''</small/> </span>
|-
| reportingLF.state=up
| ReportingDiffusion/DOC_FIS_OPC/LONG_FORM
| <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>
|-
| 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 /> 
(-) LBC/FT Obligation (BC) <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)
</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>
|-
| reportingCD.state=up
| ReportingDiffusion/Various_Correspondence
| <small>BCL - Other reporting (OTX)</small/>
| Reporting OTHER (BCL)
| <span style="color: #868686"> <small>''22-Various correspondence (OTH=> BCL)''</small/> </span>
|-
| reportingSGO.state=up
| ReportingDiffusion/SGO
| <small>CSSF - Management company reporting (SGOREP)</small/>
| Rapport Société de Gestion
| <span style="color: #868686"> <small>''26-Management company''</small/> </span>
|-
| reportingDOCBNK.state=up
| 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/>
| Reporting  des  établissements  de  crédit
| <span style="color: #868686"> <small>''27-Reporting of credit institutions''</small/> </span>
|-
| reportingEDP.state=up
| ReportingDiffusion/EDP
| <small>CSSF - Payment instituions (EDPREP): Z1.1; Z1.2; Z1.4; Z2.1 </small/>
| Reporting EDP
| <span style="color: #868686"> <small>''29-Periodic reporting scheme for payment instituions (EDP)''</small/> </span>
|-
| reportingEME.state=up
| ReportingDiffusion/EME
| <small>CSSF - Electronic money instituions (EMEREP): W1.1; W1.2; W1.3; W1.4; W2.1  </small/>
| Reporting EDP
| <span style="color: #868686"> <small>''34-Electronic money reporting (EME)''</small/> </span>
|-
| reportingPubDiffu.state=up
| ReportingDiffusion/DOC_FIS_OPC/PUB_FINESTI<br>ReportingDiffusion/DOC_OPC_NOT_LU/PUB_FINESTI
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''32-Envoi pour publication/diffusion''<br>''33-Envoi pour publication/diffusion OPC non LU''   </small/> </span>
|-
| reportingOPCNONLU.state=up
| 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/>
| <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>
|-
| reportingMAJDOCLU.state=up
| ReportingDiffusion/DOC_FIS_OPC/HOST_UPDATE
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''37-Enregistrement/Mise à jour de documents Fond LU vers pays HOST''</small/> </span>
|-
| reportingSE.state=up
| ReportingDiffusion/SE
| <small> BCL - Financial companies: S2.16; S2.17; TPTIBS</small/>
| Reporting des sociétés émettrices
| <span style="color: #868686"> <small>''35-Issuing companies reporting''</small/> </span>
|-
| reportingSEExportXLS.state=up
| ReportingDiffusion/SE/ExportXLS
| <small> BCL - Financial companies: S2.16; S2.17; TPTIBS</small/>
| Reporting des sociétés émettrices
| <span style="color: #868686"> <small>''35-Issuing companies reporting''</small/> </span>
|-
| reportingSETransfoXLS.state=up
| ReportingDiffusion/SE
| <small> BCL - Financial companies: S2.16; S2.17; TPTIBS</small/>
| Reporting des sociétés émettrices
| <span style="color: #868686"> <small>''35-Issuing companies reporting''</small/> </span>
|-
| reportingASS.state=up
| ReportingDiffusion/ASS
| <small> BCL - Insurance companies: S0218-L; S0219-L; S0403-L; TPTASS </small/>
| Reporting BCL pour les assurances
| <span style="color: #868686"> <small>''63-Reporting BCL pour les assurances''</small/> </span>
|-
| reportingASSExportXLS.state=up
| ReportingDiffusion/ASS/ExportXLS
| <small> BCL - Insurance companies: S0218-L; S0219-L; S0403-L; TPTASS </small/>
| Reporting BCL pour les assurances
| <span style="color: #868686"> <small>''63-BCL report for insurances''</small/> </span>
|-
| reportingASSTransfoXLS.state=up
| ReportingDiffusion/ASS
| <small> BCL - Insurance companies: S0218-L; S0219-L; S0403-L; TPTASS </small/>
| Reporting BCL pour les assurances
| <span style="color: #868686"> <small>''63-BCL report for insurances''</small/> </span>
|-
| reportingDP.state=up
| ReportingDiffusion/CDP
| <small> BCL - Data on payment operation: V 1.1 - V 1.14 </small/>
| Collecte des données de paiement (CDP)
| <span style="color: #868686"> <small>''36-Data on payment instruments and operations''</small/> </span>
|-
| reportingNotifUcitsIV.state=up
| ReportingDiffusion/DOC_FIS_OPC/NOTIFICATIONS_UCITSIV
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''28-UCITS IV notification''</small/> </span>
|-
| reportingFINESTI.state=up<br>reportingLIBFINLU.state=up
| ReportingDiffusion/DOC_FIS_OPC/LIBRARY_FINESTI
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
|-
| reportingLIBFINNOTLU.state=up
| ReportingDiffusion/DOC_OPC_NOT_LU/LIBRARY_FINESTI
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
| <span style="color: #868686"> <small>''tbd''</small/> </span>
|-
| <span style="color: #868686"> <small>''OBSOLETE : reportingCRF.state=up''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
|-
| <span style="color: #868686"> <small>''OBSOLETE : reportingCRFEncrypted.state=up''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
| <span style="color: #868686"> <small>''n/a''</small/> </span>
|-
| reportingAIF.state=up
| ReportingDiffusion/AIF
| <small> CSSF - Alternative Investment Fund managers: AIF / AIFM </small/>
| (-) AIF <br /> (-) AMfine
| <span style="color: #868686"> <small>''54-AIFMD reporting''</small/> </span>
|-
| reportingFATCA.state=up
| ReportingDiffusion/FATCA
| <small> ACD - Financial Institutions - Foreign Account Tax Compliance Act (FATCA) </small/>
| Rapport FATCA
| <span style="color: #868686"> <small>''60-FATCA reporting''</small/> </span>
|-
| reportingCAA.state=up
| ReportingDiffusion/CAA
| <small> (-) CAA - Rapports narratifs (N01-N10 <br /> (-) CAA - XBRL reports Solvency II (S01-S23) </small/>
| Reporting CAA|
| <span style="color: #868686"> <small>''63-BCL report for insurances|''</small/> </span>
|-
| reportingCRS.state=up
| ReportingDiffusion/CRS
| <small> ACD - Financial Institutions - Common Reporting Standard (CRS) </small/>
| Reporting CRS
| <span style="color: #868686"> <small>''68-CRS reporting''</small/> </span>
|}

= 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

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 start the service.

[[File: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 <span style="color: #C00000">'''run.bat'''</span> command, you can stop it pressing the keys Ctrl+C+Y.


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

* 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.

[[File:WindowsService.png]]




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

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 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.'''



'''The Sending Service provides two sending possiblities:'''

<u>Automatic sending</u>

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 '''directly sent to the authorities'''.

In case of an error, an '''error file''' (text file with .err extension) is generated.


<u>Semi-automatic sending</u>

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 file is transmitted to the supervisory authority.





= Automating process for KIID packages =

In the context of KIID updates to be filed to the CSSF, it is possible to set up the automatic sending of KIIDs packages (.zip files) from our server to your Sending Service. Once the Sending Service has received the KIIDs, 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
* 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 KIID 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.

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





= Sending progress and follow up =

<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:

'''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>

|- 
||<span style="color: #C00000">'''.err'''</SPAN>
||An <span style="color: #C00000">'''.err</SPAN> file is created in case or an error:

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

Please open this file and analyse the error message.

|- 
||<span style="color: #C00000">'''.ack'''</SPAN>
||In the case of CSSF reports '''O4.1'''; '''O4.2'''; former '''O1.1'''  and BCL reports '''S1.3''', '''TPT''' or '''S2.13''', a technical file <span style="color: #C00000">'''.ack'''</SPAN> is sent by the authorities confirming that the receipt of the file:

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

This file completes the .acq file which only confirms the successful transmission.

|}


<span style="color:#C00000">'''Replies'''</SPAN> folder

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.]]</div>


<u> Example </u>: 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]]


* '''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'''.





= 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 <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.





= 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 <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.

<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.

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. <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 to <b>''formation''</b> for our test environment.

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>

* <span style="color: #C00000">'''Relaunch the Sending Service installation'''</span>





= Common Problems = 

== The service does not start ==

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

<br><br>
<u>'''Attempt to start it with the DOS command line'''</u><br>
<br>
* 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 : <span style="color: #C00000">''run.bat''</span>'''
<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>
<span style="color: #C00000">'''Otherwise, a log analysis is necessary'''</span><br><br>





=== Log Analysis===

The <b>''error.log''</b> file located in the <b>''log''</b> folder at the root of Sending Service, contains the error trace causing this dysfunction.<br>

'''You will find below the most common known problems.'''<br>
<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>





==== Network Problem ====

<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>
* Check the proxy parameters of your properties file
* '''Relaunch  the sending service installation process''' so that the changes are taken into account.<br><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>'''Solving Method'''</u><br><br>
* Check the configuration of your proxy with your network team.<br>
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====

<u>'''Error'''</u> : <span style="color: blue">Startup failed: Timed out waiting for signal from JVM.</span><br><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.





==== Administrator rights issue with Windows service ====
[[File:SDadmin.jpg]]

By default, a windows service runs through a '''non administrator system user'''.<br>
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)<br>

Then simply change this setting this way: <br>

<br>
<u>'''Solving Method'''</u><br><br>

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





== Errors are raised during sending == 

The generation of an <b>''.err''</b> file during the processing of your report indicates an issue during the sending.<br>

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

The <b>''.err''</b> file contains the explanation of the error that generates this dysfunction.<br><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 contact <span style="color: #C00000">'''[[How to contact us|'''Client Support & Operations Desk''']].'''</span><br>





==== Functional Problem ==== 

<u>'''Error 1'''</u> : <span style="color: blue">Failed to validate XML</span><br>
<u>'''Error 2'''</u> : <span style="color: blue">All error indicating a data problem</span><br><br>

<u>'''Solving Method'''</u>

* '''Correct the source file''' according to the erro messages indicated in the <b>''.err''</b> file.

* '''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><br>
* '''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>