Difference between revisions of "Regipay"

From regify WIKI
Jump to navigation Jump to search
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
==regipay FAQ==
+
==regipay user and sender FAQ==
  
'''Q: Do I need to be authenticated to send regibill documents?
+
===How can I create/send regipay documents?===
 +
Today, there are two ways:
 +
* By using the '''regipay ''desktop''''' software (standalone, Windows only).
 +
* Using the regify '''Client-SDK'''. It can be used for creation of batch processing scripts or your own applications.
  
A: Yes, to use regipay, you need to be authenticated and you need the unlock-code for your individual identity-file. You need to be authenticated at least with authentication-level 3. Otherwise you will get error 76 (individual identity-file needed).
+
===Do I need to be authenticated to send regipay documents?===
 +
Yes, to use regipay, you need to be authenticated and you need the unlock-code for your individual identity-file. You need to be authenticated at least with authentication-level 3. Otherwise you will get error 76 (individual identity-file needed).
  
 +
===I do not see any regipay functionalities in my portal-menu. What do I need to do to be able to send regipay?===
 +
Your regify-provider needs to activate this option for you. Please contact the regify-provider support.
  
'''Q: I do not see any regipay functionalities in my portal-menu. What do I need to do to be able to send regipay?'''
+
===Do I need to be regimail member to be able to send regipay messages?===
 +
No, you can send '''regipay''' even if you are not a regimail member. It depends on the individual settings of your regify-provider.
  
A: Your regify-provider needs to activate this option for you. Please contact the regify-provider support.
+
===Can I open regipay messages online, too?===
 +
Yes. A regipay message can get opened using the web-portal in the same way like a regimal message (upload rgf file).
  
 +
===I need to use a proxy for internet access, but I can not find fields for?===
 +
regipay desktop is able to use a proxy. Enter the proxy data directly on the login dialog (after setup) or later in the configuration dialog.
  
'''Q: I use the Client-SDK, but I get error 44 (no regipay allowed)?'''
+
===What kind of PDF documents are your recommendation?===
 +
We recommend you to send PDF/A files. This is a standard that guaranties optimal readability even after a long time (archiving). It also ensures that no exotic technology is used that may confuse regibill software.
  
A: Your regify-provider needs to activate this option for you. Please contact the regify-provider support.
+
===I use the Client-SDK, but I get error 44 (no regipay allowed)?===
 +
Your regify-provider needs to activate this option for you. Please contact the regify-provider support.
  
 +
==regipay administrator FAQ==
 +
This is information for regify (sub-)provider administrators. You need to be able to log in to the web administration of your (sub-)provider in order to follow the information.
  
'''Q: How can I create/send regipay documents?'''
+
=== How to set-up a user and group for sending regipay ===
 +
'''Step ONE'''<br>
 +
User needs to have a regify account.  The used email address is usually some payslip related name like payslips@company.com, hr@company.com or other. The customer may want to create a new email address for this or re-use an existing. The only prerequisite is to make sure that it can get used using SMTP form sending (for regipay desktop).
  
A: Today, there is only one way for developers:
+
We suggest you to invite him. For this, log in to your generic regify portal with your regify account and invite him using standard invitation dialogs.
* using the regify '''Client-SDK'''. It can be used for creation of batch processing scripts or your own applications.
 
We are working on a easy desktoip solution.
 
  
 +
'''Step TWO'''<br>[[File:user_action_menu.png|right|User action menu]]
 +
Prepare his account. After the regify account was activated, please locate the account in web administration -> Manage user. Then select the respective "Action" button on the right.
  
'''Q: Do I need to be regimail member to be able to send regipay messages?'''
+
First, verify all values entered using "Change the user data" (see screenshot below). Make sure to have First Name, Last Name, Organization, Address and Country filled in. Click "Save changes" to apply the settings.
  
A: No, you can send '''regipay''' even if you are not a regimail member. It depends on the individual settings of your regify-provider.
+
Now enter "Product settings / SDK" and switch to "Product settings" tab and check the "regipay User" option. Do not check any other options. Click "Save changes" to apply the settings.
 +
 
 +
Authenticate the user. Please note that you have to make sure that the account is really from your customer! If you doubt, do not authenticate him and check validity again! Maybe give him a call or verify him in a remote session.
 +
 
 +
In "Action" for this user, enter "Authenticate user" and select "Type: Organisation", "Auth-Level: 3". Check either "Of known identity" or "identified", depending on your knowledge. Fill in the security question (last field). Click "Authenticate now".
 +
 
 +
'''Step THREE'''<br>
 +
Create a group for the new customer. Enter web administration -> User groups -> Create new group. In there, enter name and size (eg number of employees the customer is having). Also select their new payslip user created above as group admin (use "..." button to identify). Leave all other fields untouched.
 +
 
 +
'''Step FOUR'''<br>
 +
You are close. The customer is now having a password. You can tell him his unlock code (Authenticate users -> Previous authentications). For installation of regipay desktop, some serial number is needed. The regipay desktop is paid software and this number is obtained from regify GmbH. Please ask your regify sales contact for this number.
 +
 
 +
'''NOTE:''' There is a PDF document ''regipay_onboarding_process.pdf''. It contains everything needed for the regipay customer in order to start with regipay. You may ask regify support for the most recent version.
 +
 
 +
== Authentication ==
 +
At first, regify offers optional authentication. If a user signs up, a regify provider does not really know his identity. He only knows that the user is having access to the given email address. If some recipient needs to know for sure, if the sender is really the person he claims to be, the sender must be authenticated. This is a process that regify providers may offer to their customers. Some regify providers are configured to offer authentication actively. That means, the user is not able to start an authentication by himself, but the provider administrator can still do this manually. If you need to become authenticated, please contact your regify provider support.
 +
 
 +
Authentication is offered in two flavours and several authentication levels. Please step in here to get some more information:<br>
 +
[http://www.regify.com/index.php?PageID=Authentication regify authentication information page]
 +
 
 +
For sending regipay and regibill messages, we (regify) want the recipient to be sure about the sender identity. This is for confidentiality and security reasons. Thus, the minimum authentication level for sending regipay messages is level 3 (user or organization level). Every regify provider is able to do user and organization authentication with level 1 and 3 without any further efforts. For higher authentication levels, a regify provider must become certified by regify. If you like to become certified, please contact regify support.
 +
 
 +
Upon authentication, the authenticated person is getting an unlock-code. This is used to gather the identity-file from the regify provider. This identity-file is normally stored on the senders local machine for further use and managed by the sending application (regibill desktop, regipay desktop or standard regify client). The identity-file is now used for every connection to the regify provider securing the transport of information and ensuring the legitimation of a sending account.
 +
 
 +
The recipients of regimail, regibill and regipay messages can see the senders identity upon receiving and opening the messages.
 +
 
 +
==Regular Expressions==
 +
===Find date===
 +
^(19|20)\d\d[- /.](0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])$
 +
Finds a date in yyyy-mm-dd format from between 1900-01-01 and 2099-12-31, with a choice of four allowed separators.
 +
 
 +
===Find numbers===
 +
\b\d{2}-\d{6}\b
 +
search "##-######" where # is a digit (like "12-123456")
 +
\d+\-\d+\/20\d{2}
 +
search "#-#/20##" (like "71-07/2011")
 +
 
 +
===Find values behind words===
 +
(?<=Username\:).+
 +
Finds all chars after "Username:".
 +
(?<=Invoice-Nr\.:\s)[0-9]{5}[0-9]*
 +
Finds all numbers with 5 or more digits after "Invoice-Nr.: "
 +
 
 +
'''Since regipay 2.1, you can also use groups (terms in parentheses):'''
 +
name:\s+(.*) with Output \1
 +
Finds all behind "name: ".
 +
(?:Periode|Zeitraum|period):\s+(\d\d)/\d\d/(20\d\d) with Output \1/\2
 +
Will look for Periode:, Zeitraum: or period: followed by one or more spaces and a date like mm/dd/yyyy. From this, it will take month / year for output.
 +
<br>Example: "Periode: 05/23/2019" will output "05/2019".
 +
 
 +
===Find APSAL date===
 +
Use this regex to find APSAL date in German, French and English payslips:
 +
[A-ZÄÖÜÁÉÍÓÚÂÊÎÔÛÀÈÌÒÙ]+\s+20\d\d
 +
 
 +
==Use placeholders in message body==
 +
The regipay desktop default templates are using placeholders like [MONTH], [MONTH_NAME] and [YEAR]. But if you are able to use regular expressions to read the payslip date from your payslip, you can use the[REGEXn] placeholders to insert the gathered date from the payslip (which is much better). See the below screenshot for an example:
 +
 
 +
[[File:Regipay message template.png||regipay message template and placeholders]]
 +
 
 +
Please also note the marked ['''?'''] buttons (show help about available placeholders) and the ['''P'''] button (for preview).

Latest revision as of 10:08, 25 February 2021

regipay user and sender FAQ

How can I create/send regipay documents?

Today, there are two ways:

  • By using the regipay desktop software (standalone, Windows only).
  • Using the regify Client-SDK. It can be used for creation of batch processing scripts or your own applications.

Do I need to be authenticated to send regipay documents?

Yes, to use regipay, you need to be authenticated and you need the unlock-code for your individual identity-file. You need to be authenticated at least with authentication-level 3. Otherwise you will get error 76 (individual identity-file needed).

I do not see any regipay functionalities in my portal-menu. What do I need to do to be able to send regipay?

Your regify-provider needs to activate this option for you. Please contact the regify-provider support.

Do I need to be regimail member to be able to send regipay messages?

No, you can send regipay even if you are not a regimail member. It depends on the individual settings of your regify-provider.

Can I open regipay messages online, too?

Yes. A regipay message can get opened using the web-portal in the same way like a regimal message (upload rgf file).

I need to use a proxy for internet access, but I can not find fields for?

regipay desktop is able to use a proxy. Enter the proxy data directly on the login dialog (after setup) or later in the configuration dialog.

What kind of PDF documents are your recommendation?

We recommend you to send PDF/A files. This is a standard that guaranties optimal readability even after a long time (archiving). It also ensures that no exotic technology is used that may confuse regibill software.

I use the Client-SDK, but I get error 44 (no regipay allowed)?

Your regify-provider needs to activate this option for you. Please contact the regify-provider support.

regipay administrator FAQ

This is information for regify (sub-)provider administrators. You need to be able to log in to the web administration of your (sub-)provider in order to follow the information.

How to set-up a user and group for sending regipay

Step ONE
User needs to have a regify account. The used email address is usually some payslip related name like payslips@company.com, hr@company.com or other. The customer may want to create a new email address for this or re-use an existing. The only prerequisite is to make sure that it can get used using SMTP form sending (for regipay desktop).

We suggest you to invite him. For this, log in to your generic regify portal with your regify account and invite him using standard invitation dialogs.

Step TWO

User action menu

Prepare his account. After the regify account was activated, please locate the account in web administration -> Manage user. Then select the respective "Action" button on the right.

First, verify all values entered using "Change the user data" (see screenshot below). Make sure to have First Name, Last Name, Organization, Address and Country filled in. Click "Save changes" to apply the settings.

Now enter "Product settings / SDK" and switch to "Product settings" tab and check the "regipay User" option. Do not check any other options. Click "Save changes" to apply the settings.

Authenticate the user. Please note that you have to make sure that the account is really from your customer! If you doubt, do not authenticate him and check validity again! Maybe give him a call or verify him in a remote session.

In "Action" for this user, enter "Authenticate user" and select "Type: Organisation", "Auth-Level: 3". Check either "Of known identity" or "identified", depending on your knowledge. Fill in the security question (last field). Click "Authenticate now".

Step THREE
Create a group for the new customer. Enter web administration -> User groups -> Create new group. In there, enter name and size (eg number of employees the customer is having). Also select their new payslip user created above as group admin (use "..." button to identify). Leave all other fields untouched.

Step FOUR
You are close. The customer is now having a password. You can tell him his unlock code (Authenticate users -> Previous authentications). For installation of regipay desktop, some serial number is needed. The regipay desktop is paid software and this number is obtained from regify GmbH. Please ask your regify sales contact for this number.

NOTE: There is a PDF document regipay_onboarding_process.pdf. It contains everything needed for the regipay customer in order to start with regipay. You may ask regify support for the most recent version.

Authentication

At first, regify offers optional authentication. If a user signs up, a regify provider does not really know his identity. He only knows that the user is having access to the given email address. If some recipient needs to know for sure, if the sender is really the person he claims to be, the sender must be authenticated. This is a process that regify providers may offer to their customers. Some regify providers are configured to offer authentication actively. That means, the user is not able to start an authentication by himself, but the provider administrator can still do this manually. If you need to become authenticated, please contact your regify provider support.

Authentication is offered in two flavours and several authentication levels. Please step in here to get some more information:
regify authentication information page

For sending regipay and regibill messages, we (regify) want the recipient to be sure about the sender identity. This is for confidentiality and security reasons. Thus, the minimum authentication level for sending regipay messages is level 3 (user or organization level). Every regify provider is able to do user and organization authentication with level 1 and 3 without any further efforts. For higher authentication levels, a regify provider must become certified by regify. If you like to become certified, please contact regify support.

Upon authentication, the authenticated person is getting an unlock-code. This is used to gather the identity-file from the regify provider. This identity-file is normally stored on the senders local machine for further use and managed by the sending application (regibill desktop, regipay desktop or standard regify client). The identity-file is now used for every connection to the regify provider securing the transport of information and ensuring the legitimation of a sending account.

The recipients of regimail, regibill and regipay messages can see the senders identity upon receiving and opening the messages.

Regular Expressions

Find date

^(19|20)\d\d[- /.](0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])$

Finds a date in yyyy-mm-dd format from between 1900-01-01 and 2099-12-31, with a choice of four allowed separators.

Find numbers

\b\d{2}-\d{6}\b

search "##-######" where # is a digit (like "12-123456")

\d+\-\d+\/20\d{2}

search "#-#/20##" (like "71-07/2011")

Find values behind words

(?<=Username\:).+

Finds all chars after "Username:".

(?<=Invoice-Nr\.:\s)[0-9]{5}[0-9]*

Finds all numbers with 5 or more digits after "Invoice-Nr.: "

Since regipay 2.1, you can also use groups (terms in parentheses):

name:\s+(.*) with Output \1

Finds all behind "name: ".

(?:Periode|Zeitraum|period):\s+(\d\d)/\d\d/(20\d\d) with Output \1/\2

Will look for Periode:, Zeitraum: or period: followed by one or more spaces and a date like mm/dd/yyyy. From this, it will take month / year for output.
Example: "Periode: 05/23/2019" will output "05/2019".

Find APSAL date

Use this regex to find APSAL date in German, French and English payslips:

[A-ZÄÖÜÁÉÍÓÚÂÊÎÔÛÀÈÌÒÙ]+\s+20\d\d

Use placeholders in message body

The regipay desktop default templates are using placeholders like [MONTH], [MONTH_NAME] and [YEAR]. But if you are able to use regular expressions to read the payslip date from your payslip, you can use the[REGEXn] placeholders to insert the gathered date from the payslip (which is much better). See the below screenshot for an example:

regipay message template and placeholders

Please also note the marked [?] buttons (show help about available placeholders) and the [P] button (for preview).