Showing results for 
Search instead for 
Do you mean 

Adding a Custom Entity to SalesLogix 7.5.x

by ajappel on ‎08-03-2010 05:47 AM

The following is a collaborative effort from the Sage SalesLogix Sales Engineering team.

 

Objective

This document walks you through creating a new Entity called “Rates” which will have its own main menu button, list view, groups, data filters and data entry screen. 

 

This example is based off of a POC request where someone needed to track the tax rates a state government was charging.  The rates were subject to change once a year.  We will only be capturing a few of the fields in the POC, but once you have the new entity created and working, you can add fields to it exactly the same way that you would add fields to any other entity in SalesLogix.

 

1.0  Create New Entity

All of the data entry can be done using the New Entity wizard.  If changes need to be made you can enter them by either right clicking on Rates and selecting Update or by going to the Properties window.

 

  • In Application Architect  (VFS – Entity Model – Packages ) right click on SalesLogix Application Entities and select ‘New Entity’
    • Create a business entity and a new table
    • Display Name\Name\Table Name = Rates
    • Do not relate to an existing entity for this example
    • Add fields
      • Year - Text
      • Description - Text
      • APR - Text
      • MinimumInvestment – Double
    • Display Property = set field to something unique like Year. 
      • This is what will appear in the list view when you are on a detail screen (e.g.. Account Detail).
    • Select Images (gif)
      • Small image is 16 x 16
      • Large image is 24 x 24
  • File – Save All
  • Build Interfaces

 

2.0  Add Forms

We are going to add in two forms, an Insert form and an Edit form.  These two forms are required.  Additional forms (tabs) can also be entered.

 

 

2.1 Add Insert and Edit forms

  • In Application Architect  (VFS – Entity Model – Packages - SalesLogix Application Entities - Rate) right click on Forms and select New Form Wizard
    • frmRatesDetail
      • Detail form
      • Add in Year, Description, APR and MinimumInvestment
    • frmInsertNewRate
      • Detail form
      • Add Year field
  • File – Save All
  • Build Interfaces

 

2.2 Edit frmInsertNewRate

  • Click on gray area on form and then go to Properties window
  • Click ellipses on Toolbar and add in a Save button (recommend Right alignment)
    • Add – Button
      • Button Type = Save_16x16
      • Button Type = icon
      • OnClick Action – Action Name ellipses
        • Business Rule = Save
        • Business Rule Complete
          • OnCompleteActionItem
            • Redirect
              • MainViewEntity Mode = Detail
              • MainViewEntity Name = Rates
  • File – Save All

 

2.3 Edit frmRatesDetail

  • Change field properties
    • MinimumInvestment = Currency
    • APR = Numeric, Format Type is Percentage
    • Year = optional to assign this to a picklist.
  • Click on gray area on form and then go to Properties window (we are now editing the form properties)
    • Click ellipses on Toolbar and add in buttons (recommend Right alignment)
      • Add – Group Navigator
        • Do not make any changes
      • Add – Button
        • Button Type = Save_16x16
        • Button Type = icon
        • OnClick Action – Action Name ellipses
          • Business Rule = Save
      • Add – Button
        • Button Type = Delete_16x16
        • Button Type = icon
        • OnClick Action – Action Name ellipses
          • Business Rule = Delete
          • Confirmation Message = Delete this Rate?
  • File – Save All

 

3.0  Add Portal Folders

3.1 frmInsertNewRate

In Application Architect  (VFS – Portal Manager – Sage SalesLogix ) right click on Pages and select Add Main View

  • Enter Page Information
    • Alias = InsertRate   ß No Spaces.  This name will be used in Section 4.2
    • Title = Insert Rate
    • Description = Insert Rate
    • Small Image = select a 16x16 icon
    • Large Image =  select a 24x24 icon
  • Go to Advanced tab
    • Select Configure Base button
      • Entity – Entity Type
        • Select IRates from the dropdown list
        • OK
  • Go to Smart Parts tab
    • Remove LiveGroupViewer
    • Add frmInsertNewRate
      • Target Workspace= MainContent
      • Show In Mode = Insert
  • File – Save All

 

3.2 frmRatesDetail

In Application Architect  (VFS – Portal Manager – Sage SalesLogix ) right click on Pages and select Add Main View

  • Enter Page Information
    • Alias = Rates  ß Must be same as entity name.  Will use in Section 4.1
    • Title = Rate Detail
    • Description = Rate Detail
    • Small Image = select a 16x16 icon
    • Large Image =  select a 24x24 icon
  • Go to Advanced tab
    • Select Configure Base button
      • Entity – Entity Type
        • Select IRates from the dropdown list
        • OK
  • Go to Smart Parts tab
    • Add frmRatesDetail
      • Target Workspace = MainContent
      • Show In Mode = Detail
    • DO NOT REMOVE LiveGroupViewer
  • File – Save All

 

4.0  Navigation

This needs to be tested and verified, but for the time being add in the icons for Rate (recommend using icons from Section 1.0 Create New Entity) at every opportunity (New Main Menu button, Toolbar menu…)

 

4.1 Navigation Bar – Part One

  • In Application Architect  (VFS – Portal Manager) double click on Sage SalesLogix and wait for screen to open.
    • Go to Navigation tab
      • Under Navigation tab make sure that the drop down says Navigation Bar.  The other 2 options are Toolbar Menus and Context Menus
      • Right click on Sales and select Add Navigation Item
      • Item Id =navRate
      • Title = Rate
      • Small Icon = select a 16x16 icon
      • Large Icon =  select a 24x24 icon
      • Nav URL = Rates.aspx   ß Select from dropdown
      • Context Menu = <to be entered in after Context Menu is added>
  • File – Save All

 

Do not close the current screen.  We are now going to go and create a Context Menu for Rate.  Once this is done we will come back to the current screen and enter in the Content Menu.

 

4.2 Context Menu

  • On the Navigation tab, select “Context Menus” from the drop down list
    • Copy the Nav URL for New Contact/Account
      • We will use similar syntax when adding in a new Rate
      • InsertContactAccount.aspx?modeid=Insert
    • Right click on Context Menus and select Add Menu Item
      • Item Id = contextRate
      • Title = Rates
      • Small Icon = select a 16x16 icon
      • Large Icon =  select a 24x24 icon
    • Right click on Rate (the new menu item you added) and select Add Menu Item
      • Item Id = menuInsertRate
      • Title = New Rate
      • Description = New Rates
      • Small Icon = select a 16x16 icon
      • Large Icon =  select a 24x24 icon
      • Nav URL = InsertRate.aspx?modeid=Insert  ß Manually enter
        • Recommend using the dropdown to verify the InsertRate.aspx page name before keying in Nav URL syntax
  • File – Save All

 

4.3 Navigation Bar - Part Two

We will now go back to the previous screen (Navigation tab – Navigation Bar dropdown value)

  • Select Rate.  Item Id should be “navRate”
  • Context Menu = Context Rate
  • File – Save All

 

4.4 Toolbars - Optional

It is optional to add toolbars at this point.  If you wish to do so simply change the dropdown on the Navigation tab to Toolbar Menus.

 

5.0  Build Web Platform + Deploy

Follow standard Build Web Platform and Deploy steps.

 

6.0  Final Steps

The final step is to create a default group for Rates in the SalesLogix web client.

 

6.1 Create All Rates Group

  • Click on the Rates main menu button.
  • Click on Groups (upper right hand corner) and select Add Group 
    • Name = All Rates
    • Layout
      •   Year
      • Description
      • APR
        • format type = Percentage
        • format = %2.0f%%
      • MinimumInvestment
        • format type = Number
        • format = %.2n

6.2 Add in Data Filters

Follow standard steps for adding in data filters.

Register Read Guidelines Request Partner or Employee Access

What's New in 8.1

Labels