SKYVVA Administration Guide

  1. Home
  2. Docs
  3. SKYVVA Administration Guide
  4. 3. What is an interface?

3. What is an interface?

An Interface is the second main object in SKYVVA after the integration. The interface describes the structure of data to exchange between Salesforce and other applications. It has other property which defines the processing mode e.g. synchronous or asynchronous, batch or bulk, etc.

Important attributes to be considered while creating an Interface

Fields Description
NameMandatory field based on which interface is created.
StatusYou should always set the status to deployment to make sure the interface activated.
SequenceThe sequence is automatically incremented as and when you create a new interface. Only 2 digits are accepted, which means the max value is 99.
AdapterSelect a corresponding adapter based on your requirement to connect to a legacy system or homegrown database or CSV file, let us say if you want to connect to the database, you need to select related Jdbc/Odbc Adapter.
Source NameFor inbound scenario, always a sObject name for ex: Account since we are either inserting or updating the SObject in salesforce.
TypeIt could be Inbound or Outbound based on your requirement, Inbound is generally External system to SFDC and Outbound is from SFDC to any external legacy or homegrown systems.
Operation TypeSelect the operation based on the Type. If you select the Type Inbound then Operation Type could be Upsert, Update, Insert, and Delete. If you select the Type Outbound then you must select the operation type: none or upsert
Connect with MiddlewareMainly used if you are connecting to any legacy system through middleware.  For instance, if you want to connect to SAP through PO we can set this flag.
MetaData ProviderSpecify the Provider where the message type belongs to.
Processing ModeYou can select the mode either synchronous or Asynchronous depending on business logic.
Bulk ModeIf this flag is checked, then the interface will run in a bulk mode using Salesforce BULK API.
Batch ModeIf this flag is checked, then batch processing activated and messages processed in bulk. Typically, baskets have created in SKYVVA.
RepositorySelect the repository, which contains the message type to be used for the interface. This field is a control field for selecting the message type. If don’t set all message type from all repository is listed which is huge.
Search in Source/Target Message TypeThe message type from the iRepository. You need to define first a message type in the iRepository. For the inbound interface, it is used as the source type. For outbound interface as target type.
DescriptionTo give a meaningful description of your interface.
Note

Important thing to note, only outbound interface requires an adapter.

For the outbound scenario, it could be a sObject name or IDoc-Bapi name or Database name or Filename based on the requirement.

Operation Type – ‘Query’ works for both directions ‘Inbound’ as well as ‘Outbound’

Change an Interface

There is a time when you want to change your interface due to the problem occurs. What you have to do is just edit your interface. To edit your interface, simple checkbox on one interface and click on the “edit” button on the list view of your interface.

 Interface List

The interface List includes operations for the following: Positional access — manipulates elements based on their numerical position in the list.

Articles

Was this article helpful to you? Yes No

How can we help?