View Article

Edit a Load Method

By Xelence Documentation posted 07-29-2021 16:52

  

Introduction

This process allows you to edit methods for your application to be successful. At any time, you can edit these details to change the way the entity behaves or relates to other objects in your project.

Prerequisites

The method you want to edit must already exist.

Quick Steps
1 Search for and open the entity
2 Open the Methods section, then open the Load section
3 Open the method you would like to edit
4 Edit the method
5 Edit method properties, if desired, then click OK
6 Save the entity

Detailed Steps

Step 1. Search for and open the entity.

In this example, it is the Order Details entity.


Step 2. Open the Methods section, then open the Load section.

This is where you can manage methods in the entity.



Step 3. Edit the method as necessary.

Update the fields as necessary: 

  • Name: Programmatic ID of the method.
  • Load Method: If checked, the method loads the data for the form. Also, this allows you to specify the mode for which the method applies.
  • Load Main CDO; If checked, the method loads the entity from the table it is linked to.
  • Description: Text that describes what the method does.
  • Load Method Mode: Displays the method load type. Options are New, Update, or All.
  • Load Query: This loads the main object. If it is not set, the method will use the default query and will load the main object with the primary key.



Step 4. Edit the method properties as necessary, then click OK.

Update the fields as necessary: 

  • Type: Specifies the type for the load method.
  • Name: Programmatic ID of the method property.
  • Parameter: Navigation parameter (populates automatically, if any).
  • Load Type: Specifies whether to only create the object or create the object and perform associated operations.
  • Load Source: Based on the Load Type, opens the load source if applicable (among none, specific column, query, or web API to be loaded).
  • Order By: Used to sort the result set by a list of columns.
  • Sort Order: Used to sort the result set in ascending or descending order.
The Types are:

Attributes: Name of the attribute. This is the meaningful name Xelence will sue everywhere it refers to the attribute.
Rule: It is a combination of condition(s) and action(s) that form the business decision.
Load Method: This will execute the method to load the collection or object.

The Load Types are:

None: This just creates the object.
Foreign Key: This creates the object and executes a query with all columns for the table associated with that method. The query uses the primary key as its where clause (where primary_key = @primary_key).
Query: This creates the object and populates the main cdo property with the column of the query result.
WebAPI: This creates the object and returns data that is mapped to the object. You need to select the API ID in the Load Source field for this.
Connector: This loads the data in the object. You must enter the connector details in the Load Source.
AutoLoad: This automatically loads the object based on database keys.
Tip: If the method passes a parameter, the controls that use that parameter will require it as a property. You can assign certain parameters directly on such controls, but it must be passed 
from the method where they are called.



Step 5. Save the entity.

It saves your updated method.



What are the improvements over S3 Version 6?

The process is identical.


Related Articles

Add a Load Method

Delete a Load Method


This post is part of the Entity topic. Click here to open the Entity Overview.


#Xelence
#Entity

0 comments
104 views