Introduction
The new agent control board is a component which can connect different application system. Besides the component connect that we build on salesforce already. But some protocol we cannot build on salesforce which technically not possible. That’s why we build a new component called “Any Connect” which is based on apache camel is open source around the world.
Screen Configuration:
Kanban TAB Salesforce -> Agent
This is the second kanban tab. On this tab, we define a new connection for the direction Salesforce -> Agent. If the user selects an existing connection then we will display the configuration and the user can, for example, do a ping test. In a new creation mode, he will enter the properties needed for the connection from Salesforce to Agent.
- Host
- Port
- Endpoint
- Username
- Password
- Reverse Proxy setting:
- Proxy Host HTTP
- Proxy Port HTTP
- Proxy Host HTTPS
- Proxy PortHTTPS
- Proxy User
- Proxy Password
After entering the data the user can click on the button ‘ping‘ to make a ping test. If success he can save the setting to the table ‘adapterInstance__c‘ where the field direction is set to ‘SF2A‘. The record is only saved into the Salesforce table and not to the H2 database on the agent. Caching this record is not needed. In this screen, the user can create the connection to different agent instances and for each instance, we will create a record in the table ‘adapterInstance__c‘.
Screen Configuration: Kanban TAB Agent -> Salesforce
This is the third kanban tab. This tab is the ‘Agent -> Salesforce‘ tab where we can display the connection entry for the direction Agent -> Salesforce and do the ping test or create a new connection. We need to specify the credential to log in to Salesforce from the Agent. We need different fields for authentication. For the basic authentication, we need the following fields are
- Username
- Password
- Instance URL
- Security Token
- Server Environment e.g. Sandbox or Production/Development
- Proxy setting:
- Proxy Host HTTP
- Proxy Port HTTP
- Proxy Host HTTPS
- Proxy PortHTTPS
- Proxy User
- Proxy Password
- OAuth 2.0 setting:
- Client-Id
- Client-Secret
These Articles provide users a cosmetic overview of the Administration part to maintain our SKYVVA Any Connect. Articles also explain to the user, How to install SKYVVA Any Connect, features, and working.
Follow the Reference link for more understanding
– How to use the Agent Control Board?
Since the user now completely understand; How to use the Agent Control Board, by hitting the upper link, now we understand the Architect of the Agent Control Board to follow below:
- Scheduler, Log Configuration, Logs, Cache Monitor, Adapter Monitor, Agent Cache, System Information tabs are dependent on Integration.
- Interface, Interface Group, Adapter, Import Metadata tabs are not dependent on Integration.
Agent Control Board has these Tabs
Configuration Tab — In which user has to Provide all information under the :
PROPERTIES FILE Tab
- Name
- Property File Name, Example: integration.properties
AGENT Server Credential under Salesforce–> AGENT Tab user has to provide the info.
- Username
- Hostname/Public IP
- Password
- Port/Port forwarding
- Ping Agent Connection
Salesforce Credential under Agent-> Salesforce Tab user has to provide the info.
- Username
- Security Token
- Password
- Server Environment
- Client Id
- Client Secret
- Ping Salesforce Connection
User has to provide all such information then the only user has to play with Agent Control Board
Interface Tab — Through which the user has to select Interface which is already linked (child) of Integration and further process into Salesforce respectively
Interface Group — There are two types are Interface Group
- Skyvva_DefaultIG_Outbound — Through which the user can get all related Outbound Integration Name
- Skyvva_DefaultIG — Through which the user can see all related Inbound Integration Name
Users can easily Edit, Delete, and create new information on Interface Group Name with the help of radio button options.
Adapter Tab — Through which the user can get all Inbound and Outbound Adapter type which is already linked with the related list on Interface detail page called Inbound Setup & Outbound Setup. Users can easily create, edit update and delete Adapter.
- This is a must to the user always create Adapter inside Agent Control Board
Schedulers — Through which the user can get all Inbound and Outbound Schedulers related to Integration Schedulers is a type of scheduled job which runs regularly bases on-time setting.
Cache Monitor — Monitor is used to checking the integration result after processing the Inbound or Outbound interface. The integration result includes Pending, Failed, Completed, Cancelled status, and the reason why it failed. Additionally, we can know the real sObject is integrated successfully with completed status.
– How to use Cache Monitoring?
Logs — The log tab is used to show the log file from the Agent. The physical log file is created and kept in the local folder of the Agent and we need to view the file in Salesforce because we don’t want to get into the Agent Server. Sometimes we don’t have any access from the customer to access the Agent-Server and thus it is not possible to read the log file to analyze the error. Therefore we want to have the possibility to get the log file and show it on the Log tab in Salesforce.
- Log file— In the section Logs, we store the error line from the log file into the ilog2 table. The button Refresh means that we re-read the data from the table to see the new entries which were pushed from the Agent on a regularly based through a scheduler. The Agent push using the REST api to insert new entries into the table ilog2__c and thus we need to do the Refresh to see new content. The button ‘Re-read from Agent’ is to actively read the new log entries without waiting for the scheduler. This is needed when we urgently need to see the latest log entries and cannot or don’t want to wait until the scheduler push the new entries into the table ilog2__c.
Log Configuration — We’re using Logback as the controlling framework for Logs. Logs will be segregated in mainly 2 categories are
- System Logs — Log file name is going to be SYSTEM-LOG.txt and it will include all the system maintenance API, framework logs.
- Business API Logs — Log file name would be formed with this format <IntegrationName>-<Hash generated based on Integration ID & Instance URL concatenated together>.txt. These logs will include the details about the Business APIs.
At any point in time, we can update the Logging configuration through the APIs build in the system. There will be a default Logging setting which will remain active in case of any starts or restarts of the Agent service. This Logging is not present in the DB rather in the logback.xml. At any point, if we want to create a logging profile, we can do so using the APIs built and described below. Then to activate we need to use activate API.
– How to use Log and Log Configuration Tab on Agent Control Board?
Import MetaData— The new agent control board is a component which can connect different application system. Besides the component connect that we build on salesforce already. But some protocols we cannot build on salesforce which technically not possible. That’s why we build a new component called “Any Connect” which is based on apache camel is open source around the world.
– How to Import Metadata from Agent Control Board?
Agent Cache— This tab shows us the table content e.g the cache on the h2 database in the Agent. We have to control and verify the content if it is caching down to the Agent and if the content is correct. Getting this possibility we do not need to ask the customer for the access to h2 database on their installation. We can do it the right way as SKYVVA support to find the inconsistency regarding the cache in between Salesforce and Agent. This simplifies our support life later in production use to the Agent.
- Currently, we are using the h2 database browser we need the user and password to the database browser to verify the content.
- We can look directly to the h2 cache table using the username and password which is configured with the ‘Configuration’ tab.
– How to use Agent Cache on Agent Control Board?
Adapter Monitor— This function allows the user to monitor the adapter. We provide only the monitor the file adapter to see files in the folder that users have to specify in the adapter property at the moment. This helps user to see, if we have too many files and thus it reaches a critical situation eg. we have stuck.
Kafka and pulsar adapter could make sense to see the message in the queue/topic. But we have not found any function which allows user to look into the queue without consuming the content and thus remove it automatically after the view. Therefore it makes sense from the business requirement but technically we cannot do that.
System Information— Through which the user can get all information about System Information
AGENT | Operating System | Memory |
|---|---|---|
 |  |  |
|
|
|
