Sterling B2B Integrator - Managing Profiles in EBICS Client

You can search for a user profile from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select User.
3. In the User Configuration page, perform one of the following actions, and click GO.
   • In the User ID field under Search, enter either a part of the user ID or the entire user ID of the user profile you are searching for.
   • From the Alphabetically drop-down list, select the first letter with which the ID of the user you are searching for, begins.

You must be logged in to the EBICS Client dashboard interface as an administrator to update a user profile, delete a user profile, or view the summary of a user.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select User.
3. In the User Configuration page, using either Search or List, locate and select the user ID you want to edit, and click GO.
   You can click the user ID to view the user profile settings.
4. Click the update icon next to the user ID you want to edit.
5. In the Update: User Configuration page, specify the values for the fields according to the instructions in the following table and click Next:

   Field	Description
   Timezone	Optional. Select the time zone of the user.
   Technical user	Optional. A technical user is a system configured to submit orders on behalf of a non-technical or human user. This option is valid if you selected EBICS Client User as the user type. Select this check box to configure a Technical user.
   Certificate type	Required if you selected EBICS client user as the user type. Select X509 if you are using X.509 public key certificate to authorize the certificates. Select Keys if you are using RSA keys to authorize the certificates. Note: EBICS Client supports non-encrypted keys only.

6. If you selected X509 as the certificate type, specify the values for the fields according to the instructions in the following table in the Technical Information page and click Next:

   Field	Description
   Authentication private certificate	Required. Select the private key the EBICS Client uses to create a digital signature for the user in the request sent to the bank. The bank must have the public part of the key to validate the authorization. The drop-down contains a list of certificates configured in the Sterling B2B Integrator system certificate store.
   Authentication public certificate	Required. Select the public key the user provides to the bank to validate the authorization of the user in the request received from the EBICS Client. The trading partner or user shares the key with the bank. The key must be a public part of the Sterling B2B Integrator system certificate that is selected as the authentication private certificate.
   Authentication key version	The key version of the authentication certificate is displayed. Valid value is X002.
   Encryption private certificate	Required. Select the private key the EBICS Client uses to decrypt the response received from the EBICS Banking Server. The drop-down contains a list of certificates configured in the Sterling B2B Integrator system certificate store.
   Encryption public certificate	Required. Select the public part of the Sterling B2B Integrator system certificate that is selected as the encryption private certificate. The trading partner or user shares the key with the bank.
   Encryption key version	The key version of the encryption certificate is displayed. Valid value is E002.
   Use hardware key-store for Electronic signature	Optional. Select this option if you have an activated 3S Key token registered with the bank.
   Hardware key type	3S Key is displayed as the Hardware key type. 3SKey is a SWIFT secure signature key used for digital identity. You must activate the 3SKey token and register the key with the bank to enable you to sign and send messages to the bank.
   Electronic signature private key	Optional. Select the private key of the Electronic Signature (ES) certificate if you are not using a hardware key for Electronic Signature.
   Electronic signature public key	Required. Select the public key of the Electronic Signature (ES) certificate that is used to verify the signature of order data. The public key value of an Electronic Signature certificate should not be the same as an authentication or encryption certificate.
   Electronic signature key version	Required if you are not using a hardware key store for electronic signature. Select the key version of the electronic signature certificate. Valid values are A005 and A006. If you are using a hardware key store for electronic signature, then the key version is set to A005 and it cannot be changed.

7. If you selected Keys as the certificate type, specify the values for the fields according to the instructions in the following table in the Technical Information page and click Next:

   Field	Description
   Authentication private key	Required. Click Browse to select the file with the private part of the authentication key from your computer.
   Authentication public key	Required. Click Browse to select the file with the public part of the authentication key from your computer.
   Authentication key version	Required. Select the key version of the authentication certificate. Valid value is X002.
   Encryption private key	Required. Click Browse to select the file with the private part of the encryption key from your computer.
   Encryption public key	Required. Click Browse to select the file with the public part of the encryption key from your computer.
   Encryption key version	Required. Select the key version of the encryption certificate. Valid value is E002.
   Electronic signature private key	Required. Click Browse to select the file with the private part of the Electronic signature key from your computer.
   Electronic signature public key	Required. Click Browse to select the file with the public part of the Electronic signature key from your computer.
   Electronic signature key version	Required. Select the key version of the Electronic signature certificate. Valid values are A005 and A006.

8. In the Associated Partners page, perform any of the following actions and click Next.
   • Click the add icon to associate a new partner with user.
   • Click the update icon next to the partner you want to edit.
   • Click the delete icon to disassociate a partner from the user.
9. This step is applicable only if you opted to add a new partner or edit an existing partner.
   The bank assigns a set of permissions, order types, and file formats to a user based on the offer.
   In the Associated partners: User settings page, specify the values for the fields according to the instructions in the following table, and click Add partner.

   Field	Description
   Partner name	Required. From the Partner name drop-down list, select the partner to which a user is associated. A user can be associated with many partners. Note: Use the Sterling B2B Integrator dashboard to create trading partner entities.
   Upload mailbox path	Required. Configure the upload mailbox and assign users to operate the mailbox in Sterling B2B Integrator. Specify the mailbox path for the uploaded messages. You must assign a mailbox path to store the unpacked messages from an EBICS request. If the mailbox (User ID, Partner name, Inbox), already exists in Sterling B2B Integrator and if you leave this field blank, an error message asking you to specify the default mailbox path is displayed. Note: Ensure that the mailbox path starts with a forward slash (/).
   Download mailbox path	Required. Configure the download mailbox and assign users to operate the mailbox in Sterling B2B Integrator. Specify the mailbox path for the downloaded messages. You must assign a mailbox path to store the messages that are packaged as part of an EBICS response. If the mailbox (User ID, Partner name, Outbox) already exists in Sterling B2B Integrator, and if you leave this field blank, an error message asking you to specify the default mailbox path is displayed. Note: Ensure that the mailbox path starts with a forward slash (/).

10. This step is applicable if you selected to configure the user delegation settings for a Technical user. In the Associated Partners page, perform any of the following actions and click Next.
    • Click the add icon to associate a new partner with the Technical user.
    • Click the update icon next to the partner you want to edit.
    • Click the delete icon to disassociate a partner from the Technical user.
11. This step is applicable if you are configuring user delegation settings for a Technical user. In the Associated partner: User settings page, specify the values for the fields according to the instructions in the following table, and click Add partner.

    Field	Description
    Partner name	Required. From the Partner name drop-down list, select the partner to which a user is associated. A user can be associated with many partners. Note: Use the Sterling B2B Integrator dashboard to create trading partner entities.
    Delegate of	Required. Select the user who will be delegating their tasks to the technical user.

12. In the Associated Partners page, click Next.
13. In the Confirm page, verify the user configuration settings, and click Finish. You can also click the Show All link next to Associate Partners to view the list of partners associated with the user.

You can delete a user profile from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select User.
3. Using either Search or List, locate the user ID you want to delete and click GO.
4. Click the delete icon adjacent to the user ID you want to delete.
   Note: Deleting a user profile does not delete the corresponding mailboxes that have already been created.

You can create a bank profile to provide EBICS host information for a bank.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile Management menu, select Bank > Profile.
3. In the Bank Configuration page, next to Create Bank, click GO.
4. In the Bank Information page, specify the values for the fields according to the instructions in the following table and click Next.

   Field	Description
   Bank ID(Host ID)	Required. Enter the bank ID or the host ID provided by the bank. It is a unique ID for the bank in the bank's system.
   Bank name	Required. Specify the name of the bank.
   Status	Status of the bank is set to New before validating the bank keys. After successful validation, the status changes to Activated. The status cannot be edited.
   Is RSA preferred	Optional. If you want EBICS Client to use RSA key values for electronic signature, authentication, and encryption, select the check box. EBICS Client uses only RSA-related values for electronic signature, authentication, and encryption irrespective of the upload key type.
   Use ESIG Namespace	Optional. If you want EBICS Client to use an ESIG namespace, select the check box.
   Insert optional elements in KeyManagement request xml	Optional. If you want EBICS Client to use optional elements in the KeyManagement request xml file, select the check box.
   Address Line 1	Optional. Specify the address of the bank.
   Address Line 2	Optional. Specify the address of the bank.
   City	Optional. Specify the name of the city where the bank is located.
   State or Province	Optional. Specify the name of the state or province.
   Country/Region	Optional. Select the country or region.
   Zip or postal code	Optional. Specify the zip code or postal code.
   E-mail Address	Optional. Specify the e-mail address of the bank.
   Telephone Number	Optional. Specify the phone number with country code.

5. In the Associate URL page, click the add icon next to Associate Url, specify the values for the fields according to the instructions in the following table and click Add Url.

   URL Alias	Required. Specify a short name for the bank URL. You can navigate to the website of the bank by typing the short name or the alias in the address field of the browser. For example, if you specified bs as the URL alias for the URL http://www.banksystem.com, then type bs in the address field of the browser to go to the website.
   Is Default	Optional. Select this check box to indicate that the URL specified in the URL field is the default URL. If no URL is specified in the Bank URL field on the Order Information page when submitting an order, EBICS Client populates the default URL in the Bank URL field. If a bank URL alias is not specified, then the default URL is used for order submission when an order is submitted by a technical user.
   Bank URL	Required. Specify the HTTP URL the bank hosts. A bank can have multiple URLs with a minimum of one. The Uniform Resource Locator (URL) is configured in the HTTP Server adapter to listen at the port, and receive EBICS requests, if any. Note: Each bank ID should have a unique port number or URL.
   Bank https certificate	Optional. Select the appropriate HTTPS certificate of the bank from the drop-down list. The HTTPS certificate ensures that all transactions with the bank are encrypted and secure.

   After successful addition, the bank URL details are displayed in a tabular format in the Associate URL page.
6. Click Next.
7. In the Select Protocol Version page, click Retrieve supported protocol versions from bank. Select the appropriate Protocol version from the drop-down list and click Next.
8. In the Confirm page, verify the bank configuration settings and click Finish.

You can search for a bank profile from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Profile.
3. In the Bank Configuration page, perform one of the following actions, and click GO:
   • In the Bank ID(HostID) field under Search, enter either a part of the bank ID or the entire bank ID of the bank profile you are searching for.
   • From the Alphabetically drop-down list under List, select the letter with which the ID of the bank you are searching for, begins.

You can edit a bank profile to revise EBICS host information for a bank.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Profile.
3. In the Bank Configuration page, using either Search or List, locate and select the bank ID you want to edit, and click GO.
4. Click the update icon next to the bank ID you want to edit.
5. In the Bank Information page, specify the values for the fields according to the instructions in the following table and click Next.

   Field	Description
   Bank ID(Host ID)	Required. Enter the bank ID or the host ID provided by the bank. It is a unique ID for the bank in the bank's system.
   Bank name	Required. Specify the name of the bank.
   Status	Status of the bank is set to New before validating the bank keys. After successful validation, the status changes to Activated. The status cannot be edited.
   Is RSA preferred	Optional. If you want EBICS Client to use RSA key values for electronic signature, authentication, and encryption, select the check box. EBICS Client uses only RSA-related values for electronic signature, authentication, and encryption irrespective of the upload key type.
   Use ESIG Namespace	Optional. If you want EBICS Client to use an ESIG namespace, select the check box.
   Insert optional elements in KeyManagement request xml	Optional. If you want EBICS Client to use optional elements in the KeyManagement request xml file, select the check box.
   Address Line 1	Optional. Specify the address of the bank.
   Address Line 2	Optional. Specify the address of the bank.
   City	Optional. Specify the name of the city where the bank is located.
   State or Province	Optional. Specify the name of the state or province.
   Country/Region	Optional. Select the country or region.
   Zip or postal code	Optional. Specify the zip code or postal code.
   E-mail Address	Optional. Specify the e-mail address of the bank.
   Telephone Number	Optional. Specify the phone number with country code.

6. In the Associate URL page, click the update icon next to the bank ID that you want to edit, specify the values for the fields according to the instructions in the following table and click Add Url.

   URL Alias	Required. Specify a short name for the bank URL. You can navigate to the website of the bank by typing the short name or the alias in the address field of the browser. For example, if you specified bs as the URL alias for the URL http://www.banksystem.com, then type bs in the address field of the browser to go to the website.
   Is Default	Optional. Select this check box to indicate that the URL specified in the URL field is the default URL. If no URL is specified in the Bank URL field on the Order Information page when submitting an order, EBICS Client populates the default URL in the Bank URL field. If a bank URL alias is not specified, then the default URL is used for order submission when an order is submitted by a technical user.
   Bank URL	Required. Specify the HTTP URL the bank hosts. A bank can have multiple URLs with a minimum of one. The Uniform Resource Locator (URL) is configured in the HTTP Server adapter to listen at the port, and receive EBICS requests, if any. Note: Each bank ID should have a unique port number or URL.
   Bank https certificate	Optional. Select the appropriate HTTPS certificate of the bank from the drop-down list. The HTTPS certificate ensures that all transactions with the bank are encrypted and secure.

   After successful addition, the bank URL details are displayed in a tabular format in the Associate URL page.
7. Click Next.
8. In the Select Protocol Version page, click Next. The protocol version cannot be updated because of dependencies on the offer configuration and signatories.
9. In the Confirm page, verify the bank configuration settings and click Finish.

You can delete a bank profile from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Profile.
3. In the Bank Configuration page, using either Search or List, locate and select the Bank ID (Host ID) you want to delete, and click GO.
4. Click the delete icon next to the bank ID you want to delete.

To ascertain the authenticity of the bank's identification and authentication, and encryption keys, EBICS Client validates the hash value of the certificates that are received from the bank. After successful validation of the bank keys, the status of the bank changes to Activated.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Bank key validation.
3. In the Bank Key Validation page, specify the values for the fields according to the instructions in the following table:

   Field	Description
   BankID(Host ID)	Required. Select the Bank ID from the drop-down list.
   Identification and authentication key hash value(In hex format)	Required. Specify the identification and authentication key hash value provided by the bank.
   Hash Algorithm	Required. Select the hash algorithm of the identification and authentication key hash value. Valid values are: SHA1 (default) SHA256
   Encryption key hash value(In hex format)	Required. Specify the encryption key hash value provided by the bank.
   Hash Algorithm	Required. Select the hash algorithm of the encryption key hash value. Valid values are: SHA1 (default) SHA256

   Note:

   By default, the rsaHashKeyCompliant property in the ebics_client.properties file is false.

   When set to false, it generates the SHA-256 hash value for RSA keys, by concatenating the exponent with a blank character and the modulus in hexadecimal representation (using lower case letters).The resulting string is then converted into a byte array based on US ASCII code.

   When set to true it generates the SHA-256 hash value for RSA keys, by concatenating the exponent with a blank character and the modulus in hexadecimal representation (using lower case letters) without leading zero (as to the hexadecimal representation).The resulting string is then converted into a byte array based on US ASCII code.

   To change the property, set rsaHashKeyCompliant to true and restart the server.

   If rsaHashKeyCompliant property in the file is true then, set the Use modulus and exponent with space for Hash input in Initialization Letter and Use modulus and exponent with space for Hash input in Bank key validation properties to true using Ebics Client Administration Menu System Property. For more information, see ebics_client.properties.

4. Click Reset if you want to clear the existing values and enter new values.
5. Click Validate.

Offers enable a partner to group a set of order types and file formats and process them together. You can create an offer from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Offer configurations.
3. In the Offer Configuration page, next to Create new offer, click GO.
4. In the Create: Offer page, specify the values for the fields according to the instructions in the following table and click Finish.

   Field	Description
   Offer Name	Required. Specify a name for the offer.
   Bank ID(Host ID)	Required. Select a bank ID from the drop-down list.
   Associate/Disassociate order type to file formats configuration	Optional. Select the check box next to the order type. The selected order types and corresponding file formats are grouped to form an offer.

You can search for an offer from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Offer configurations.
3. In the Offer Configuration page, perform one of the following actions, and click GO.
   • In the Bank ID(HostID) field under Search, enter either a part of the bank ID or the entire bank ID with which the offer you are searching for is associated.
   • From the Alphabetically drop-down list under List, select the letter with which the offer name you are searching for, begins.

You can edit an offer from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Offer configurations.
3. In the Offer Configuration page, using either Search or List, locate and select the offer you want to edit, and click GO.
4. Click the update icon next to the offer you want to edit.
5. In the Update: Offer page, specify the values for the fields according to the instructions in the following table and click Finish.

   Field	Description
   Associate/Disassociate order type to file formats configuration	Optional. Select the check box next to the order type. The selected order types and the corresponding file formats are grouped to form the offer.

You can delete an offer from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select Bank > Offer configurations.
3. In the Offer Configuration page, using either Search or List, locate and select the offer you want to delete, and click GO.
4. Click the delete icon next to the offer you want to delete.

EBICS Client adds file formats and associate them with the bank-technical upload (FUL) and download (FDL) order types. An order type can have zero or more file formats. The file formats for FUL and FDL order types are based on the SWIFTNet request type.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select File formats.
3. In the File Format Configuration page, next to Create File Format, click GO.
4. In the Create: File Format page, enter the values for the fields listed in the following table and click Next.

   Field	Description
   File format	Required. Specify the name of the file format. The file format can be created with any name with these two restrictions: The first four characters should be from a to z. The name should contain a dot (.).
   Country/Region	Required. Select a country or region from the drop-down list.
   Supported order types	Required. Select the order type for which the file format is supported. For example, FUL, FDL.

5. In the Confirm page, verify the file format settings, and click Finish.

You can search for a file format from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select File formats.
3. In the File Format Configuration page, perform one of the following actions, and click GO.
   • In the File format field under Search, enter either a part of the file format name or the entire file format name you are searching for.
   • From the Alphabetically drop-down list under List, select the letter with which the file format that you are searching for, begins.
4. Click the file format link to view the file format settings.

You can edit a file format from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select File formats.
3. In the File Format Configuration page, using either Search or List, locate and select the file format you want to edit, and click GO.
4. Click the update icon next to the file format you want to edit.
5. In the Update: File Format page, specify the values for the fields according to the instructions in the following table and click Next.

   Field	Description
   Country/Region	Required. Select a country or region from the drop-down list.
   Supported order types	Required. Select the order type for which the file format is supported.

6. In the Confirm page, verify the values and click Finish.

You can delete a file format from the Profile Management menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Profile management menu, select File formats.
3. In the File Format Configuration page, using either Search or List, locate and select the offer you want to delete, and click GO.
4. Click the delete icon next to the file format you want to delete