GPP SOA Guide Static Data

User Manual: Pdf

Open the PDF directly: View PDF PDF.
Page Count: 43

DownloadGPP SOA Guide Static Data
Open PDF In BrowserView PDF
Global PAYplus Version 4.6.2
Static Data Services
Service-Oriented Architecture Guide

Copyright
© 2009-2016 D+H Global Transaction Banking Solutions. All rights reserved. D+H is a trademark of D+H Limited
Partnership.
PROPRIETARY AND CONFIDENTIAL - This document contains information, which contains Confidential and
Know How property of D+H. Disclosure to or use by persons who are not expressly authorized in writing by D+H
is strictly prohibited.
D+H reserves the right to alter the specifications and descriptions in this publication without prior notice. No part
of this publication shall be deemed to be part of any contract or warranty unless specifically incorporated by
reference into such contract or warranty.
All brand or product names are the trademarks or registered trademarks of their respective holders.
The information contained herein is merely descriptive in nature, and does not constitute a binding offer for the
license of the product described herein.
Catalog ID: GPP4.6-00-S02-03-201603

Static Data Services

Version Control

Version Control
Version

Date

Summary of Changes

3.0

December 2015

Document updated for rebranding

Global PAYplus Service-Oriented Architecture Guide

Page 3

Static Data Services

Table of Contents

Table of Contents
1

OVERVIEW .................................................................................................................................. 6
1.1
1.2
1.3

2

Introduction ........................................................................................................................... 6
About This Book .................................................................................................................... 6
Service Input Table Legend .................................................................................................. 6
APPLY CHANGES SERVICE ..................................................................................................... 7

2.1
2.2
2.3
2.4
2.5
2.6
2.7
2.7.1
2.7.2
3

Overview ............................................................................................................................... 7
Service Function ................................................................................................................... 7
Input ...................................................................................................................................... 7
Processing ............................................................................................................................ 8
Output ................................................................................................................................... 8
Error Codes ........................................................................................................................... 8
Examples .............................................................................................................................. 8
Apply Changes Request.................................................................................................... 8
Apply Changes Response ................................................................................................. 9

LOAD PROFILE SERVICE........................................................................................................ 10
3.1
3.2
3.3
3.4
3.5
3.6
3.7
3.7.1
3.7.2

4

Overview ............................................................................................................................. 10
Service Function ................................................................................................................. 10
Input .................................................................................................................................... 10
Processing .......................................................................................................................... 11
Output ................................................................................................................................. 11
Error Codes ......................................................................................................................... 11
Examples ............................................................................................................................ 12
Load Profile Request ....................................................................................................... 12
Load Profile Response .................................................................................................... 12

PROFILE ACTIONS SERVICE.................................................................................................. 15
4.1
4.2
4.3
4.4
4.5
4.6
4.7
4.7.1
4.7.2
4.7.3
4.7.4
4.7.5
4.7.6
4.7.7
4.7.8

5

Overview ............................................................................................................................. 15
Service Function ................................................................................................................. 15
Input .................................................................................................................................... 15
Processing .......................................................................................................................... 16
Output ................................................................................................................................. 17
Error Codes ......................................................................................................................... 17
Examples ............................................................................................................................ 17
Activate Profile................................................................................................................. 17
Approve Profile ................................................................................................................ 18
Decline Profile ................................................................................................................. 19
Delete Profile ................................................................................................................... 20
Hold Profile ...................................................................................................................... 21
Save Profile – New .......................................................................................................... 21
Save Profile - Update ...................................................................................................... 22
ProfileMultiActions Example ............................................................................................ 23

PROFILE LIST SERVICE .......................................................................................................... 25
5.1
5.2
5.3

Overview ............................................................................................................................. 25
Service Function ................................................................................................................. 25
Input .................................................................................................................................... 25

Global PAYplus Service-Oriented Architecture Guide

Page 4

Static Data Services

5.4
5.5
5.6
5.7
5.7.1
5.7.2

Table of Contents

Processing .......................................................................................................................... 27
Output ................................................................................................................................. 27
Error Codes ......................................................................................................................... 27
Examples ............................................................................................................................ 28
List Profile Request ......................................................................................................... 28
List Profile Response ...................................................................................................... 28

6

GENERIC ERROR CODES ....................................................................................................... 30

7

SYSTEM USERS, PROFILES & DB MAINTENANCE QUERIES ............................................ 31
7.1
System Users ...................................................................................................................... 31
7.2
System Entitlements ........................................................................................................... 31
7.3
Profiles and Profile IDs ....................................................................................................... 31
7.4
Profile Fields ....................................................................................................................... 33
7.4.1
Exchange Rate Profile (EXCHRATE_BU Table) ............................................................ 33
7.4.2
Settlement Instruction Profile (Bank Routing table) ........................................................ 34
7.4.3
User Codes Profile .......................................................................................................... 34
7.4.4
Value List Types for Rules Profile ................................................................................... 35
7.4.5
Value List for Rules Profile .............................................................................................. 35
7.4.6
Codeword Profile ............................................................................................................. 35
7.4.7
Departments Profile ......................................................................................................... 36
7.4.8
Product Profile ................................................................................................................. 36
7.4.9
Stop Flags Profile ............................................................................................................ 36
7.4.10 Transaction Codes Profile ............................................................................................... 36
7.4.11 Calendar Profile ............................................................................................................... 37
7.4.12 Time Zone Profile ............................................................................................................ 37
7.4.13 Users Profile .................................................................................................................... 37
7.4.14 Business Area Profile ...................................................................................................... 38
7.4.15 System Parameters ......................................................................................................... 38
7.4.16 NCC Profile...................................................................................................................... 39
7.4.17 Customers Profile ............................................................................................................ 40
7.4.18 Accounts Profile............................................................................................................... 40
7.4.19 Membership ..................................................................................................................... 41
7.5
Database Maintenance Queries ......................................................................................... 41

APPENDIX A: GLOSSARY .................................................................................................................. 43

Global PAYplus Service-Oriented Architecture Guide

Page 5

Static Data Services

1

Overview

Overview

Note: This SOA Guide has not yet been certified for GPP V4.6; therefore, there may be inaccuracies
in this document that may require amendments in the future. For more information, please contact
your D+H Project Manager.

1.1

Introduction

GPP is a robust payment engine whose workflow emulates the business flow of a bank or financial
institution. Configurable reference data profiles control the sequence of workflow steps and the
actions performed in each step.
This document describes the different services that help create, manage, and control the different
static data profiles in GPP.

1.2

About This Book

This SOA Guide describes GPP Web services that are based on a Service-Oriented Architecture
(SOA) concept, which enables third party applications to interact with GPP.
It includes information about these services:
•

ApplyChangesService: Applies recent updates made to static data.

•

LoadProfileService: Loads a specific profile entry according to the service request.

•

ProfileActionsService: Takes an action, such as create or delete, on a profile.

•

ProfileListService: Loads a list of applicable profile attributes per search criteria.

1.3

Service Input Table Legend

These are the symbols used in Service Input tables in this guide.
Symbol

Description

L

Element level in the file

++++

Shows the element indentation

Global PAYplus Service-Oriented Architecture Guide

Page 6

Static Data Services

2

Apply Changes Service

Apply Changes Service

2.1

Overview

This service enables a third party application to apply recent updates that were made to specific
profiles.
The same functionality is accessible using the Apply Changes dialog box in the GPP user interface.

2.2

Service Function

This service supports the applyChanges function.

2.3

Input

This table includes the input parameters for this service.
Parameter

Tag Name

L

Format

Comment

Header

Header

0

Request Header

D+H Header

+FndtHeader

1

Service Header

Credentials

++Credentials

2

Credentials

User ID

+++UserID

3

A valid GPP user (see List of System Users).
User name is case sensitive. Use the exact
user name.
The user must have these credentials: User
exists, and active (status = AC) and not logged
in (LOGGED_IN <> 2)

User
Entitlement
code

+++Role

3

A valid GPP Entitlement profile (see List of
System Entitlements). Credentials check: The
entitlement exists and is assigned to the user
logged in. Also, where applicable, the relevant
access permission is granted

Body

Body

0

Service Body

Header

+Header

1

Header

User ID

++UserID

2

STRING {0..1}

Audit user only. This input does not go through
a validation process. Where applicable, this
would be used as the audit user.

Effective
date

+effectiveDate

1

Date

When specified date is greater than the local
office business date the profile will be saved
with a future status and will only become
effective on that date.

Unique
Profile IDs

+profileIDs

1

STRING {1..1}

Each profile in GPP has a unique ID. Each
profile in the tag (except for the last profile)
must be followed by a comma (,). The list of
profiles is defined under MENU_ITEMS system
table.
For a list of frequently used profiles, see
Frequently Used Profiles. For a complete list,
see Profiles and Profile IDs.

Global PAYplus Service-Oriented Architecture Guide

Page 7

Static Data Services

2.4

Apply Changes Service

Processing

The system processes this service request as follows:
1. The profile IDs in the profileIDs tag are converted to cache IDs.
2. Related caches are evaluated.
3. Invalid profile IDs are ignored.
4. Changes are applied and the cache is refreshed for each valid profile ID.
5. A response is returned.

2.5

Output

This table includes the output parameters for this service.
Parameter

2.6

Tag Name

L Format

Comment

+compCode

2 NUMBER

A return code, indicating the return error where
applicable. 0 means passed successfully

info

2 STRING

If compCode has a value other than 0, a description of
the error

Error Codes

The system does not return service specific error codes in the response to an ApplyChangesService
request.
The system does not process any invalid profile IDs in the profileIDs tag.
For more information, see Generic Error Codes.

2.7
2.7.1

Examples
Apply Changes Request

This is a request for this service:




PRANITA1
ADMIN






AUDIT_U

2010-01-01
P416,P417




Global PAYplus Service-Oriented Architecture Guide

Page 8

Static Data Services

2.7.2

Apply Changes Service

Apply Changes Response

This is a response for this service:



0





Global PAYplus Service-Oriented Architecture Guide

Page 9

Static Data Services

3

Load Profile Service

Load Profile Service

3.1

Overview

The service enables a third party application to retrieve a single entry per profile by providing both the
profile unique ID and the entry unique ID.

3.2

Service Function

This service supports the performLoadProfile function.

3.3

Input

This table includes the input parameters for this service.
Parameter

Tag Name

L

Format

Comment

Header

Header

0

Request Header

D+H Header

+FndtHeader

1

Service Header

Credentials

++Credentials

2

Credentials

User ID

+++UserID

3

A valid GPP user (see List of System Users). User
name is case sensitive. Use the exact user name.
The user must have these credentials: User exists,
and active (status = AC) and not logged in
(LOGGED_IN <> 2)

User
Entitlement
code

+++Role

3

A valid GPP Entitlement profile (see List of System
Entitlements). Credentials check: The entitlement
exists and is assigned to the user logged in. Also,
where applicable, the relevant access permission is
granted

Body

Body

0

Service Body

Header

+Header

1

Header

User ID

++UserID

2

STRING
{0..1}

Audit user only. Optional parameter that is not
validated. Where applicable, this is the audit user.

Unique Profile
ID

+profileID

1

STRING
{1..1}

Each profile in GPP has a unique ID. To specify the
correct profile for a query, a profile ID must be
provided. The list of profiles is defined under
MENU_ITEMS system table.
For a list of frequently used profiles, see Frequently
Used Profiles. For a complete list, see Profiles and
Profile IDs.

Unique Profile
record ID

+profileRecor
dUniqueID

1

Specify the Unique ID (UID) for the specified profile.
The field name is a concatenation of UID and
[profile name].
Example: MOP profile (ID = 32) UID_MOP possible
value: ‘***^SWIFT’

Global PAYplus Service-Oriented Architecture Guide

Page 10

Static Data Services

3.4

Load Profile Service

Processing

The system processes this service request as follows:
1. The input parameters are validated. When the profile ID cannot be found or is not provided, an
error is generated.
2. Profile query is generated.
3. All relevant attributes are returned.

3.5

Output

The full profile data information is received as output from this service.
This table includes the output parameters for this service.
Parameter

Tag Name

L

Format

Comment

Records

record

0

{0..n}

Record – result entry

Field
Field Name

+name

1

Result columns specification

2

Specifies the column name (logical field ID) & then
the field value.
Example:
US1
Office is the field name and then US1 is the field
name value.

Summary

Feedback

1

+compCode

2

Result summary

NUMBER

A return code, indicating the return error where
applicable. 0 means passed successfully

An unsuccessful request generates a response with these elements:
• compCode: Contains a relevant error code for the unsuccessful request
•

info: Contains a description of the error

3.6

Error Codes

This table includes the error codes for this service.
Code

Description

40232

Profile with ID [Profile ID] does not exist

An unsuccessful request generates a response with these elements:
•

compCode: Contains a relevant error code for the unsuccessful request

•

info: Contains a description of the error

For more information, see Generic Error Codes.

Global PAYplus Service-Oriented Architecture Guide

Page 11

Static Data Services

3.7
3.7.1

Load Profile Service

Examples
Load Profile Request

Request an entry from accounts table (profile ID 28) with unique ID as ‘US1^44478521^USD’




YONIS
ADMIN







user

28
US1^44478521^USD




3.7.2

Load Profile Response

This is a response for this service.







0
0
0
-1500.0

USD

0
1
0
0
0
0
0

0

0
FU
0
US1^44478521^USD
0

0


Global PAYplus Service-Oriented Architecture Guide

Page 12

Static Data Services

Load Profile Service

0
0

0
0

PSV
0
USD
DDA
US1SABOFAFRPPXXX
0
0
44478521
1
0

0
2010-03-02 00:00:00.0
0
1

0
0


1
-500.0


1
0
0
0
BANK OF AMERICA, N.A. PARIS
US1^testm5~testm5~DATE~ ~0~@US1^meital2~meital2~DATE~
~0~@US1^TEST~TEST~STRING~ ~0~@
0

9999
0

0

0
N


0
AC
0



0
0

2010-05-26 07:48:36.689





-500
US1

0
0
0
0

Global PAYplus Service-Oriented Architecture Guide

Page 13

Static Data Services

Load Profile Service

0
0


0
1500

0

0
0



US1
BOFAFRPPXXX// - BANK OF AMERICA, N.A. PARIS
4565432
-1500.0
0
0




0



0





Global PAYplus Service-Oriented Architecture Guide

Page 14

Static Data Services

4

Profile Actions Service

Profile Actions Service

4.1

Overview

This service enables a third party application to perform different actions on a static data profile, such
as Save, Hold, Delete and Activate. These action buttons are taken from GPP user interface.

4.2

Service Function

This table includes the functions (Static Data Actions) support by this service.
Each of these options is available as an individual service.
Button

Description

Function Name

Save

Saves a new profile entry into the database

profileSave

Hold

Sets an existing entry to status hold (until a further time is
defined by Effective Date attribute)

profileHold

Delete

Deletes (soft delete: set status to DL) a specific entry

profileDelete

Activate

Changes a specific status to AC (active)

profileActivate

Decline

Where a profile is pending approval (status PN), reverts to
previous values

profileDecline

Approve

Approves a pending profile (status PN) and applies the
proposed (pending) new attribute values. Sets new status to AC
(active)

profileApprove

N/A

Enables multiple actions on multiple records in a single request.
This service can be used for static data uploads.
Supports all actions for this service using these values in the
ProfileActionType:
• SV: Save
• HD: Hold
• DL: Delete
• AC: Activate
• DC: Decline
• AP: Approve

profileMultiActions

4.3

Input

This table includes the input parameters for this service.
Parameter

Tag Name

L

Format

Comment

Header

Header

0

Request Header

D+H header

+FndtHeader

1

Service Header

Credentials

++Credentials

2

Credentials

User ID

+++UserID

3

A valid GPP user (see List of System
Users). User name is case sensitive. Use
the exact user name.
The user must have these credentials:
User exists, and active (status = AC) and
not logged in (LOGGED_IN <> 2)

Global PAYplus Service-Oriented Architecture Guide

Page 15

Static Data Services

Profile Actions Service

Parameter

Tag Name

User
Entitlement
code

+++Role

3

A valid GPP Entitlement profile (see List
of System Entitlements). Credentials
check: The entitlement exists and is
assigned to the user logged in. Also,
where applicable, the relevant access
permission is granted

Body

Body

0

Service Body

Header

+Header

1

Header

User ID

++UserID

2

STRING {0..1}

Audit user only. This input does not go
through a validation process. Where
applicable, this would be used as the
audit user.

Profile ID

+profileID

1

STRING {1..1}

Each profile in GPP has a unique ID. To
specify the correct profile for a query, a
profile ID must be provided. The list of
profiles is defined under MENU_ITEMS
system table.
For a list of profiles, see Profiles and
Profile IDs.

Unique
Profile ID

profileUniqueID

String

[1..1]

Each profile in GPP has a unique ID. To
specify the correct profile for a query, a
profile ID must be provided. For a new
profile, this section is empty. The list of
profiles is defined under MENU_ITEMS
system table.
For a list of profiles, , see Profiles and
Profile IDs.

Effective
date

+effectiveDate

1

String in this
format:
YYYY-MM-DD
hh:mm:ss:ms

When specified date is greater than the
local office business date the profile is
saved with a future status and will only
become effective on that date.

User audit
note

+note

1

String

Time Stamp

+timeStamp

1

String in this
format:
YYYY-MM-DD
hh:mm:ss:ms

record

Record

1

{1..n}

Record
entry

field name
dataType

2

{0..1}

?

Field**

Field

[1..n]

Static data field type

4.4

L

Format

Comment

Processing

The system processes this service request as follows:
1. The input parameters are validated. When the profile ID cannot be found or is not provided, an
error is generated.
2. The list of applicable profile IDs is defined in the system (MENU_ITEMS.ITEM_ID).

Global PAYplus Service-Oriented Architecture Guide

Page 16

Static Data Services

Profile Actions Service

3. Profile query is generated.
4. These are valid statuses (selection from system table FIELDS_VALUES with FIELD_TYPE =
'REC_STAT’).
This table includes the status codes for this service.
Code

Description

AC

Active

CR

Create

DL

Delete

HL

Hold

NW
New
All relevant attributes are returned.

4.5

Output

This table includes the output parameters for this service.
Parameter

4.6

Tag Name

L

Format

Comment

+compCode

2

NUMBER

A return code, indicating the return error where
applicable. 0 means passed successfully

info

2

STRING

If compCode has a value other than 0, a description
of the error

Error Codes

This table includes the error codes for this service.
Code

Description

28560

Record is not in active status, the action is not permitted

28560

Following required fields are missing in the service call [missing field]

An unsuccessful request generates a response with these elements:
•

compCode: Contains a relevant error code for the unsuccessful request

•

info: Contains a description of the error

Note: An error returned for any action on any record in a ProfileMultiActions request causes the
system to rollback all actions on all records in the request to their original states.
For more information, see Generic Error Codes.

4.7

Examples

4.7.1
4.7.1.1

Activate Profile
Request

This request contains a profile ID and a unique identification code.

Global PAYplus Service-Oriented Architecture Guide

Page 17

Static Data Services

Profile Actions Service





YONIS
DEMOSOA






YONIS
DEMOSOA

191
2009-04-05
PARTIES1




4.7.1.2

Response

This is a response for this service.




0





4.7.2
4.7.2.1

Approve Profile
Request

This request contains a profile ID and a unique identification code.




YONIS
DEMOSOA







Global PAYplus Service-Oriented Architecture Guide

Page 18

Static Data Services

Profile Actions Service

YONIS
DEMOSOA

191
2009-04-05
PRO123




4.7.2.2

Response

This is a response for this service.




0





4.7.3
4.7.3.1

Decline Profile
Request

This request contains a profile ID and a unique identification code.




YONIS
DEMOSOA






YONIS
DEMOSOA

191
2009-04-05
PR789




4.7.3.2

Response

This is a response for this service.


Global PAYplus Service-Oriented Architecture Guide

Page 19

Static Data Services

Profile Actions Service




0





4.7.4
4.7.4.1

Delete Profile
Request

This is a request contains a profile ID and a unique identification code.




YONIS
DEMOSOA






YONIS
DEMOSOA

191
2009-04-05
PARTIES1




4.7.4.2

Response

This is a response for this service.




0





Global PAYplus Service-Oriented Architecture Guide

Page 20

Static Data Services

4.7.5
4.7.5.1

Profile Actions Service

Hold Profile
Request

This request contains a profile ID, a unique identification code, and an effective date.




YONIS
DEMOSOA






YONIS
DEMOSOA

191
2009-04-05
PARTIES1




4.7.5.2

Response

This is a response for this service.




0





4.7.6
4.7.6.1

Save Profile – New
Request

This request contain a profile ID (27 for BANKS), which is the Office profile, and a list of mandatory
attributes.




HANA1
MASTER

Global PAYplus Service-Oriented Architecture Guide

Page 21

Static Data Services

Profile Actions Service






27
2009-04-05

BBB
BBB
BBB
EUR
GB
GB





4.7.6.2

Response

This is a response for this service.



0





4.7.7
4.7.7.1

Save Profile - Update
Request

This requesst updates the country code of the profile to IN.




YONIS
DEMOSOA






YONIS
DEMOSOA

191
2009-04-05

PARTIES1
BBB
BBC

Global PAYplus Service-Oriented Architecture Guide

Page 22

Static Data Services

Profile Actions Service

Name1
IN
BK





4.7.7.2

Response

This is a response for this service.




0





4.7.8

ProfileMultiActions Example

The ProfileActionsService ProfileMultiActions request enables the system to perform multiple actions
on multiple records in a single request.
•

Multiple Actions Request shows a ProfileMultiActions request example.

•

Multiple Actions Response shows a ProfileMultiActions response example.

Note: An error returned for any action on any record in a ProfileMultiActions request causes the
system to rollback all actions on all records in the request to their original states.
For more information about the ProfileActionsService service, see Overview.
4.7.8.1

Multiple Actions Request

This ProfileMultiActions request shows these actions:
•

Save: Indicated by SV in the action attribute of the record element. The request saves a new
profile entry in the database with the specified values.

•

Hold: Indicated by HD in the action attribute of the record element. The request sets the
specified profile entry with a HOLD status.





ADMIN6
ADMIN






U_AUDIT

Global PAYplus Service-Oriented Architecture Guide

Page 23

Static Data Services

Profile Actions Service


459
2010-11-17
true
1


US1
PSV
ABCD
12345


US1
PSV
ABCD
12345






4.7.8.2

Multiple Actions Response

This ProfileMultiActions response shows a successful completion to a request, which is indicated by a
0 value in the returnCode element.

0









Global PAYplus Service-Oriented Architecture Guide

Page 24

Static Data Services

5

Profile List Service

Profile List Service

5.1

Overview

The Get Profile List service enables a third party application to retrieve any related reference data
(also known as profiles in GPP) by providing a set of query criteria. The service assesses the relevant
selected profile and returns the matching results. For example, from the Parties profile, get a list of
parties (BIC, party name and address) where BIC is like ’FNDTGB22%’. The service response would
be all entries from the Parties profiles that meet this search criterion.

5.2

Service Function

This service supports the getProfileList function.

5.3

Input

This table includes the input parameters for this service.

Parameter

Tag Name

L

Format

Header

Header

0

Request Header

D+H Header

+FndtHeader

1

Service Header

Credentials

++Credentials

2

Credentials

User ID

+++UserID

3

A valid GPP user (see List of System
Users). User name is case sensitive. Use
the exact user name.
The user must have these credentials:
User exists, and active (status = AC) and
not logged in (LOGGED_IN <> 2)

User Entitlement
code

+++Role

3

A valid GPP Entitlement profile (see List
of System Entitlements). Credentials
check: The entitlement exists and is
assigned to the user logged in. Also,
where applicable, the relevant access
permission is granted

Body

Body

0

Service Body

Header

+Header

1

Header

User ID

++UserID

2

STRING
{0..1}

Audit user only. This input does not go
through a validation process. Where
applicable, this would be used as the
audit user.

Profile ID

+profileID

1

STRING
{1..1}

Each profile in GPP has a unique ID. To
specify the correct profile for a query, a
profile ID must be provided. The list of
profiles is defined under MENU_ITEMS
system table.
For a list of frequently used profiles, see
Frequently Used Profiles. For a complete
list, see Profiles and Profile IDs.

Searching filter

+ profileFilter

1

{0..n}

Optional. An ability to define search
criteria over the profile query. When not

Global PAYplus Service-Oriented Architecture Guide

Comment

Page 25

Static Data Services

Parameter

Profile List Service

Tag Name

L

Format

Comment
provided, all the queried profile fields
return

aggregationMethod

++
aggregationMetho
d

2

Condition

+++condition

3

Field name

+++ fieldname

Operator

+++ operator

ALL,
ANY
{1..1}

When more than 1 criterion is set,
specifies the relationship between the
different conditions.
Either ALL (where all criteria must be
met) or ANY where at least one of the
criteria must be met

3

STRING
{1..1}

Field name must include the full database
field name (i.e. table name, then field
name). The list of applicable fields per
profile is detailed in GPP data model.
Example:
ACCOUNTS.CURREN
CY

3

Equal,
Like,
Greater
Than,
Less
Than,
Betwee
n, Starts
With,En
ds With
{1..1}

The operator element is comprised of 2
fields. A true/false indicator to state
whether ‘not’ is used (for example: not
like …). The second indication is of the
operator, which is only one of the
specified available operators.
Example:
Equal
Note: Operators are case sensitive

Field value

+++ fieldValue

3

STRING
{1..1}

Field value.
Example:
EUR

Required columns
in response

++
requiredColumns

2

{0..n}

Specifies the return columns for the
response. When not specified, the
response includes all profile columns.

Column name

+++Column

3

STRING
{0..1}

Specifies the column full name.
Example: ACCOUNTS.CURRENCY
Optional.
The list of applicable columns is defined
in a system table
(SD_PROFILE_FIELDS.
AVAILABLE_FOR_LIST_VIEW).
When not defined, the system uses the
default list of columns
(SD_PROFILE_FIELDS.
MANDATORY_IN_LIST_VIEW).
See the GPP SOA Static Data Fields
Reference Document for further
reference.

Global PAYplus Service-Oriented Architecture Guide

Page 26

Static Data Services

5.4

Profile List Service

Processing

The system processes this service request as follows:
1. The input parameters are validated. When the profile ID cannot be found, an error is generated.
2. Required columns are checked. If a column is not found the database, it is ignored and a relevant
log entry is made in nonExistCols.
3. Profile query is generated.
4. Results are returned (where no preferred columns were defined, return all profile columns).

5.5

Output

This table includes the output parameters for this service.
Parameter

Tag Name

L

Format

Comment

Records

record

0

{0..n}

Record – result entry

Field

1

Result columns specification

Field Name

+name

2

{1..1}

Specifies the column name (logical field ID)

Data Type

+dataType

2

{1..1}

Sepcifies the column data type. May be STRING,

2

{0..1}

Value of the field

Entry value
Summary

Feedback

1

+compCode

2

Result summary

NUMBER

A return code, indicating the return error where
applicable. 0 means passed successfully.

Note: If no columns are specified in requiredColumns, the list of all profile fields where a default is
provided is followed by a VIRTUAL.UID, which contains a unique entry ID. This is also stated under
the profile UID field.

5.6

Error Codes

This table includes the error codes for this service.
Code

Description

40208

Invalid Filter, these columns are not applicable: [requested
columns which do not exist]

40232

Profile with ID [Profile ID] does not exist

28560

String value 'EQUAL' is not a valid enumeration value for
FilterOperatorType in namespace
http://fundtech.com/SCL/ProfileListService

The operator is
case sensitive

An unsuccessful request generates a response with these elements:
•

compCode: Contains a relevant error code for the unsuccessful request

•

info: Contains a description of the error

For more information, see Generic Error Codes.

Global PAYplus Service-Oriented Architecture Guide

Page 27

Static Data Services

5.7
5.7.1

Profile List Service

Examples
List Profile Request

This request contains a profile ID (28) and currency (EUR), and requests to return these columns
ACC_NO, DEPARTMENT, and ACC_TYPE, ALIAS.




YONIS
ADMIN







audit

28




ACCOUNTS.CURRENCY
Equal
EUR




ACCOUNTS.ACC_NO
ACCOUNTS.DEPARTMENT
ACCOUNTS.ACC_TYPE
ACCOUNTS.ACC_ALIAS





5.7.2

List Profile Response

This is a response for this service.





55559987
PSV
NOS



0500013002606
PSV
DDA

Global PAYplus Service-Oriented Architecture Guide

Page 28

Static Data Services

Profile List Service




1234567890
PSV
DDA



1500013002606
PSV
DDA



111222333
PSV
DDA



8552502
PSV
VOS



8255000DT3410S8
PSV
DAA



8255000DT3410S7
PSV
DAA



11199988877
PSV
DDA




0





Global PAYplus Service-Oriented Architecture Guide

Page 29

Static Data Services

6

Generic Error Codes

Generic Error Codes

This table includes the GPP generic error codes for static data services.
Code

Description

28560

An error has occurred while trying to perform this action

40207

No user credentials were found

1

Missing mandatory request fields: [missing information]

0

Successful Request

Generic Error

Validation error

An unsuccessful request generates a response with these elements:
•

compCode: Contains a relevant error code for the unsuccessful request

•

info: Contains a description of the error

Global PAYplus Service-Oriented Architecture Guide

Page 30

Static Data Services

7
7.1

System Users, Profiles & DB Maintenance Queries

System Users, Profiles & DB Maintenance Queries
System Users

GPP users are accessed via the System User menu in the GPP GUI. For more information, see the
GPP Online Help.

7.2

System Entitlements

GPP users are associated with a specific entitlement. An Entitlement profile is a profile in GPP that is
accessed via the Entitlement menu in the GPP GUI. For more information, see the GPP Online Help.

7.3

Profiles and Profile IDs

This table includes the GPP profiles and their profile ID.
Profile ID

Profile Name

Description

2

Outgoing File Summary

Outgoing File Summary

3

System Users

System Users

4

User Absense

Suspend user from log into the system

6

Access Class

Access level profile

7

Departments Class

Department entitlement class

8

Message Types Level Profile

Message Types entitlement class

9

Queue Level Profile

Statuses and filters entitlement class

13

Alerts Classes

Alert entitlement class

16

Standing Order

Standing Order

25

Currency Preferences

Currency Preferences

26

Cut-off Times

Cutoff Times

27

Offices

Local Offices

28

Accounts

Accounts

29

National Clearing Codes

National Clearing Codes

30

Exchange Rate

Exchange Rate Data

32

Method of Payment

Method of Payment

33

Memberships

Memberships

34

Settlement Instructions

Bank Routing

39

Rate Usage

Rate Usage

40

Payment Types

Payment Types

41

Party Limits

Party Limits

45

Products

Products

46

Departments

Departments

47

Alerts

Alerts

48

Sender Credit Line

Sender Credit Line

49

Calendars

Calendars

50

Country Info

Country Info

51

Currency Info

Currency Info

Global PAYplus Service-Oriented Architecture Guide

Page 31

Static Data Services

System Users, Profiles & DB Maintenance Queries

Profile ID

Profile Name

Description

53

User Codes

User Codes

54

System Parameters

System Parameters

55

Account Types

Account Types

58

Country Preferences

Country Preferences

75

Transaction Codes

Transaction Codes

76

Message Field Verification

Field Verification Profile

78

Business Areas

Business Areas

79

Bulking

Bulking

80

Mandate

Mandate

82

Transfer Method

Transfer Method

114

Stop Flags

Stop Flags

128

Value List Codes

Value List Codes for Business Rule

136

Value List Types

Value List Types for Business Rule

142

Profile Control

Profile Control

183

Time Zone

Time Zone

188

Identifiers

Identifiers

191

Parties

Parties

193

Apply Changes

Apply Changes

195

System Log

Error Log

206

Activity Log

Activity Log

228

Fee Types

Fee Types

414

Currency Pairs

Exchange Rate Info

415

Fee Formulas

Fee Formulas

424

Override STP

Override STP

427

SWIFT RMA

SWIFT RMA - Relationship Management Application

428

Data Manipulation

Data manipulation profile

430

Debit Authorization

Debit Authorization

432

Incoming File Summary

Incoming File Summary

435

Sender Credit Line Activity

Sender credit line activity

443

Reject/Return Codes

Reject/Return Codes

444

Advices

Advices

446

Customized Field Settings

User Defined Fields

447

Value List

Value List Codes for User Defined Fields

449

Message Codeword

Codeword

450

Character Set

Character Set

455

Service Level Agreement

Service Level Agreement

456

Interfaces

Interfaces

457

Internal Errors and Audit

Internal Errors and Audit

458

Account Additional Owners

Account Additional Owners

459

Company

Company

Global PAYplus Service-Oriented Architecture Guide

Page 32

Static Data Services

System Users, Profiles & DB Maintenance Queries

Profile ID

Profile Name

Description

460

Party Identifier Enrichment

Party Identifier Enrichment

461

Events Management

Events Management

463

Client IDs

Client IDs

464

Vendor Codes

Vendor Codes

466

Net Settlement Messages

Net Settlement Messages

467

Message Interactions

Message Interactions

469

Interest Types

Interest Types

470

Interest Rates

Interest Rates

7.4

Profile Fields

This section provides tables listing the fields and descriptions for Profiles which can be used by the
ProfileActionsService. These tables/fields are only example for some of the profiles used for upload.
For additional fields or profiles refer to the GPP Database Schema.

7.4.1

Exchange Rate Profile (EXCHRATE_BU Table)

Pre-requisite for exchange rate upload is definition of currencies and the currency pairs in the
Currency Pair profile.
Name

Type

Mandatory

Description

CCY1

Char(3)

Yes

Convert From currency (ISO code)

CCY2

Char(3)

Yes

Convert To currency (ISO code)

OFFICE

Char(3)

Yes

Office code to which the profile belongs

RATE_TYPE

Varchar2(10)

Yes

The exchange rate type taken from the rate
type profile

HIGH_RATE

Number(16,8)

No

Rate used when the bank sells a unit of
Currency 1, to buy Currency 2

LOW_RATE

Number(16,8)

No

Rate used when the bank buys a unit of
Currency 1, to sell Currency 2

VALID_DATE_TIME

Date (ISO
format)

No

The date and time the profile information
will be valid

EFFECTIVE_DATE

Date (ISO
format)

No

Rate effective date

DEPARTMENT

Char(3)

No

Office Department

MID_RATE

Number(16,8)

No

For each currency pair the system holds a
Low Rate and a High Rate.
Alternatively, the system may hold the Mid
Rate, Spread Up and Spread down.
In this case:
High Rate = Mid Rate + Spread Up
Low Rate = Mid Rate – Spread Down

SPREAD_UP

Number(16,8)

No

The spread value (Sell spread) is added to
the Mid Rate to calculate the Sell rate (high
rate), when the system parameter
SHOWSPREAD is set to YES

Global PAYplus Service-Oriented Architecture Guide

Page 33

Static Data Services

System Users, Profiles & DB Maintenance Queries

Name

Type

Mandatory

Description

SPREAD_DOWN

Number(16,8)

No

The spread value (Buy spread) is
subtracted from the Mid Rate to calculate
the Buy rate (low rate), when the system
parameter SHOWSPREAD is set to YES

Note: ** Either provide Sell/Buy Rate or provide Mid Rate plus Sell/Buy Spread

7.4.2

Settlement Instruction Profile (Bank Routing table)

Name

Type

Mandatory

Description

DESTINATION

Varchar2(11)

Yes

The BIC of the Destination bank

AGENT

Varchar2(11)

Yes

The BIC of the provisional agent through
which the payment will be effected.

TRANSFER_METH
OD

Char(1)

Yes

Possible values:
• Serial Direct message funds via a third
bank
• Cover: Direct cover message transfer
from bank to bank, with funds transfer
via a third bank
• Serial/Cover Control: the transfer
method will be determined by the
Serial/Cover Control Profile according to
destination country and currency

OFFICE

Char(3)

Yes

Office code to which the profile belongs

DEPARTMENT

Char(3)

Yes

Department code to which the profile
belongs

CURRENCY

Char(3)

No

A currency code selected from the currency
list.
If not selected, routing operates for all
currencies.

MSG_TYPE

Varchar2(10)

No

An optional message type selected from the
list.
Enables the definition of a routing agent per
message type.
If empty, routing operates for all MT’s.

EFFECTIVE_DATE

DATE (ISO
format)

No

Bank Routing Profile effective date

7.4.3

User Codes Profile

Name

Type

Mandatory

Description

REASON_TYPE

VARCHAR2(10)

Yes

Reason Type code.

REASONCODE

VARCHAR2(30)

Yes

Code

REASON_DESCRI
PTION

VARCHAR2(20
0)

Yes

Short description about the user code

QUALIFIER

VARCHAR2(10)

No

Optional User code selected from the list
such that the reason type matches the

Global PAYplus Service-Oriented Architecture Guide

Page 34

Static Data Services

Name

System Users, Profiles & DB Maintenance Queries

Type

Mandatory

Description
qualifier type of the reason type selected in
field 1.

7.4.4

Value List Types for Rules Profile

Name

Type

Mandatory

Description

DEPARTMENT

Char(3)

Yes

Profile Department

LIST_ID

VARCHAR2(8)

Yes

Identifier

DESCRIPTION

VARCHAR2(30)

Yes

Short description about the List Type

EXT_LIST

NUMBER(1,0)

Yes

Possible Values:
0 = No
1 =Yes (Default)

Office

Char(3)

No

Office code which the profile belongs

MANUAL_UPDATE

NUMBER(1,0)

No

Possible Values:
0 = No (Default)
1 = Yes

EXT_LIST

NUMBER(1,0)

No

Possible Values:
0 = No
1=Yes (Default)

SWFPARTNER

VARCHAR2(15)

No

Swift Partner ID

7.4.5

Value List for Rules Profile

Name

Type

Mandatory

Description

DEPARTMENT

Char(3)

Yes

Profile Department

LIST_ID

VARCHAR2(8)

Yes

Identifier

LIST_VALUE

VARCHAR2(255)

Yes

List Value

7.4.6

Codeword Profile

Name

Type

Mandatory

Description

TAG

CHAR(3)

Yes

The field identifier in a payment message.

CODEWORD

VARCHAR2(8)

Yes

The text of the codeword.

MSG_TYPE

VARCHAR2(10)

Yes

The message type identifier of message
types supported in the system.

QUEUEWITHNOTE
XT

VARCHAR2(25)

No

Specify the queue name to route the
message to, if there is no text associated
with the codeword

QUEUEWITHTEXT

VARCHAR2(25)

No

Specify the queue name to route the
message to, if there is text associated with
the codeword

COPYTOONWARD

NUMBER(1,0)

No

If selected, this option copies the codeword
and related text is to the onward message.
Possible Values
0 = No (Default)

Global PAYplus Service-Oriented Architecture Guide

Page 35

Static Data Services

Name

System Users, Profiles & DB Maintenance Queries

Type

Mandatory

Description
1 = Yes

7.4.7

Departments Profile

Name

Type

Mandatory

Description

OFFICE

CHAR(3)

Yes

Profile Office

DEPARTMENTCOD
E

CHAR(3)

Yes

Code that will act as the identifier for the
department.

DESCRIPTION

VARCHAR2(30)

Yes

Short description about the Department

NCC

VARCHAR2(14)

No

The National Clearing Code that is related
to the department.

ALLOW_REROUTE

NUMBER(1,0)

No

Possible Values
0 = No (Default)
1 = Yes

7.4.8

Product Profile

Name

Type

Mandatory

Description

DEPARTMENT

Char(3)

Yes

Profile Department

PROD_CODE

VARCHAR2(5)

Yes

Product Code

ALIAS

CHAR(5)

An alias for this Product profile.

DESCRIPT

VARCHAR2(254)

Short description about the Product

7.4.9

Stop Flags Profile

Name

Type

Mandatory

Description

DEPARTMENT

Char(3)

Yes

Profile Department

STOP_FLAGS_CO
DE

VARCHAR2(8)

Yes

Stop Flag Code.

DESCRIPTION

VARCHAR2(500)

Yes

Short description about flag

NON_OVERRIDDE
N

NUMBER(1,0)

No

Indicator enable manual (user) override.
Possible Values:
0 = No (Default)
1 = Yes

7.4.10 Transaction Codes Profile
Name

Type

Mandatory

Description

DEPARTMENT

Char(3)

Yes

Profile Department

TRANSACTION_C
ODE

VARCHAR2(6)

Yes

Transaction code

DESCRIPTION

VARCHAR2(50)

Yes

Short description about Transaction code

DEBIT_CREDIT_FL
AG

CHAR(1)

Yes

Possible Values:
D = Debit

Global PAYplus Service-Oriented Architecture Guide

Page 36

Static Data Services

Name

System Users, Profiles & DB Maintenance Queries

Type

Mandatory

Description
C = Credit
B = Both

7.4.11 Calendar Profile
*** If holiday date is provided, the description is mandatory. Multiple sets of “Holiday Date” & “Holiday
Description” can be provided. Holiday detail set is identified by the number (#) provided at the end of
the field for example, HOLIDAYS.HOLDATE_2 and HOLIDAYS.HOLDESC_2 forms one set.
Name

Type

Mandatory

Description

CALNAME

VARCHAR2(8)

Yes

Profile Department

CALDESC

VARCHAR2(50)

No

Calendar code

ISDEF

NUMBER(1,0)

No

Specify if this will be the Default Calendar

WEEKENDSDAYS

VARCHAR2(30)

No

Specify the days of the week that should be
considered as weekend days. “;” should be
used as separator. Example: “Sat;Sun”

HOLIDAYS.HOLDA
TE_#

DATE (ISO
format)

***

# can have value starting 2 onwards.
Holiday Date

HOLIDAYS.HOLDE
SC_#

VARCHAR2(50)

***

# can have value starting 2 onwards.
Holiday Description

7.4.12 Time Zone Profile
Name

Type

Mandatory

Description

ZONE_CODE

VARCHAR2(4)

Yes

Time zone Identifier

STANDARD_HOUR
S_
FROM_UTC

NUMBER(4,0)

Yes

Value expected is between -23 to 23

DESCRIPTION

VARCHAR2(70)

No

Short description about this Time Zone

DAYLIGHT_ZONE_
CODE

VARCHAR2(4)

No

The DST zone code

Name

Type

Mandatory

Description

DEPARTMENT

CHAR(3)

Yes

Profile Department

USER_ID

VARCHAR2(8)

Yes

Provide User ID. This is the ID used to log
on to GPP.

USERPASSWD

VARCHAR2(50)

Yes

Provide a password for the user to log on to
GPP

U_ENT_NAME

VARCHAR2(30)

Yes

User Entitlement applicable to the user

EMP_TYPE

CHAR(1)

No

Employee type of the user

FIRST_NAME

VARCHAR2(30)

No

User’s First Name

USER_NAME

VARCHAR2(30)

No

User’s Family Name

MIDDLE_NAME

VARCHAR2(30)

No

Users Middle Name

7.4.13 Users Profile

Global PAYplus Service-Oriented Architecture Guide

Page 37

Static Data Services

System Users, Profiles & DB Maintenance Queries

Name

Type

Mandatory

Description

EMPID_CONTRAC
TID

VARCHAR2(10)

No

User’s contract code number

PHONE_NO

VARCHAR2(30)

No

The user’s phone number

EMAIL_ADDRESS

VARCHAR2(12
5)

No

The user’s email address

COST_CTR

VARCHAR2(10)

No

User’s Cost Center

COST_CTR_MGR

VARCHAR2(50)

No

Name of the Manager for the above cost
center

MAX_AMOUNT

NUMBER(19,4)

No

Maximum amount per transaction allowed
for this user

MAX_FORCE_AMO
UNT

NUMBER(19,4)

No

Maximum transaction amount (in base
currency) that the user is allowed to force
out of the NSF queue

LOC_CNTRY_ID

VARCHAR2(2)

No

Code of the country where the user is
located

SUSPENDED

NUMBER(1,0)

No

Possible Values:
0 = not suspended (Default)
1 = suspended

7.4.14 Business Area Profile
Name

Type

Mandatory

Description

OFFICE

CHAR(3)

Yes

Profile Office

DEPARTMENT

CHAR(3)

Yes

Profile Department

BUSINESS_AREA_
CODE

VARCHAR2(4)

Yes

Business Area Code

DESCRIPTION

VARCHAR2(10
0)

Yes

Profile Description

7.4.15 System Parameters
Name

Type

Mandatory

Description

OFFICE

CHAR(3)

Yes

Profile Office

PARAM_NAME

VARCHAR2(25)

Yes

System Option Name

CATEGORYCODE

NUMBER(10,0)

Yes

Code for category of this option. The valid
codes are defined in PARAMCATEGORY
database table

ENABLE

NUMBER(1,0)

Yes

Determines whether the Value may be
changed.
Possible Values
0 = No
1 = Yes

STATUS

NUMBER(10,0)

Yes

Determines whether the system parameter
can be viewed in GPP.
Possible Values
1 = No

Global PAYplus Service-Oriented Architecture Guide

Page 38

Static Data Services

Name

System Users, Profiles & DB Maintenance Queries

Type

Mandatory

Description
2 = Yes
3 = Yes (STATUS as 3 and ENABLE set to
yes: when viewed in GPP the user will have
“Save As” option which will allow setting this
option for another office)

UNITCODE

NUMBER(22)

Yes

Units in which the value is given. The
available units are defined in PARAMUNITS
database table.

DESCRIPTION

VARCHAR2(10
00 )

No

A text description of the option.

TIME_ZONE

CHAR(5)

No

Generally defaulted to “GMT”

PARM_VALUE

VARCHAR2(25
4)

No

The value assigned to the option. The field
name for the Parameter value depends on
the Unit code field value. The mapping table
is provided below.

This table (System Parameters Fields – UNITCODE and PARM_VALUE) lists the unit code field
values, field UNITCODE and the expected parameter value for each of the unit code values, field
PARM_VALUE.
Unit Code

Parameter Value Expected in Field

1, 18

PARM_VALUE

2, 3, 8, 12

V_PARM_VALUE_INTEGER

4

V_PARM_VALUE_DATE

5, 6, 14

V_PARM_VALUE_NO_TEXTAREA

7

V_PARM_VALUE_SELECT_YESNO

9, 10

V_PARM_VALUE_MINUTES_SECONDS

11

V_PARM_VALUE_TIME

13

V_PARM_VALUE_FLOAT

15

V_PARM_VALUE_SELECT_LOGLEVEL

16

V_PARM_VALUE_SELECT_BOOLSTRING

7.4.16 NCC Profile
Name

Type

Mandatory

Description

OFFICE

CHAR(3)

Yes

Profile office

DEPARTMENT

Char(3)

Yes

Profile Department

NCC_TYPE_SWIF
T

CHAR(2)

Yes

NCC type Based on the Clearing System
ID, for example, SC

NCC_CODE

VARCHAR2(14)

Yes

NCC code

INTERNAL_NCC

NUMBER(1,0)

No

Internal NCC. Value can be 0 or 1

DEFAULT_NCC

NUMBER(1,0)

No

Default NCC. Value can be 0 or 1

CUST_CODE

VARCHAR2(20 )

No

Party code

BANK_NAME

VARCHAR2(105)

No

Bank name

ADDRESS 1

VARCHAR2(35)

No

First of four address lines

Global PAYplus Service-Oriented Architecture Guide

Page 39

Static Data Services

System Users, Profiles & DB Maintenance Queries

Name

Type

Mandatory

Description

ADDRESS2

VARCHAR2(35)

No

Second of four address lines

ADDRESS3

VARCHAR2(35)

No

Third of four address lines

ADDRESS4

VARCHAR2(35)

No

Fourth of four address lines

CITY

VARCHAR2 (35)

No

City

ZIP

VARCHAR2(15)

No

Postal code

COUNTRY CODE

CHAR(2)

No

Country code

NCC_TYPE_ISO

VARCHAR2(5)

No

ISO NCC type

7.4.17 Customers Profile
Name

Type

Mandatory

Description

OFFICE

CHAR(3)

Yes

Profile office

DEPARTMENT

Char(3)

Yes

Profile Department

CUST_CODE

VARCHAR2(20)

Yes

Unique customer (party) identifier.
XXXSAYYYYYYYYYYY where: XXX =
Office, SA = Swift Address,
YYYYYYYYYYY = 11-char BIC.

CUST_NAME

VARCHAR2(35 )

No

Party name

FULL_NAME

VARCHAR2(105)

No

Full party number, for informational use
only.

ADDRESS 1

VARCHAR2(35)

No

First of four address lines

ADDRESS2

VARCHAR2(35)

No

Second of four address lines

ADDRESS3

VARCHAR2(35)

No

Third of four address lines

ADDRESS4

VARCHAR2(35)

No

Fourth of four address lines

CITY

VARCHAR2 (35)

No

City

STATE

CHAR(2)

No

State

ZIP

VARCHAR2(15)

No

Postal code

COUNTRY CODE

CHAR(2)

No

Country code

SWIFT_ID

VARCHAR2(12)

No

SWIFT identification number

7.4.18 Accounts Profile
Name

Type

Mandatory

Description

OFFICE

CHAR(3)

Yes

Profile office

ACC_NO

VARCHAR2(34)

Yes

Account number

CURRENCY

CHAR(3)

Yes

ISO currency code

CUST_CODE

VARCHAR2(20)

Yes

Unique customer (party) identifier.
XXXSAYYYYYYYYYYY where: XXX =
Office, SA = Swift Address,
YYYYYYYYYYY = 11-char BIC.

DEPARTMENT

CHAR(3)

No

Profile Department

DESCRIPT

VARCHAR2(80)

No

Free text description of the account

Global PAYplus Service-Oriented Architecture Guide

Page 40

Static Data Services

System Users, Profiles & DB Maintenance Queries

Name

Type

Mandatory

Description

ACC_ALIAS

VARCHAR2(35)

No

Number of Asset (nostro) acct. Enabled if
Asset check box is selected

ASSET

NUMBER(1)

No

Indicator that determines whether account
is an assest, such as Nostro, settlement, or
CSM account.

IBAN

VARCHAR2(35)

No

International Bank Account Number.

Name

Type

Mandatory

Description

MEMBER_ID

VARCHAR(20)

Yes

Member identification for the MOP

MOP

VARCHAR(20)

Yes

Method of Payment (MOP) in which
membership is registered.

VALID_FROM_DA
TE

DATE

Yes

Start date of the membership. Format to_date('1980/01/01','yyyy/mm/dd')

Currency

CHAR(3)

No

Three character ISO currency code for the
membership currency.

VALID_TO_DATE

DATE

No

End date of the membership. Format
to_date('2079/12/31','yyyy/mm/dd')

MEMBERASSOCI
ATE

CHAR(1)

No

Associate member indicator.

MEMBERIFASSO
CIATE

VARCHAR(11)

No

Name of associate member.

7.4.19 Membership

7.5

Database Maintenance Queries

This table includes the database maintenance queries.
Table

Query

SD_PROFILES

Select * from sd_profiles t

MENU_ITEMS

Select * from menu_items t where
t.item_type = 'PROFILE_CTRL' and
t.rec_status = 'AC' and t.item_id not in
(99998,99999) order by 3

Any change around any
attribute in this query.

SD_PROFILE_BUTTONS

Select * from sd_profile_buttons t

Available buttons for all
static data profiles.

SD_PROFILE_FIELDS

Select * from SD_PROFILE_FIELDS t
Exclude:
• ADVISE_GLOBAL_SUPPRESS
• ACC_POS
• AKA
• BILATERALKEY
• CR_PPROFILE
• CYCLE_SETTLEMENT
• DIRECT_DEBITS
• DR_PPROFILE
• FIELDSALIAS

Any change that may
affect the profile list
service

Global PAYplus Service-Oriented Architecture Guide

Comments

Page 41

Static Data Services

Table

System Users, Profiles & DB Maintenance Queries

Query

Comments

• INTEREST_RATES
• MESSAGE_FIELDS
• TRANSACTION_CODE
• SOURCE
• RTGS_POS
• MOP_FPS_EXTENSION
• PARTNER_PHYSICAL_END
select *
from sd_profile_fields t
where t.table_name not in
('MANDATE', 'MINF',
'V_RUN_TASKS', 'EVENT_DEFINITIONS',
'RTGS_POS',
'ADVISE_GLOBAL_SUPPRESS',
'ACC_POS', 'AKA', 'BILATERALKEY',
'CR_PPROFILE',
'CYCLE_SETTLEMENT',
'DIRECT_DEBITS', 'DR_PPROFILE',
'FIELDSALIAS', 'INTEREST_RATES',
'MESSAGE_FIELDS',
'TRANSACTION_CODE', 'SOURCE',
'RTGS_POS', 'MAPPING',
'MOP_FPS_EXTENSION',
'PARAMUNITS', 'PARAMCATEGORY',
'PARTNER_PHYSICAL_END',
'SWFPRTNR', 'VIRTUAL',
'STATIC_DATA_REFRESH',
'SEARCH_SCREEN',
'SD_PRULE_TYPE_ACTION',
'PRULE_SYS_ACTIONS',
'OBJECT_PRULE_TYPES',
'ACC_BALANCE_ERR')

Global PAYplus Service-Oriented Architecture Guide

Page 42

Static Data Services

System Users, Profiles & DB Maintenance Queries

Appendix A: Glossary
This table describes the terms used in this document.
Term

Description

GPP

Global PAYplus

SOA

Service Oriented Architecture

UID

Unique ID. Each GPP profile is identified by a unique identification string

Global PAYplus Service-Oriented Architecture Guide

Page 43



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Author                          : D+H
Category                        : Global PAYplus Version 4.6.2
Company                         : COMMERCIAL IN CONFIDENCE
Content Type Id                 : 0x0101009A3327D2C2C93446A7CB9E3DCC9805D1
Create Date                     : 2016:03:29 16:51:42-04:00
Keywords                        : Global, PAYplus
Modify Date                     : 2016:03:29 16:52:34-04:00
Source Modified                 : D:20160329205129
Language                        : EN-US
Tagged PDF                      : Yes
XMP Toolkit                     : Adobe XMP Core 5.6-c015 81.157285, 2014/12/12-00:43:15
Metadata Date                   : 2016:03:29 16:52:34-04:00
Creator Tool                    : Acrobat PDFMaker 15 for Word
Document ID                     : uuid:800b0e8b-eb1a-4808-8378-8720572af100
Instance ID                     : uuid:b65db81e-fe8b-446f-ad6c-3646a086885c
Format                          : application/pdf
Title                           : GPP SOA Guide Static Data
Description                     : Static Data Services
Creator                         : D+H
Subject                         : Global PAYplus
Producer                        : Adobe PDF Library 15.0
Headline                        : Static Data Services
Page Layout                     : OneColumn
Page Mode                       : UseOutlines
Page Count                      : 43
Warning                         : [Minor] Ignored duplicate Info dictionary
EXIF Metadata provided by EXIF.tools

Navigation menu