Entity parameters

Parameter

Description

Entity Name

Enter the name for the new custom entity you want to create.

This name identifies the following:

  • Entity table in the Sage CRM database.
  • Entity caption in the Sage CRM user interface.

The name you enter must:

  • Include 26 characters or less.
  • Be different from the existing names of tables in the Sage CRM database.

Entity Column Prefix

Enter the four letter prefix you want to add to the names of columns in the entity table.

Do not include an underscore. The prefix must follow the applicable identifier rules configured on the database server.

Tag with Component Name

Allows you to script out and further customize new entities. The value in this text box has the following format:

<EntityName>_Component

A new component with this name is added to Existing Components.

When creating a new custom entity, you can select this component and click Preview Script to view the changes involved in creating the entity.

You can set this component as the currently recording component and further customize the entity. For example, you can script out the entire customization.

For more information, see Scripting customizations in the Developer Help on the Sage CRM Help Center.

Add to My CRM

When selected, creates a custom list and a custom tab for the My CRM work area. Displays a list of new entity records associated with a user.

Add to Find

When selected, makes the custom entity available for search in Sage CRM.

Selecting this check box creates a custom search entry screen and a corresponding search results list.

Add to Team CRM

When selected, creates a custom list, an ASP page that displays the list, and a custom tab for the Team CRM work area. Displays a list of all new entity records associated with a team.

Has Companies

When selected, creates a company tab and adds a corresponding custom company list to the tab group.

This enables you to view a list of associated companies for all new entity records, and link existing companies to the new entity using a Link button.
To set up deduplication for companies in this scenario, see Enabling deduplication for custom entity.

Has Accounts

When selected, creates an account tab and adds a corresponding custom account list to the tab group.

This enables you to view a list of associated accounts for all new entity records, and link existing accounts to the new entity using a Link button.

This check box is only available if Integration is set up.

Owned by Companies

When selected, adds a custom tab to the Company tab group. This custom tab displays a list of associated new entity records for a company.

Allow Web Service Access

When selected, enables the new entity for Web Services. For more information, see Web Services in the Developer Help on the Sage CRM Help Center.

Has People

When selected, creates a people tab and adds a corresponding custom people list to the tab group.

This enables you to view a list of all associated people for all new entity records, and link existing people to the new entity using a Link button.
To set up deduplication for people in this scenario, see Enabling deduplication for custom entity.

Owned by People

When selected, adds a custom tab to the People tab group.

This custom tab displays a list of associated new entity records for a person.

Allow Read-only SData Access

When selected, enables the new entity for SData. For more information, see SData in the Developer Help on the Sage CRM Help Center.

Has Opportunities

When selected, creates an opportunities tab and adds a corresponding custom opportunities list to the tab group.

This allows you to view all the associated opportunities for all new entity records.

Has Leads

When selected, creates a lead tab and adds a corresponding custom leads list to the tab group.

This allows you to view all the associated leads for all new entity records.

Owned by Leads

When selected, adds a custom tab to the Leads tab group.

This custom tab displays a list of associated new entity records for a lead.

Has Cases

When selected, creates a cases tab and adds a corresponding custom cases list to the tab group.

This allows you to view associated cases for all new entity records.

Owned by Cases

When selected, adds a custom tab to the Cases tab group.

This custom tab displays a list of associated new entity records for a case.

Has Communications

When selected, creates a communications tab and adds a corresponding custom communications list to the tab group.

This allows you to view associated communications for all entity records.
Select this check box to perform mail merges from the context of the newly created entity.

Has Library

When selected, creates a library tab and adds a corresponding custom library list to the tab group.

This enables you to view all associated library entries for all new entity records.
Select this option to perform mail merges from the context of the newly created entity.

Owned by Orders

When selected, adds a custom tab to the Orders tab group.

This custom tab displays a list of associated new entity records for an order.

Owned by Quotes

When selected, adds a custom tab to the Quotes tab group.

This custom tab displays a list of all the associated new entity records for a quote.

Workflow

When selected, creates a workflow for the custom entity and enables default workflow rules for the new entity.

Has Workflow Progress

When selected, creates a progress table for the custom entity table and allows you to add progress notes for custom entity records.

Deduplication

When selected, creates a deduplication screen for the new entity so you can set deduplication rules in Sage CRM.

To set up a deduplication screen for a new entity that has People or has Companies, see Enabling deduplication for custom entity.

For Dot Net

When selected, creates an entity for which you can write a .NET module instead of using ASP pages. The entity is created with metadata in the usual way but as ASP pages are not created, you must use the .NET DLL to customize the entity.

Owned by Accounts

When selected, adds a custom tab to the Account tab group.

This custom tab displays a list of associated new entity records for an account.

This check box is only available if Integration is set up.

Owned by Opportunities

When selected, adds a custom tab to the Opportunities tab group. This custom tab displays a list of associated new entity records for an opportunity.