General object type for configure all the required parameters for communicate with Banking Cloud platform. Más...

Diagrama de herencias de Sage.ES.BankingCloud.BcEsManagerSettings

Métodos públicos
	BcEsManagerSettings ()
	Constructor without parameters. Más...

	BcEsManagerSettings (string productID, dynamic objKeyStorageProductApp, dynamic objLoggerProductApp)
	Constructor with key storage and logger product app objects parameters, for test and production purposes, both. Más...

Propiedades
BcEnvironment	ConnectEnvironment `[get, set]`
	BankingCloud environment with which work the manager. By default QA, in the constructor declare which environment use. Más...

string	ConnectBankingCloudAPIBaseAddress `[get]`
	BankingCloud API Base EndPoint Address. Más...

string	ConnectTokenServiceAPIBaseAddress `[get]`
	Token Service API Base EndPoint Address. Más...

string	ConnectProductID `[get]`
	Product Id pre-configured in Banking Cloud platform. Each Sage application product consumer of banking cloud platform has its own identifier. Más...

string	ConnectProviderID `[get, set]`
	Token service provider header pre-configured in Banking Cloud to point to the appropriate licensing adapter for the integrating product, e.g. "sls.uk" for UK, "....es" for SP. Más...

string	ConnectProductSigningKey `[get, set]`
	Product-specific token pre-configured in banking cloud, be careful, this property is not the signing key ! Used in the first authentication. Más...

string	ConnectAdminUserEmail `[get, set]`
	Primary user email created and set when a new organization is established in Banking Cloud during onboarding. Must be provided by integrating product to onboard accounts to existing orgs. Más...

string	ConnectSigningKey `[get, set]`
	Handles org-specific token created and set when a new organization is established in Banking Cloud during onboarding. Must be provided by integrating product to onboard accounts to existing orgs. Más...

SecurityProtocolType	ConnectSecurityProtocol `[get, set]`
	When working with the Client Library the calling process must be setup to use TLS 1.2 which the banking cloud service currently demands. In the future can change. Más...

string	ConnectMessageChangeEmailAddresOnManualKeyRefresh `[get, set]`
	Product specific instruction for change email address in a manual key refresh process. Más...

bool	ConnectFullMessagingReAuthBankAccount `[get, set]`
	Use full re-Auth messaging in reauthentication bank account process Más...

IntPtr	ProductAppHandleAppWindow `[get, set]`
	Handle of the desktop product application window, used to parent and center child windows and messages. Más...

string	ProductAppProductName `[get, set]`
	Name for specific product that uses Sage Bank Feeds common component, also used as any window captions. Más...

string	ProductAppLearnMoreURL `[get, set]`
	Integrating product must specify the product-specific URL (ideally a redirect) that contains Learn More content for bank feeds feature and onboarding. Más...

string	ProductAppSupportNumber `[get, set]`
	Integrating product can specify a product-specific support number. Más...

string	ProductAppEmbeddedResource `[get, set]`
	(Optional) Resource file for customization, specified as a Pack URI. Any values provided here will override the settings in default resource file. So you don't need to specify all the resources, only the ones you wish to change. Also, be sure to provide resources based on the DefaultLanguageTag, either the one specified or the one indicated by the current OS culture. Más...

string	OrganizationID `[get, set]`
	Organization Id identification. Más...

string	CompanyID `[get, set]`
	Company Id identification. Más...

string	CompanyName `[get, set]`
	Name of company within the integrating product. Más...

string	CompanyVatNumber `[get, set]`
	Company's VAT number, where applicable. Más...

string	CompanyZipCode `[get, set]`
	Zip code of primary location of integrating product company. Más...

string	CompanyStdIndustryCode `[get, set]`
	Company's standard industry code, where applicable. Más...

string	CompanyCrmID `[get, set]`
	ID for current customer within the integrating product's CRM system, where applicable. Más...

string	CompanyUserID `[get, set]`
	ID used by integrating product to identify current user. Más...

Dictionary< string, string >	LicenseInfoClientData `[get, set]`
	Client data for each integrating product as needed for banking cloud token service. Más...

Dictionary< string, string >	LicenseInfoLicenseData `[get, set]`
	License data, specific to each integrating product, required for banking cloud token service to perform server-side licensing/entitlement check. For example, some products have a licensing, serial, or registration number/code. Example of possibles entries, any product will put the properties required, for test send the two first entries "accountNumber", "63523106" "serialNumber", "H740111" "customerId", "4006885653" "stockCode", "25" "productYear", "2018" "serialNumber", "6FE6E-B28D-35C8-3668" "companyId", "AAA-BBB-CCC" "garbageIn", "garbageOut" Más...

string	ErrorMessage `[get, set]`
	Error message. Más...

int	TransPagingSize `[get, set]`
	The page size on the GetTransactions call, default 100 (at December 2017, could have changed) Más...

bool	ShowCallsResponsesApi `[get, set]`
	When making API calls, show the preview form (with the URL call and body parameters) and the result form (with the result of the API call). Only for TEST use, in PROD mode be sure this property remains false. Más...

Propiedades heredados desde Sage.ES.BankingCloud.IBcEsManagerSettings
string	OrganizationID `[get, set]`
	Organization ID Más...

string	CompanyID `[get, set]`
	Company ID Más...

string	CompanyName `[get, set]`
	Name of company within integrating product Más...

string	CompanyCrmID `[get, set]`
	ID for current customer within the integrating product's CRM system, where applicable Más...

string	CompanyStdIndustryCode `[get, set]`
	Company's standard industry code, where applicable Más...

string	CompanyUserID `[get, set]`
	ID used by integrating product to identify current user Más...

string	CompanyVatNumber `[get, set]`
	company's VAT number, where applicable. Más...

string	CompanyZipCode `[get, set]`
	Zip code of primary location of integrating product company Más...

string	ConnectBankingCloudAPIBaseAddress `[get]`
	BankingCloud API Base EndPoint Address. Más...

string	ConnectTokenServiceAPIBaseAddress `[get]`
	Token Service API Base EndPoint Address. Más...

string	ConnectProductID `[get]`
	Product Id pre-configured in Banking Cloud platform. Each Sage applications product consumer of Banking Cloud platform has its own identifier. Más...

string	ConnectProviderID `[get]`
	Token service provider header pre-configured in Banking Cloud to point to the appropriate licensing adapter for the integrating product, e.g. "sls.uk" for UK, "....es" for SP. Más...

string	ConnectProductSigningKey `[get, set]`
	Product-specific token pre-configured in Banking Cloud, be careful, this property is not the signing key ! Used in the first authentication. Más...

string	ConnectAdminUserEmail `[get, set]`
	Primary user ID created and set when a new organization is established in Banking Cloud during onboarding. Must be provided by integrating product to onboard accounts to existing orgs. Más...

string	ConnectSigningKey `[get, set]`
	Handles org-specific token created and set when a new organization is established in Banking Cloud during onboarding. Must be provided by integrating product to onboard accounts to existing orgs. Más...

SecurityProtocolType	ConnectSecurityProtocol `[get, set]`
	When working with the Client Library the calling process must be setup to use TLS 1.2 which the Banking Cloud service currently demands but in the future can change. Más...

bool	ConnectFullMessagingReAuthBankAccount `[get, set]`
	Use full re-Auth messaging in reauthentication bank account process. Más...

string	ConnectMessageChangeEmailAddresOnManualKeyRefresh `[get, set]`
	Product specific instruction for change email address in a manual key refresh process. Más...

string	ErrorMessage `[get, set]`
	Error message if occurs. Más...

Dictionary< string, string >	LicenseInfoClientData `[get, set]`
	Client Data for each integrating product as needed for banking cloud token service. Más...

Dictionary< string, string >	LicenseInfoLicenseData `[get, set]`
	License Data, specific to each integrating product, required for banking cloud token service to perform server-side licensing/entitlement check. For example, some products have a licensing, serial, or registration number/code. Example of possibles entries, any product will put the properties required, for test send the two first entries "accountNumber", "63523106" "serialNumber", "H740111" "customerId", "4006885653" "stockCode", "25" "productYear", "2018" "serialNumber", "6FE6E-B28D-35C8-3668" "companyId", "AAA-BBB-CCC" "garbageIn", "garbageOut" Más...

string	ProductAppProductName `[get, set]`
	Name for specific product that uses Bank Feed common component, also used as any window captions. Más...

IntPtr	ProductAppHandleAppWindow `[get, set]`
	Handle of the desktop product application window, used to parent and center child windows and messages. Más...

string	ProductAppLearnMoreURL `[get, set]`
	Integrating product must specify the product-specific URL (ideally a redirect) that contains Learn More content for bank feeds feature and onboarding. Más...

string	ProductAppSupportNumber `[get, set]`
	Integrating product can specify a product-specific support number. Más...

string	ProductAppEmbeddedResource `[get, set]`
	(Optional) Resource file for customization, specified as a Pack URI. Any values provided here will override the settings in default resource file.So you don't need to specify all the resources, only the ones you wish to change. Also, be sure to provide resources based on the DefaultLanguageTag, either the one specified or the one indicated by the current OS culture. Más...

BcEnvironment	ConnectEnvironment `[get, set]`
	BankingCloud environmnet with which work the manager. Más...

bool	ShowCallsResponsesApi `[get, set]`
	For debugger purposes, if should show the API calls requests and responses. Más...

int	TransPagingSize `[get, set]`
	Transaction paging size when recovering transactions. Más...

Descripción detallada

General object type for configure all the required parameters for communicate with Banking Cloud platform.

Definición en la línea 64 del archivo BcSettings.cs.

Documentación del constructor y destructor

◆ BcEsManagerSettings() [1/2]

Sage.ES.BankingCloud.BcEsManagerSettings.BcEsManagerSettings ( )

inline

Constructor without parameters.

Can call the constructor without parameters only for TEST uses, not for PRODUCTION mode ! In production mode use always the BcEsManagerSettings(string productID, dynamic objKeyStorageProductApp, dynamic objLoggerProductApp) constructor with the objKeyStorProductApp and the objLoggerProductApp parameters declared.

In this case the logger works like Sage.BankingCloud.Client.Defaults.DefaultLogger() class, works with the console. In this case the logger works like TestFileKeyStorage class, read/write the signing key into a ASCII txt file located in AppDomain.CurrentDomain.BaseDirectory which is not a persistent key storage method because not is shared by all the users.

Definición en la línea 686 del archivo BcSettings.cs.

◆ BcEsManagerSettings() [2/2]

Sage.ES.BankingCloud.BcEsManagerSettings.BcEsManagerSettings	(	string	productID,
		dynamic	objKeyStorageProductApp,
		dynamic	objLoggerProductApp
	)

inline

Constructor with key storage and logger product app objects parameters, for test and production purposes, both.

Parámetros

productID Product identifier.

Parámetros

objKeyStorageProductApp	Key storage product app object supplied by the product app, must have 2 methods called ReadKey() and WriteKey(). If not received BcEsKeyStorage works like TestFileKeyStorage class, read/write the signing key into a ASCII txt file located in AppDomain.CurrentDomain.BaseDirectory
objLoggerProductApp	Logger produc app for logging, must have 4 methods called Info(string), Warning(string), Error(string), Debub(string). If not received BcEsKeyStorage uses a DefaultLogger mechanism which work with the console.

Definición en la línea 705 del archivo BcSettings.cs.

Documentación de propiedades

◆ CompanyCrmID

string Sage.ES.BankingCloud.BcEsManagerSettings.CompanyCrmID

getset

ID for current customer within the integrating product's CRM system, where applicable.

Definición en la línea 491 del archivo BcSettings.cs.

◆ CompanyID

string Sage.ES.BankingCloud.BcEsManagerSettings.CompanyID

getset

Company Id identification.

Definición en la línea 394 del archivo BcSettings.cs.

◆ CompanyName

string Sage.ES.BankingCloud.BcEsManagerSettings.CompanyName

getset

Name of company within the integrating product.

Definición en la línea 413 del archivo BcSettings.cs.

◆ CompanyStdIndustryCode

string Sage.ES.BankingCloud.BcEsManagerSettings.CompanyStdIndustryCode

getset

Company's standard industry code, where applicable.

Definición en la línea 472 del archivo BcSettings.cs.

◆ CompanyUserID

string Sage.ES.BankingCloud.BcEsManagerSettings.CompanyUserID

getset

ID used by integrating product to identify current user.

Definición en la línea 509 del archivo BcSettings.cs.

◆ CompanyVatNumber

string Sage.ES.BankingCloud.BcEsManagerSettings.CompanyVatNumber

getset

Company's VAT number, where applicable.

Definición en la línea 433 del archivo BcSettings.cs.

◆ CompanyZipCode

string Sage.ES.BankingCloud.BcEsManagerSettings.CompanyZipCode

getset

Zip code of primary location of integrating product company.

Definición en la línea 452 del archivo BcSettings.cs.

◆ ConnectAdminUserEmail

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectAdminUserEmail

getset

Primary user email created and set when a new organization is established in Banking Cloud during onboarding. Must be provided by integrating product to onboard accounts to existing orgs.

Definición en la línea 197 del archivo BcSettings.cs.

◆ ConnectBankingCloudAPIBaseAddress

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectBankingCloudAPIBaseAddress

get

BankingCloud API Base EndPoint Address.

Definición en la línea 92 del archivo BcSettings.cs.

◆ ConnectEnvironment

BcEnvironment Sage.ES.BankingCloud.BcEsManagerSettings.ConnectEnvironment

getset

BankingCloud environment with which work the manager. By default QA, in the constructor declare which environment use.

Definición en la línea 76 del archivo BcSettings.cs.

◆ ConnectFullMessagingReAuthBankAccount

bool Sage.ES.BankingCloud.BcEsManagerSettings.ConnectFullMessagingReAuthBankAccount

getset

Use full re-Auth messaging in reauthentication bank account process

Definición en la línea 250 del archivo BcSettings.cs.

◆ ConnectMessageChangeEmailAddresOnManualKeyRefresh

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectMessageChangeEmailAddresOnManualKeyRefresh

getset

Product specific instruction for change email address in a manual key refresh process.

Definición en la línea 239 del archivo BcSettings.cs.

◆ ConnectProductID

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectProductID

get

Product Id pre-configured in Banking Cloud platform. Each Sage application product consumer of banking cloud platform has its own identifier.

Definición en la línea 136 del archivo BcSettings.cs.

◆ ConnectProductSigningKey

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectProductSigningKey

getset

Product-specific token pre-configured in banking cloud, be careful, this property is not the signing key ! Used in the first authentication.

Definición en la línea 176 del archivo BcSettings.cs.

◆ ConnectProviderID

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectProviderID

getset

Token service provider header pre-configured in Banking Cloud to point to the appropriate licensing adapter for the integrating product, e.g. "sls.uk" for UK, "....es" for SP.

Definición en la línea 156 del archivo BcSettings.cs.

◆ ConnectSecurityProtocol

SecurityProtocolType Sage.ES.BankingCloud.BcEsManagerSettings.ConnectSecurityProtocol

getset

When working with the Client Library the calling process must be setup to use TLS 1.2 which the banking cloud service currently demands. In the future can change.

Definición en la línea 228 del archivo BcSettings.cs.

◆ ConnectSigningKey

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectSigningKey

getset

Handles org-specific token created and set when a new organization is established in Banking Cloud during onboarding. Must be provided by integrating product to onboard accounts to existing orgs.

Definición en la línea 218 del archivo BcSettings.cs.

◆ ConnectTokenServiceAPIBaseAddress

string Sage.ES.BankingCloud.BcEsManagerSettings.ConnectTokenServiceAPIBaseAddress

get

Token Service API Base EndPoint Address.

Definición en la línea 113 del archivo BcSettings.cs.

◆ ErrorMessage

string Sage.ES.BankingCloud.BcEsManagerSettings.ErrorMessage

getset

Error message.

Definición en la línea 587 del archivo BcSettings.cs.

◆ LicenseInfoClientData

Dictionary<string, string> Sage.ES.BankingCloud.BcEsManagerSettings.LicenseInfoClientData

getset

Client data for each integrating product as needed for banking cloud token service.

Definición en la línea 535 del archivo BcSettings.cs.

◆ LicenseInfoLicenseData

Dictionary<string, string> Sage.ES.BankingCloud.BcEsManagerSettings.LicenseInfoLicenseData

getset

License data, specific to each integrating product, required for banking cloud token service to perform server-side licensing/entitlement check. For example, some products have a licensing, serial, or registration number/code. Example of possibles entries, any product will put the properties required, for test send the two first entries "accountNumber", "63523106" "serialNumber", "H740111" "customerId", "4006885653" "stockCode", "25" "productYear", "2018" "serialNumber", "6FE6E-B28D-35C8-3668" "companyId", "AAA-BBB-CCC" "garbageIn", "garbageOut"

Definición en la línea 563 del archivo BcSettings.cs.

◆ OrganizationID

string Sage.ES.BankingCloud.BcEsManagerSettings.OrganizationID

getset

Organization Id identification.

Definición en la línea 376 del archivo BcSettings.cs.

◆ ProductAppEmbeddedResource

string Sage.ES.BankingCloud.BcEsManagerSettings.ProductAppEmbeddedResource

getset

(Optional) Resource file for customization, specified as a Pack URI. Any values provided here will override the settings in default resource file. So you don't need to specify all the resources, only the ones you wish to change. Also, be sure to provide resources based on the DefaultLanguageTag, either the one specified or the one indicated by the current OS culture.

Definición en la línea 348 del archivo BcSettings.cs.

◆ ProductAppHandleAppWindow

IntPtr Sage.ES.BankingCloud.BcEsManagerSettings.ProductAppHandleAppWindow

getset

Handle of the desktop product application window, used to parent and center child windows and messages.

Definición en la línea 267 del archivo BcSettings.cs.

◆ ProductAppLearnMoreURL

string Sage.ES.BankingCloud.BcEsManagerSettings.ProductAppLearnMoreURL

getset

Integrating product must specify the product-specific URL (ideally a redirect) that contains Learn More content for bank feeds feature and onboarding.

Definición en la línea 306 del archivo BcSettings.cs.

◆ ProductAppProductName

string Sage.ES.BankingCloud.BcEsManagerSettings.ProductAppProductName

getset

Name for specific product that uses Sage Bank Feeds common component, also used as any window captions.

Definición en la línea 286 del archivo BcSettings.cs.

◆ ProductAppSupportNumber

string Sage.ES.BankingCloud.BcEsManagerSettings.ProductAppSupportNumber

getset

Integrating product can specify a product-specific support number.

Definición en la línea 326 del archivo BcSettings.cs.

◆ ShowCallsResponsesApi

bool Sage.ES.BankingCloud.BcEsManagerSettings.ShowCallsResponsesApi

getset

When making API calls, show the preview form (with the URL call and body parameters) and the result form (with the result of the API call). Only for TEST use, in PROD mode be sure this property remains false.

Definición en la línea 609 del archivo BcSettings.cs.

◆ TransPagingSize

int Sage.ES.BankingCloud.BcEsManagerSettings.TransPagingSize

getset

The page size on the GetTransactions call, default 100 (at December 2017, could have changed)

Definición en la línea 598 del archivo BcSettings.cs.

La documentación para esta clase fue generada a partir del siguiente fichero:

C:/Agent/_work/5/s/sage.ew/Sage.ES.BankingCloud/Clases/BcSettings.cs

Métodos públicos

Propiedades

Descripción detallada

Documentación del constructor y destructor

◆ BcEsManagerSettings() [1/2]

◆ BcEsManagerSettings() [2/2]

Documentación de propiedades

◆ CompanyCrmID

◆ CompanyID

◆ CompanyName

◆ CompanyStdIndustryCode

◆ CompanyUserID

◆ CompanyVatNumber

◆ CompanyZipCode

◆ ConnectAdminUserEmail

◆ ConnectBankingCloudAPIBaseAddress

◆ ConnectEnvironment

◆ ConnectFullMessagingReAuthBankAccount

◆ ConnectMessageChangeEmailAddresOnManualKeyRefresh

◆ ConnectProductID

◆ ConnectProductSigningKey

◆ ConnectProviderID

◆ ConnectSecurityProtocol

◆ ConnectSigningKey

◆ ConnectTokenServiceAPIBaseAddress

◆ ErrorMessage

◆ LicenseInfoClientData

◆ LicenseInfoLicenseData

◆ OrganizationID

◆ ProductAppEmbeddedResource

◆ ProductAppHandleAppWindow

◆ ProductAppLearnMoreURL

◆ ProductAppProductName

◆ ProductAppSupportNumber

◆ ShowCallsResponsesApi

◆ TransPagingSize