Custom Web Services
Allowed WS Consumer
Overview
This screen is used to store the Allowed Consumers of the Web Service, also the valid Application User(s) and the Attribute(s) default values.
Navigation
Admin ► Common Entities ► Custom Web Services ► Allowed WS Consumer
Allowed WS Consumer Screen Fields
Field | Description |
Id | Unique identification generated by the system or Set by the User in case parameter 'Generate automatically Allowed Consumer Application Id' is FALSE. |
Active | If false, the Allowed WS Consumer cannot be used in new transactions. |
| IP | Valid Consumer IP, from where Consumer use the Web Service. |
| Description | The description of the Financial Institution Type. |
| Name | Name of the Allowed WS Consumer. |
| Web Service | Name of the web service. |
| Application User | Application user for the Allowed WS Consumer. |
| Property Value Tab | In this tab, its capture the property value of the consumer. |
Property Value
Overview
Collection of 0 to N pair name and value, that identify the properties, not required to be send by the Consumer.
Allowed WS Consumer Screen Fields
Field | Description |
Property Name | Property Name, must be one from the properties defined at the WSDL. This name should include the complete path of the property including all its prefix like: for the example : budgetLines.budgetPlanAdditionalFields.fieldDescriptions.applicationLanguageApplicationId budgetLines.budgetPlanAdditionalFields.fieldDescriptions.description Every prefix should be included till the end separated by dots. |
Default Value | Value to be set, in case property with Name is not sent during the use of the Web Service, because the string can hold different types of values, they should be enter with its respective format like: - Decimal: Decimal Separator (".") - DateTime: "yyyy-MM-dd HH:mm:ss" - Boolean: possible values ("true","false") |
| Allowed Value | Valid value, in case property with name at Property Value, is sent during the use of the Web Service. When there are more than one value, it should be separated by "|". Because the string can hold different types of values, they should be enter with its respective format like: - Decimal: Decimal Separator (".") - DateTime: "yyyy-MM-dd HH:mm:ss" - Boolean: possible values ("true","false") |
Allowed WS Consumer Log
Overview
This feature stores the execution trace during web service consumer interaction.
A screenshot of the Allowed WS Consumer Log feature is available here. Image is shown as reference material; position and names for labels, fields, and buttons are subject to the installed revision, System Parameters and Rendering Control configuration.
Users access Allowed WS Consumer Log from within the menu through this navigation path: Admin ► Common Entities ► Custom Web Services ► Allowed WS Consumer Log
Visible Fields
The following table lists and describes all visible fields for the Allowed WS Consumer Log feature, in their default order. Note that some fields depend on System Parameters and Rendering Control configuration to be visible and/or editable by users. Field names are subject to change through language label configuration.
Field | Description |
|---|---|
Id | System generated a unique identification code. |
Successful | Indicates if the consumer log is successful. The default is false. |
Execution Date | Date time when interaction returns an error message. |
| Error Stack Trace Message | It is a description field which shows the stack trace message with error information. |
Allowed WS Consumer | Reference to Allowed WS Consumers, users and attributes, for the web service. |
Buttons
The following table describes actions associated with the depicted button image. Note that some images are associated with several buttons, used for more than one purpose within the Allowed WS Consumer Log feature.
| Button Image | Description |
|---|---|
 | The New button allows users to switch to insert mode. This action button allows users to manually create allowed WS consumer log. |
 | The Search button allows users to switch to search mode. |
 | Once a record has been created or searched for, users can return to the results screen by clicking on the Result button when necessary. |
 | Find button presents a list of existing items as per the selected filter criteria. From the list, users may select one record to retrieve the stored information. |
 | Click to Save button to save the information inputted. The record is stored and a confirmation message is presented. |
 | The Update button allows users to update all changes made to a record. |