Appendix 1: Properties Reference

On this page you will find a detailed description of all the configuration properties in the Excenit RSS system.

API Settings

The API Settings properties determine how to connect to the BOG ORASS API. Node: orass→api→settings.

Table 1. Application Properties for Excenit RSS: API Settings
Property Description Data type/Values

password

Password for the machine user in the ORASS API system. Only the machine user password will work with the ORASS API

String

Default: None

username

Username for the machine user in the ORASS API system. This is typically an email address.

String/Valid password complexity requirements

Default: your_api@somedomain.com

baseUrl

Base URL of the ORASS API. Valid URL with the protocol included but exclude the folders. There should be no trailing slashes.

String/Valid URL

Default: https://orassvas.bog.gov.gh

returnEndpoint

The path to the API returns. This keeps track of the API version.

String/Valid URL path

Default: /v1/returns

tokenEndpoint

The endpoint for retrieving the authorization token to the ORASS API.

String/Valid URL path

Default: /oauth2/token

Options

These properties control how the returns data are loaded and the written to the report templates. Node: orass→api→settings

Table 2. Application Properties for Excenit RSS: ETL Options

Property

Description

Data type/Values

batchSubmission

Should the return be submitted immediately upon approval (YES) or in batch mode, where all returns within a default window are submitted together.

YES, NO

Default: YES

emptyValuesToZero

When writing values to Excel templates, should cells with no value be set to zero?

YES, NO

Default: NO

skipEmptyFormulas

When writing values to Excel templates, should cells with no value be set to zero?

YES, NO

Default: NO

unlockSheets

Should report templates be unlocked for edits?

YES, NO

Default: NO

validRecordsOnly

When writing data to the report templates, should records that are not flagged as VALID be included?

YES, NO

Default: NO

Institution Information

These properties determine the values that are included in the attestation form (AF100) of each return. They are issued by BOG and must match exactly what is in the ORASS API. There is no guarantee that the returns would be accepted by the ORASS API if any of them is incorrect.

Node: orass→return→options→institution

Table 3. Application Properties for Excenit RSS: Institution Details

Property

Description

Data type/Values

id

BOG-issued id for your institution in the ORASS system.

Integer

Default: 65

name

BOG-issued name for your institution in the ORASS system.

String. Must match what is in BoG’s system exactly.

Default: Excenit

referenceCode

BOG-issued reference code for your institution in the ORASS system.

String. Must match what is in BoG’s system exactly.

Default: Excenit

SMTP Email Configuration

Use these properties to define the custom SMTP server for your organization.

Node: excenit→email

Table 4. Application Properties for Excenit RSS: Institution Details

Property

Description

Data type/Values

adminAddress

Default email address of the admin user. This email is used to send system messages via SMTP.

Email

Default: admin@admin.com

allowutf8

Allow UTF8 character set to be used in sending emails.

Boolean (true/false)

Default: false

defaultSendingAttemptsCount

Number of times server will attempt to send an email before giving up.

Integer

Default: 5