DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and...

24
DNAWeb Core API Bridge App Installation and Configuration DNAX Name: DNAWebCoreAPI.dnax Application ID: 6173e7b6-5634-4d18-a6f9-ea56e2302e77

Transcript of DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and...

Page 1: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

DNAWeb Core API Bridge App Installation and Configuration

DNAX Name: DNAWebCoreAPI.dnax

Application ID: 6173e7b6-5634-4d18-a6f9-ea56e2302e77

Page 2: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

© 2019 Fiserv, Inc. or its affiliates. All rights reserved. This work is confidential and its use is strictly limited. Use is permitted only in accordance with the terms of the agreement under which it was furnished. Any other use, duplication, or dissemination without the prior written consent of Fiserv, Inc. or its affiliates is strictly prohibited. The information contained herein is subject to change without notice. Except as specified by the agreement under which the materials are furnished, Fiserv, Inc. and its affiliates do not accept any liabilities with respect to the information contained herein and are not responsible for any direct, indirect, special, consequential or exemplary damages resulting from the use of this information. No warranties, either express or implied, are granted or extended by this document.

http://www.fiserv.com

Fiserv is a registered trademark of Fiserv, Inc.

Page 3: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Table of Contents Overview ........................................................................................................................... 4 

Prerequisites ............................................................................................................. 4 

Installation Instructions .............................................................................................. 4 

Revisions ................................................................................................................... 4 

Manual DNA Configurations .............................................................................................. 5 

Prerequisite ............................................................................................................... 5 

Steps ......................................................................................................................... 5 

Create an Authorization ...................................................................................... 5 

Create a New Person in DNA ............................................................................. 9 

Create a New SAF User ..................................................................................... 9 

Set New DNA User as Employee ....................................................................... 9 

Assign DNAWeb Core API Interface Authorization .......................................... 10 

Create and Assign a Cashbox .......................................................................... 11 

Create Network Node ....................................................................................... 15 

Create a SAF Device ........................................................................................ 16 

Update Application Settings for Core API ......................................................... 17 

Run Update Scripts to Set Up Cashbox and Network Node ............................. 23 

Manual DNAweb Configurations ..................................................................................... 24 

Prerequisites ........................................................................................................... 24 

Navigation ............................................................................................................... 24 

Implementation Settings .......................................................................................... 24 

Page 4: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

DNAWeb Core API Bridge App Page 4 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Overview Core API exposes transaction messages to institutions via an interface. The interface permits access to the API messages and controls actions such as determining which messages can be accessed, and by whom, along with permission and licensing requirements. Interfaces used by the Core API are installed via a bridge app that links the API and the actual interface. Bridge apps are DNA apps installed via the DNA App Management Console. (See the “DNAapp Activate-Deactivate Process” online Help topic on the extranet for more information).

This DNAWeb Core API bridge app document outlines the major components necessary to integrate Core API with the DNAWeb Core API interface from Fiserv. Along with installing the DNAWeb Core API bridge app, DNA and DNAweb configurations must be completed, as outlined in the Manual DNA Configurations and Manual DNAweb Configurations sections, respectively.

Prerequisites To install, configure, and use the DNAWeb Core API interface in DNA, the following releases must be installed:

DNA release 4.5.1.0 or higher

Core API 2.4

DNAweb release 4.3.0 or higher

DNAweb Interface Plan V1.0.0.0

Installation Instructions To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence:

1. Install and configure the DNAWeb Core API bridge app as outlned in this document. (Note: If necessary, refer to the the "DNAapps" section of the DNA Help files on the extranet for more information about app installations.

2. Install the DNAweb interface plan as outlined in the DNAweb Interface Plan Update V1.0.0.0 document.

3. Configure DNAweb as outlined in the Manual DNAweb Configurations section of this document.

If you are an in-house client, follow the installation instructions available in the "DNAapps" section of the DNA Help files available on the extranet.

Note: Ensure this app is installed as an active app; no authorization key is required.

Revisions

Date App Version # Change

2/27/2019 1.0.0.0 Initial Version.

Page 5: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

DNAWeb Core API Bridge App Page 5 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Manual DNA Configurations After installing the DNAWeb Core API bridge app, the following steps must be performed to configure DNA and the DNAWeb Core API interface.

Prerequisite DNA release 4.5.1.0 or higher is required.

Steps Complete the steps below to configure DNA to integrate with the DNAWeb Core API bridge app.

Create an Authorization

4. In DNA, access the Authorization Manager screen to create an authorization for the DNAWeb Core API interface. (Navigate to Security > Authorizations)

5. Click Create.

Page 6: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 6 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

The Authorization Maintenance tab enables.

6. Complete the fields on the Authorization Maintenance tab as follows.

a. Type DWCI in the CODE field.

b. Type a job title or other description for the authorization in the DESCRIPTION field (e.g., DNAweb CoreAPI Interface).

c. Leave the PASSWORD field blank.

d. Allow the PARENT field to default to <None>.

e. Select the MASK TIN checkbox if employees assigned to this authorization can only view a portion of the taxpayer identification number (TIN).

f. Select the DISPLAY EMPLOYEE BALANCES checkbox if employees assigned to this authorization can view the balances of employee accounts.

g. Select the MASK PAN checkbox if employees assigned to this authorization can only view a portion of the primary account number (PAN).

h. Select the Review radio button and click Process.

The Authorization Item Maintenance tab enables.

Page 7: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 7 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

7. Click the Authorization Item Maintenance tab to view the Core API auth items linked to the DNAWeb Core API interface authorization.

The specific API messages for this authorization include the following: 7701, 7702, 7703, 7704, 7707, 7711, 7714, 7718, 7719, 7727, 7753, 7756, 7759, 7788, 7789, 7799, 7850, and DNAweb CoreAPI Interface

a. Select 7701 from the AVAILABLE list box.

b. Click Select > to move the role from the AVAILABLE list box to the SELECTED list box.

c. Repeat steps 4a and 4b for each message number listed in step 4.

Note: To remove a specific API message from the SELECTED list box, select it and click < Remove. The API message moves from the SELECTED list box to the AVAILABLE list box.

d. Select the Review radio button and click Process.

8. On the Authorization Item Maintenance tab, select one of the items in the SELECTED list box.

The Authorized Permission Maintenance tab enables.

9. Click the Authorization Permission Maintenance tab to see the available permissions for the specified API message item.

Page 8: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 8 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

The following screen illustrates permissions for the CAPR 7703 auth item.

a. Using the AVAILABLE and SELECTED list boxes, assign Employee Access and Update permissions to the specified API message.

b. Select the Review radio button and click Process.

c. Repeat steps 4 through 6 for each specified Core API message (e.g., 7701, 7702, etc.).

10. Click Process.

Page 9: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 9 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Create a New Person in DNA

1. In DNA, access the New Person Creation screen to create a new person record for the DNAWeb Core API interface using the standard procedures outlined in the DNA online help. (Navigate to Relationships > Wizards >New Person/Member)

2. Make note of the person number.

Create a New SAF User

1. Access the Form used to add and edit users screen to create a SAF user record for the new Interface person record created above using the standard procedures outlined in the DNA online help. (Navigate to SAF > Administration > User > Maintenance)

2. Ensure the SERVICE ACCOUNT checkbox is selected.

3. Ensure the Reference number in the Products group box matches the person number (referenced in step 2 of the Create a New Person in DNA section).

Set New DNA User as Employee

1. On the Edit Employee screen, designate the newly created DNAweb Core API interface user as an employee. (Navigate to Security > Employee)

2. Set the EFFECTIVE DATE prior to the posting date so the employee is immediately active.

3. Click Process.

Page 10: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 10 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Assign DNAWeb Core API Interface Authorization

1. On the Assign Authorizations tab of the Edit Employee screen, grant the DNAWeb Core API interface employee authorization to the bridge app by selecting the DNAWeb Core API interface authorization created earlier from the AVAILABLE list box and moving it to the SELECTED list box.

2. Click Process.

Page 11: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 11 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Create and Assign a Cashbox

1. Access the Cashbox Type Sub Boxes screen to create a new cashbox type. The new cashbox can then be assigned to the person for monetary transaction purposes. (Navigate to System > Institution > Cashbox Types)

2. Click Create. The Create Cashbox Type tab enables.

Page 12: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 12 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

3. Complete the fields on the Create Cashbox Type tab as follows.

a. In the CODE field, type CAPI.

b. In the DESCRIPTION field, type a job title or other description for the authorization (e.g., Core API cashbox).

c. In the MINIMUM CASH LIMIT field, type 0.

d. In the MAXIMUM CASH LIMIT field, type 999999999.

e. Select the Review radio button and click Process.

The Create SubBox tab enables.

4. Click the Create SubBox tab and create the sub boxes. Electronic Transfers, Electronic Transfers - Hold, and Journal Entry are the minimum expected sub boxes.

5. Click Process.

Page 13: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 13 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

6. Access the Cashbox Maintenance screen to establish a cashbox specific to Core API. (Navigate to Services >Institution > Cashbox)

7. Click Create. The Create Cashbox tab enables.

8. Complete the fields on the Create Cashbox tab as follows.

a. In the TYPE field, select Core API Cash Box from the dropdown list.

b. In the LOCATION field, select Main Office from the dropdown list.

c. In the DESCRIPTION field, type DNAWeb Core API or another description.

d. Select the BATCH checkbox.

e. Select the Review radio button and click Process.

Note: Individual cashboxes must be established for each DNAweb Core API interface device in the designated branch location.

Page 14: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 14 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

9. Assign the cashbox to the person created for the DNAWeb Core API interface (in the Create a New Person in DNA steps) and click Assign.

10. Make note of the cashbox number, as it is needed during the Run Update Scripts to Set Up Cashbox and Network Node steps.

Page 15: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 15 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Create Network Node

1. Access the Network Node Manager screen to create a network node using the standard procedures outlined in the DNA online help. (Navigate to System >Manage > Network Nodes)

2. In the NAME field, type a unique name for the network node. In the below example, we use DNAWEBUSER. Important! The network name entered in this step must be the same name entered in the script in the Run Update Scripts to Set Up Cashbox and Network Node section.

3. In the PHYSICAL ADDRESS field, type a unique name. In the below example, we use DNAWebUser.

4. Click Process.

Note: Additional network node(s) must be established for each DNAWeb Core API interface device dependent on the location.

Page 16: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 16 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Create a SAF Device

1. Access the Form used to add and edit devices screen to create a SAF device using the standard procedures outlined in the DNA online help. (Navigate to SAF > Administration > Device > Device).

2. Ensure the Device Uses WORKSTATION option is selected and the NETWORK NAME is the same name provided in step 2 of the Create Network Node section.

3. Click Process.

Page 17: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 17 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Update Application Settings for Core API

1. Access the Application Manager screen to update variables and application IDs. (Navigate to System > Institution > Applications)

2. Select Core API Application from the APPLICATION TYPE dropdown.

3. Select the DNAWeb Core API Interface line item in the Application grid and record the value displayed in the Number column (516137 is the value in the below example).

4. Click Edit. The Edit Application tab enables.

5. Select the Review radio button and click Process.

Page 18: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 18 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

6. Click the Variables menu item to access the Application Variables screen.

7. On the Application Variables screen, scroll through Application Variables Categories grid and select the CAPI (Core API Processing) line item.

8. Click Edit. The Application Variable Types group box enables.

a. If Core Api Processing is not in the Selected list box, use the Select > button to move it to the Selected list box.

b. Select the Review radio button and click Process.

c. Click the Detail menu item to access the Application Variable Maintenance screen.

Page 19: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 19 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

d. On the Application Variable Maintenance screen, select Person Number for Appl in the VARIABLE NAME dropdown list and click Yes when prompted to assign a variable value.

e. In the OPTION VALUE field of the Application Variable Value Maintenance group box, type the person number associated with either the new user created in the Create a New Person in DNA section or an existing user.

f. Click Process and then select Close to close the Application Variable Maintenance screen.

Page 20: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 20 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

9. Click Close to close the Application Variables screen.

10. On the Application Manager screen, click the Variables menu item to access the Application Variables screen.

11. On the Application Variables screen, scroll through Application Variables Categories grid and select the VALD (Validate) line item.

12. Click Edit. The Application Variable Types group box enables.

a. If Core API Security/Info is not in the Selected list box, use the Select > button to move it to the Selected list box.

b. Select the Review radio button and click Process.

c. Click the Detail menu item to access the Application Variable Maintenance screen.

Page 21: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 21 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

d. On the Application Variable Maintenance screen, select Valid Auth Types for Core API in the VARIABLE NAME dropdown list.

e. Click Edit. The Application Variable Value Maintenance group box activates.

Page 22: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 22 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

f. In the OPTION VALUE field of the Application Variable Value Maintenance group box, type value 2.

g. Click Process and then select Close to close the Application Variable Maintenance screen.

13. Click Close to close the Application Variables screen.

14. Click Close to close the Application Manager screen.

Page 23: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 23 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Run Update Scripts to Set Up Cashbox and Network Node An administrator with Oracle SQL permissions should run the following SQL scripts in the OSIBANK schema to set up the CAPI appl CashBoxNbr and Network Node CashBoxNbr:

update appl a set a.cashboxnbr = CashBoxNbr where applid = '6173e7b6-5634-4d18-a6f9-ea56e2302e77';

update ntwknode n set n.cashboxnbr = CashBoxNbr where NTWKNODENAME = 'DNAWEBUSER';

Important!: Before running the above update script, review the following values and update them, if needed:

Replace the highlighted CashBoxNbr values with the cashbox number of the cashbox assigned to the new DNAWeb Core API interface person in step 9 of the “Create and Assign a Cashbox” section.

If you used a name other than DNAWEBUSER, replace the highlighted NTWKNODENAME value with the network node name created in step 2 of the “Create Network Node” section.

Note: The network node script should be run for each network node and cashbox assignment that is established.

Page 24: DNAweb Core API Bridge App Installation and Configuration...To ensure proper installation and configuration of the DNAweb components, follow the below installation sequence: 1. Install

Manual DNA Configurations

DNAWeb Core API Bridge App Page 24 October 2019 Installation and Configuration

Confidential – Limited Distribution restricted to DNA clients and Fiserv associates.

Manual DNAweb Configurations After installing the DNAWeb Core API bridge app, the DNAweb implementation settings listed in the table below must be updated to support the enhanced Quick Enroll module included with DNAweb Release 4.3.0.

Note: The information for the values in these settings is only available after the DNAWeb Core API bridge app is installed and configuration is complete.

Prerequisites DNAweb release 4.3.0 or higher is required

DNAweb Interface Plan V1.0.0.0.0

Navigation In DNAweb, the navigation path is:

System Configuration > Implementation Settings > FI Profile > Server Controls

Implementation Settings

Setting Category Setting Group Setting Name Setting Description

FI Profile Server Controls CoreAPIPhysAddr DNA Core API physical address.

(Name provided in Step 2, page 16)

FI Profile Server Controls CoreAPIApplNbr DNA Core API application number. (Number provided in Step 3, page 18)

FI Profile Server Controls CoreAPIUserId DNA Core API user ID.

(Name provided in Step 4a, page 18

FI Profile Server Controls CoreAPIAuthType DNA Core API authentication type.

(Value provided in Step 11f, page 23)