README

sidndomainorder
===============

(english version below)

Dit script is gemaakt om klanten van SIDN te helpen om de facturatieperiode van hun portfolio van domeinnamen in bulk aan te passen

Het script maakt gebruikt van het rapport dat elke maandag van de SIDN site te downloaden is: DOMAIN_ORDER_FREQUENCY.

Snelstart: Download het rapport DOMAIN_ORDER_FREQUENCY van de SIDN registrar website, en start het script met de volgende parameters:
php sidndomainorder.php analyze DOMAIN_ORDER_FREQUENCYxxxxxx.CSV

Hiermee start u een analyse van het bestand. De analyse geeft aan hoeveel domeinnamen op 1, 3 of 12-maands orderperiode staan, en in welke maanden u facturen kunt verwachten voor welke aantallen domeinnamen en bedragen.
Ook geeft het script de toekomstig ingestelde ordertermijnen weer.

Daarna kunt u met de functie "distill" een bestand genereren van 1-maands en 3-maands domeinnamen, met de data waarop deze domeinnamen opnieuw worden gefactureerd. Dit bestand kunt u aanvullen met de maanden waarop u graag wilt dat de domeinnamen op 12-maands facturatie worden gezet.
Gebruik daarna de functie "set12months" om deze wijziging daadwerkelijk uit te voeren. Het script wijzigt alleen die domeinnamen op die maanden die zijn gewenst

Het script heeft een aantal mogelijke parameters:
 - sidndomainorder.php connect: Zorg dat EPP usernaam en EPP wachtwoord in config.php staan en test de EPP connectie

 - sidndomainorder.php analyze DOMAIN_ORDER_FREQUENCY.CSV: Deze optie leest het bestand DOMAIN_ORDER_FREQUENCY.CSV in en telt hoeveel domeinnamen op 3 maanden, hoeveel op 12 maanden en hoeveel op 1 maandsfacturatie staan.

 - sidndomainorder.php distill DOMAIN_ORDER_FREQUENCY.CSV: Deze optie leest het bestand DOMAIN_ORDER_FREQUENCY.CSV in en genereert een rapport van 1- en 3-maands renewals, en in welke maand deze renewals zullen gaan worden uitgevoerd.

 - sidndomainorder.php info MYFILE.CSV: Neemt de domeinnamen in het bestand MYFILE.CSV and haalt via EPP de meest recente domainorder informatie op. Zorg ervoor dat de domeinnamen in kolom 1 van MYFILE.CSV staan

 - sidndomainorder.php set12month MYFILE.CSV: Deze optie wijzigt de domeinnamen in het MYFILE.CSV bestand in op jaarfacturatie op de gewenste datum. Zorg ervoor dat de kolommen "Desired Year" en "Desired Month" zijn gevuld met correcte data.

Dit script is getest op PHP versies tot en met 8.3. Gebruik composer install om vendor module php-epp-client te laden
Let op: Zorg ervoor dat het IP adres dat je gebruikt is gewhitelist bij SIDN, anders werkt de EPP verbinding niet.

Voor vragen of problemen neem gerust contact op met Metaregistrar BV.
Als u de EPP connectie die in dit script is opgenomen wilt gebruiken voor uw eigen software, klik dan hier: https://github.com/metaregistrar/php-epp-client

sidndomainorder
===============

This script was made to help SIDN customers to bulk-change invoicing period of their portfolio of domain names

The script uses the reports DOMAIN_ORDER_FREQUENCY, that can be downloaded every monday from the SIDN website
This report contains all the domain names in the portfolio along with their invoicing periods

Use the function "distill" to create a comprehensive report on the 1-month and 3-month domain names and when their orderperiods end.
You can amend this report with the dates YOU want the domain names to be set to 12-month renewal.

This amended report can then be used with the function "set12month" to actually change the order periods of the selected domain names in the months that are desired.

The script uses the following parameters:

 - sidndomainorder.php connect: use this to test your EPP connection. Make sure that EPP username and EPP password are filled in as constants in config.php

 - sidndomainorder.php analyze DOMAIN_ORDER_FREQUENCY.CSV: Reads the report DOMAIN_ORDER_FREQUENCY.CSV and counts how many domain names are on 1, 3 or 12-month order periods.

 - sidndomainorder.php distill DOMAIN_ORDER_FREQUENCY.CSV: Reads the report DOMAIN_ORDER_FREQUENCY.CSV and generates a report on all 1-month and 3-month domain names, and in which months these domain names will be invoiced for another 1 or 3 months.

 - sidndomainorder.php info MYFILE.CSV: Reads the report MYFILE.CSV and retrieves the latest domain order information via EPP. Make sure the domain names are listed in column 1 of MYFILE.CSV

 - sidndomainorder.php set12month MYFILE.CSV: Change order periods of the domain names in this file to 12-month invoicing on the wanted dates. Make sure that the columns "Desired year" and "Desired month" are properly filled


 The script is tested on PHP versions until 8.3. Use composer install to install vendor module php-epp-client
 Please note that the IP address of the machine you are using must be whitelisted with SIDN to ensure proper EPP connection.

 If you experience problems or have questions, feel free to contact us: www.metaregistrar.com
 If you want to use the EPP connection provided with this script for your own software solution, please check https://github.com/metaregistrar/php-epp-client