.. _Registrar Portal: ================ Registrar Portal ================ The Registrar Portal allows registrars to access their billing information, statistics and other general resources from InternetNZ. The Registrar Portal is available for registered users at: https://registrars.internetnz.nz If you need an account created please contact: registry@internetnz.net.nz .. note:: The Portal does NOT provide transactional functionality such as registering or managing domains. Registrars need to perform those actions via their :ref:`SRS Protocol` or :ref:`EPP Protocol` connection. | Log in page =========== | From here you can log in using your email address . if you have forgotten you password there is a link here to request a Password reset. if you don’t have access to the Registrar Portal there is a link here to request access. | .. image:: images/login.png | **Two Factor Authentication** It is recommended users set up Two Factor Authentication (2FA) as an extra security measure when logging in. This is an important security step to take, as the portal allows access to financial data such as bank account balances and transactions and includes registrar full domain portfolio list and registrant contact information. Visit https://internetnz.nz/2factor for more information on why Two Factor Authentication is an important step to take. Upon successfully logging in to the portal, Click on the blue icon at the top right-hand side of the portal screen, then select Edit User. | .. image:: images/user_edit.png | At the bottom of the Edit User page select the option to Enable Two Factor Authentication. | .. image:: images/user_edit_2f.png | Once you have selected enable you will see the screen below. This provides a suggestion for a smart phone app if you don't already have one downloaded on your phone. Once you have downloaded an app, scan the QR code, a number will display on your phone screen, enter this into the code box and select Verify. `QR Code `_ `Suggested smart phone apps `_ | .. image:: images/qr_code.png | Next time you log in to the portal you will be asked to enter a code. Open the app that you previously downloaded and enter the six digit number that is displayed on the screen into the code area and click 'Verify'. | .. image:: images/login_2f.png | Navigating the Registrar Portal =============================== There are six main sections to the registrar portal: * Invoices * Transactions * Quality * Opportunities * Portfolio * Resources Upon successfully logging into the portal, the navigation centres around six key tabs that correspond to the six sections and these are shown at the top of the screen and remain present as you navigate to each section. The active tab will always be highlighted in bold. You can move to any section by clicking on the tab you want. E.g clicking on **TRANSACTIONS** will take you to the registrar transactions section. Some of the sections have sub pages. If a section has sub pages then a second menu bar will be displayed immediately underneath the main menu. For example the **TRANSACTIONS** section has four sub pages: Won & Lost, Growth, Renewal Rate and Transfers. An example of the main and second menu bar for the Transactions section is shown below: | .. image:: images/transactions-page.png | As with the main menu the active sub page is highlighted in bold in the second menu bar and you can view any sub page by clicking on the sub page title. **Registrars with multiple Registrar ID's** There is a drop down list that allows a registrar to access all the registrar ID's under his or her control. An example is shown below. | .. image:: images/user-switch.png | By default when a registrar user is invited to the Portal we only setup the user to access the Registrar ID they provide, but if access to multiple registrar IDs is required then please contact registry@internetnz.net.nz | | Invoices Section ================ | .. raw:: html .. sidebar:: Invoice Tab Video A demonstration of the Monthly invoice information available. | The Invoices section shows information about the current invoice and previous invoices. It is made up of one page and the page is split into four parts. The first part of the page on the top left hand side shows a breakdown of an invoice for a particular month. The default is the current month's invoice information to date and the estimated month end total, or if you select previous months invoice it will just show the Invoice total. The total amount of the invoice to date for the current month is displayed in the black circle. This number is repeated on the "Invoiceable to date" line the figure will update daily during the month until the 6th of the following month when the invoice for the month is finalised.(between the 1st and 6th of the month the line will read "Expected Invoice:") The layout also shows a comparison of the selected months invoice details with the same month in the previous year. There is a month selector at the top to allow a registrar to toggle through previous months invoices on screen and the corresponding graphical information. | Example invoice with the estimated month end invoice total shown: .. image:: images/invoices-table.png | Example invoice with the final invoice total shown: .. image:: images/invoices-table2.png | Between the 1st and 6th of the current month the invoice line for the previous month will read "Expected Invoice:" as invoices are not finalized until the end of the 5 day grace period. See the example below. .. image:: images/invoices-table3.png | .. note:: The above image has been created using artificial data and as such the associated totals are not accurate. | The table below gives a description of the invoice fields ===================== ================================================================================================== Field Description ===================== ================================================================================================== **Bank Balance** Registrar's bank balance. This appears on our **International registrars Invoice page only**. **Registrations** The number of registrations billed for the month, broken down into creates and renews. **Total months** The term/months that the domains are billed for the month, broken down into creates and renewals. **Registry** The number of registrations for the .nz registry as a whole broken down into creates and renewals. ===================== ================================================================================================== | **Download Invoices** The second part of the page at the bottom on the left hand side allows the registrar to download invoices for current month and to select any month dating back until 2012. It also allows you to download a csv file of the corresponding transactions for the month selected. | Example of the Dowload Invoices is shown below: .. image:: images/invoices-download.png | **Invoicing for International registrars** The previous months invoices are finalised on the 6th of each month and the amount is direct debited from the Registrar's New Zealand bank account on the 20th of the month. (or first business day following the 20th ) The invoice tab will now higlight in red text if the bank balance is below the previous month's invoice. | .. image:: images/bank_balance.png | An option to "Download Bank Statment" will appear here for **Overseas Registrars only**. | .. image:: images/invoices-download_bk.png | At the bottom a tick box has been added, you can select this to receive email notifications of daily bank transactions. By ticking this box you will also receive an email on the 15th of the month if your bank account balance is below the invoice amount. These updates will only be sent to individual users who have ticked the box. | .. note:: If your browser has Block pop-up windows selected in your browser preferences then you will not be able to download the invoice pdf or Transactions csv. | **Previous Invoices Chart** The third part of the page on the right hand side shows registrars a graphical overview of the last year's invoices allowing trends to be easily visualised. | Example of Previous Invoices Chart: .. image:: images/invoices-graph.png | .. note:: the presence of a snail icon denotes the late payment of that invoice. | **Registrar Whois Contact Details** .. image:: images/Registrar-contact-details.png This section shows the Registrar contact details as they appear on a domain WHOIS query If these details are incorrect they can be updated by using the SRS or EPP API. * SRS style contacts - `Registrar Update `_ * EPP style contacts - `Contact Update `_ | Transactions Section ==================== | .. raw:: html .. sidebar:: Transactions Tab Video A demonstration of the information provided of registrar transactions Won and Lost domains overall growth number in domains, renewal rate of domans and transfers of domains. The Transactions section has four sub pages: * Won and Lost * Growth * Renewal Rate * Transfers All sub-tabs under transactions use the month selector | .. image:: images/invoices-pagination.png | By toggling through the months you can easily see month by month comparisons along with the corresponding graphical information. | | Won and Lost ^^^^^^^^^^^^ | .. image:: images/wonlost-table.png | This section displays the monthly Won (creates + transfers in) and Lost (cancels and transfers out) in the black circles (size of circles scale with figures) Then this is broken down into | **Won** * Creates (New Domain names) * Transfers In (from other registrars) Renewals for the month are listed here also but not added to the total. | **Lost** * Cancels (Domain names cancelled) * Transfers out ( to another registrar) Pending Releases for the month are listed here also but not added to the total. | **Download Won & Lost** | .. image:: images/wonlost-download.png | The registrar can download a csv file of the yearly break down of the figures as well as the previous 2 years figures. | **Graph** | This section has three stacked graph representation of the won and lost figures over the past year, and the net difference of won minus lost. At the bottom of each graph there is a toggle to reduce or increase the number of months you want to look at on the graph. | .. image:: images/won-graph.png | .. image:: images/lost-graph.png | .. image:: images/net-graph.png | | Growth ^^^^^^ This section displays the monthly Net growth in actual domain name numbers for the registrar in the black circle. | .. image:: images/growth-table.png | Then this is broken down into a table showing * Total active domains for the registrar. * Total active domains for the registrar of the previous month. * Total active domains for the .nz registry. This allows the registrar to compare their growth and the .nz registry as a whole. | **Download Growth** | .. image:: images/growth-download.png | The registrar can download a csv file of the year to date data as well as the previous data back until 2013. | **Graph** | .. image:: images/growth-graph1.png | .. image:: images/growth-graph2.png | .. image:: images/growth-graph3.png | This section has graphical representation of the registrar's data, the Total active domains, the registrar's percent of the .nz registry and .nz registry total active domain names. At the bottom of each graph there is a toggle to reduce or increase the number of months you want to look at on the graph. | | Renewal Rate ^^^^^^^^^^^^ | .. image:: images/renewal-table.png | This section has the percent renewal rate for the month so far in the black circle. Broken down into | **Registrar** * Expected renewals * Actual renewals * Early renewals | **The Registry** * Expected Renewals * Actual renewals * Early Renewals | **Download Renewals** | .. image:: images/renewal-download.png | The registrar can download a csv file of the year to date data as well as the previous 2 years. | **Graph** | .. image:: images/renewal-graph1.png | .. image:: images/renewal-graph2.png | .. image:: images/renewal-graph3.png | .. image:: images/renewal-graph4.png | This section has graphical representation of the data over the past year. The formula used to calculate Renewal Rates is (Early + Actual)/(Early + Expected renewals). * Actual renewals = Number of domains expiring in the current month which have renewed. * Expected renewals = number of domains expiring in the current month. * Early Renewals = Domain names renewed before the month they were due. At the bottom of each graph there is a toggle to reduce or increase the number of months you want to look at on the graph. | | Transfers ^^^^^^^^^ | .. image:: images/transfers-table.png | This section has the net number of domain transfers displayed in the black circle. Broken down into a table showing. * Transfers in * Transfers out | **Download Transfers** | .. image:: images/transfers-download.png | The registrar can download a csv file of the year to date data as well as the previous 2 years. | **Graph** | .. image:: images/transfers-graph1.png | Above is a liner graphical representation of the transfers in and out for the past year. | .. image:: images/transfers-graph2.png | .. image:: images/transfers-graph3.png | There is also a bar graph of net transfers in and out, showing the registrar who they lost or won to, and a bar graph showing the transfers in and out of other registrars using the .nz registry. | | Opportunities Section ===================== | .. raw:: html .. sidebar:: Opprtunities Tab Video A demonstration of potential domain names you can offer your registrants. | The Opportunities section has three sub pages: * Second Level * Droplist * Resolved Conflicts | Second Level ^^^^^^^^^^^^ The Second Level page displays a table of **Available .nz domains**. This table is a list of existing third level names and the corresponding second level name where it is currently available for registration on a first come first served basis. This is a handy list for shaping a cross-sell campaign. | .. image:: images/Available_domains.png | .. note:: This table can be downloaded as a cvs file at any time using the Download CSV button (Top right corner) | Droplist ^^^^^^^^ The Droplist page provides registrars with a list of domains which are approximately two days from the end of their 90-day Pending Release period and the columns can be sorted ascending or descending, there is also a feature allowing the registrar to search the data. | .. image:: images/Drop_domains.png | The list can be downloaded at any time as a CSV file with the following headings =========== ============== ========================= Domain Name Cancelled Date Next Release Domains Date =========== ============== ========================= .. note:: The Droplist in the Registrar Portal should not be used by automated systems. If you would like to automate your access to the Droplist please use the :ref:`Droplist API ` | Resolved Conflicts ^^^^^^^^^^^^^^^^^^ The Resolved Conflicts page displays a table that shows a list of second level names that have been resolved by the `conflicted name `_ process and the registrant that has the right to register the second level name. The registrant needs to register the second level name before the Effective until date or the name will be made Available from that date for registration on a first come, first served basis. | .. image:: images/Resolved_domains.png | .. note:: This table can be downloaded as a cvs file at any time using the Download CSV button (Top right corner) | | Quality page ============ | .. raw:: html .. sidebar:: Quality Tab Video A demonstration of information provided about potential errors in domain records. This section is aimed at helping registrars improve the quality of the transactions sent to the registry and the quality of the registrant data stored in the registry database. There are two pages in the Quality section. | | Registrant Data ^^^^^^^^^^^^^^^ This page shows a number of data quality errors with the registrant data for domains under the management of the registrar. The registrants data errors may not comply with Whois policy requirements. The data is updated daily rather than monthly and only the current quality issues from the last update are being shown. | .. image:: images/registrant.png | This section has the total errors for the last 30 days displayed in the black circle, below that gives the registry total for the last 30 days and a table showing the top 5 error types and totals. | .. csv-table:: :header: "Error Type", "Error Details" :delim: | Obfuscated Private | Where a string similar to Private, Anonymous, XX, TBA, NIL, NA, N/A, Not Applicable, Not Available or otherwise is provided in the name or city for the registrant_contact details. Known Privacy Service | A service that provides anonymous domain registration on a commercial basis. Salutation as First Name | Where a salutation is used as the name in the registrant_contact field (e.g. Mr, Ms, Miss) Wrong Country/City Combination | Where the country is Afghanistan ("AF") and the city is a New Zealand city in the registrant_contact details. No Letters in Name Field | Where there are no alphabetic characters provided in the name in the registrant_contact details. Only City supplied | Where only the City is provided in the address for the registrant_contact details. No Letters in City Field | Where there are no alphabetical characters provided in the name in the registrant_contact_details. City as Name | Where the name is the same as the city in the registrant_contact details. Duplicated Address Fields | Where the name is the same as the city or the address is the same as the city in the registrant_contact details. | **Graph** This is a stacked graph representation of errors over the last 30 days. | .. image:: images/registrant-graph.png | **Registrant data errors Table** The actual Registrant errors are highlighted in red, the columns can be sorted ascending or descending, there is also a feature allowing the registrar to search the data. | .. image:: images/registrant-table1.png | An ignore feature for issues that have been incorrectly identified by our error checking algorithms. | .. image:: images/registrant-table2.png | Please review the errors on the Registrant Data Quality page and make changes where possible to this data through you interface to the SRS. Any corrections you make will then drop from the errors list for the next day. If you don't think an item on the list is an error you have a check box that allows you to ignore the item. For example one of the error types is "Obfuscated Private" and this normally means that the registrant name field has been obfuscated with the word private. However our algorithm is just looking for the word private in the registrant name field so the name could be "XYZ Private Club" which could be a valid registrant name. So in that case you would check the ignore box, hit save and the error will be removed from the list. | **Download registrant data errors** The data can be downloaded as a cvs file of errors at any time. (any items that have been selected to be ignored will not appear in the downloaded list). | | Systems Errors ^^^^^^^^^^^^^^ This page shows a summary of the transaction errors generated between the registrars system and the SRS over the last 30 days. | .. image:: images/system-table.png | This section has the total errors for the last 30 days displayed in the black circle, below that gives the registry total for the last 30 days and a table showing the top 5 error types and totals. | **Graph** This is a stacked bar graph representation of errors over the last 30 days. | .. image:: images/system-graph.png | **System errors Table** The actual errors are listed and the columns can be sorted ascending or descending, there is also a feature allowing the registrar to search the data. | .. image:: images/system-data.png | **Download System errors** The data can be downloaded as a cvs file of errors at any time. =========== ================= ======== description details action_id Datetime =========== ================= ======== | | Zone Scan ^^^^^^^^^ InternetNZ regularly conducts zone scans and web scans as explained on our web site: https://nzrs.net.nz/dns/zone-and-web-scanning This page shows the number of Zone Scan issues and affected domains | .. image:: images/zone_scan_totals.png | Below is a liner graphical representation of the Zone Scan issues and affected domains for the past five months. | .. image:: images/zone_scan_graph.png | Below is a table of domain names that have DNS related issues. Some of these issues are just warnings or informational messages but there are also a number of error types ranging from minor name server misconfiguration issues through to critical issues such as no name servers found for the domain name. The list can be filtered by error type. | .. image:: images/zone_scan_data.png | The full domain list with zone scan issues can be download in CSV format from this page. We recommend that you download it and check any domains found that you host the DNS for. For additional zone scan information please see: | .. toctree:: :glob: :maxdepth: 2 zonescan | | Portfolio ========= | .. raw:: html .. sidebar:: Portfolio Tab Video A demonstration of the registrars managed domain lists and conflicted domain names. | Domain List ^^^^^^^^^^^ This page will provide you with a Domain List CSV download for all active and pending release domains under registrar management. The CSV will include Domain Name, Status, Date Registered, Date Billed Until, Date Cancelled, and Date last updated. The portal does not display the whole list but there is a search box that can filter on domain names and display the details that match the search criteria. Additionaly we have added Registrant Type, this is output of our classification algorithm for each domain in your .nz portfolio. and IRPO Privacy, which lets you know if the Individual Registrant Privacy Option (IRPO) has been enabled on a domain for registrant contact details. The full csv is available via a download button. **Info Graphics** | .. image:: images/Info_graph_1.png | The first chart displays the % and number of domains for each 2LD and top level domain eg. org.nz, co.nz, .nz | .. image:: images/Info_graph_2.png | The Second chart displays Domain status shows you the % and number of domains that are active | .. image:: images/Info_graph_3.png | The third chart Registrant type the % and number of domains that are classified as an organisation or person and if they have IRPO enabled. **Domain List** | .. image:: images/domainlist.png | .. note:: The data will be sourced from the SRS via a daily extract (between 1am and 2am NZ local time every day) and the previous days file will be overwritten. | Conflicted Domains ^^^^^^^^^^^^^^^^^^ This table shows a list of all third level names that are `conflicted `_ at the second level. | .. image:: images/conflicted_domains.png | |   Resources ========= | .. raw:: html .. sidebar:: Resources Tab Video A demonstration of the resource content available. | Marketing ^^^^^^^^^ Provides access the .nz brand imagery, brand guidelines and campaign assets for registrars use, if there is anything further you need or any marketing questions please contact registry@internetnz.net.nz **Second Level Communications Packs** Here you will find information about the Conflicted Name Process and your role as Registrar. It also includes a Registrar-specific FAQ section, as well as an Options Diagram that you can share with your registrants. **Brand** The .nz branding guidelines and logos in png pdf and jpg formats. **Infographics** Downloads of our latest infographics. As we create new .nz related Infographics these will be loaded here for Registrars to use. If you require different formats of these graphics please do not hesitate to contact us. **Behind Business** Toolkit information and graphics for the Behind Business campaign. **Renewal Campaign** Information documents graphics and sample email for renewal a campaign. **Videos** A collection of videos for registrars to use. | Registrar Portal User access control ==================================== | How it works ^^^^^^^^^^^^ Each registrar will need at least one registrar admin user to manage the roles/permissions. A registrar can have as many registrar admin users as they want. There are three user access categories:- ===================== ====================================================== Categories Description ===================== ====================================================== Registrar Admin User Has access to all pages. Can manage restricted user access to pages.Is able to edit user details such as name and email address. User Has access to all pages but cannot manage other users. Restricted User Default state for all new users. Allows staff to log into the portal but not access any pages until the registrar admin grants access. Access is limited to the pages granted by the registrar admin user. ===================== ====================================================== | What do I need to do now? ^^^^^^^^^^^^^^^^^^^^^^^^^ • If you are the sole user of the portal, no further action is required. • If you have multiple staff that require different categories of access to the portal, then please follow the steps below: | **Confirm Your Registrar Admin(s)** | Please email registry@internetnz.net.nz to confirm who your Registrar Admin users are. The Registrar Admin(s) will be responsible for managing their staff access to the portal. | **New Member Access** | Notify us at registry@internetnz.net.nz that a new staff member is to be given access to the portal. Include their name and email address. Specify if they are to have ‘Registrar Admin’, ‘User’ or ‘Restricted User’ access. | Manage restricted user access to pages granted by the Admin user ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The Registrar Admin user needs to log into the Portal than click on the blue icon on the top right-hand side of the portal screen. | .. image:: images/blue_icon.png | Then select the ‘Users List’ option. | .. image:: images/blue_icon_list.png | The window should now show a list of users for your registrar id. | .. image:: images/user_list.png | The registrar admin can edit a user by selecting the user ID number in the left hand Column. By default, all check-boxes will be empty signifying no access to any portal pages. | .. image:: images/edit_user.png | Page access is granted by checking the respective box next to a page item. | .. image:: images/edit_user_select.png | | When page access for a restricted registrar user needs updating, the Registrar Admin user needs to log in to the portal and update access using the ‘Edit User’ option as detailed above. |