STEROID Developer Guide

download STEROID Developer Guide

of 15

Transcript of STEROID Developer Guide

  • 7/28/2019 STEROID Developer Guide

    1/15

  • 7/28/2019 STEROID Developer Guide

    2/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    What is STEROID?

    STEROID is the worlds-first custom components framework for Force.complatform.

    STEROID is a library of re-usable capabilities and features for Desktops and Mobiledevices

    Why STEROID?

    STEROID impacts both the Business and IT positively.

    STEROID provided some of the key performance enhancing features for business throughConfigurable Keyboard Shortcuts, Simple Wizard Flows, Porting Salesforce to MobileDevices, Smart & Dynamic Lists and Inline Reference Data components.

    STEROID also reduces IT & Operational budgets by providing simple to use componentsdelivering compact, precise and manageable code artifacts. 90% of the STEROIDcomponents are realized with juts one line of code. Our lab benchmarks recorded over70% reduction in development times and over 80% reduction in testing/quality cycles

    How to use STEROID?

    STEROID is a 100% native application, and is a natural extension to developing onForce.com platform. One would use STEROID the same way as the other Visualforcecomponents. STEROID will be enabled for any given Visualforce page by 2 simple steps

    1. Add STEROID.RuntimeExtension as one of extension to the VF Page2. Include component with as shown below

    //Include other STEROID and/or Standard Visualforce Components as needed

  • 7/28/2019 STEROID Developer Guide

    3/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    A Typical STEROID PAGE(Visualforce page for a New LEAD is shown below)

  • 7/28/2019 STEROID Developer Guide

    4/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Compound Action

    Compound Action component realizes actions like Save & New and Save & Close.

    Name Compound Action

    Description Compound Action realizes actions like Save & New

    Attributes Compound Action supports 3 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Type Yes Type=SaveAndNew (OR)

    Type=SaveAndCloseLabel Yes Label=Save & New

    Syntax

    When to use Use this component when you need to combine Save action with NEWOR CLOSE actions. Save & New action saves the current record andnavigates the user to the new record page. Save & Close action savesthe current record and navigates the user back to the object Tab page.

  • 7/28/2019 STEROID Developer Guide

    5/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Data Hover

    Data Hover component loads a Popup with data from a Related Object when hoversover a specified field on the UI. This component is designed to work with Output fields.

    Name Data Hover

    Description Loads a Popup with data from a Related Object

    Attributes Data Hover supports 8 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Anchor Yes Id of the field for the PopupObjectId Yes 18 digit Id for the Related

    Object

    FieldsList Yes The list of the fields from theRelated Object that would bedisplayed in the popup window

    Title Yes Title for the Popup windowWidth No Width of the popup windowFrameColor No Popup frame colorBodyColor No Popup body color

    Syntax

    When touse

    Use this component when you need to show data from a RelatedObject when the user hovers over a specific field

  • 7/28/2019 STEROID Developer Guide

    6/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Directive

    Directive component directs the runtime engine to perform a specific task of optimizingthe field lengths OR to display the remaining size for any text field with a maximum

    character limit

    Name Directive

    Description Directs the runtime engine to perform a specific task

    Attributes Directive supports 6 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Type Yes Directive Type

    OptimizeFieldLengths(OR)ShowRemainingFieldSizeScope No Id of the container for thedirective

    FieldSize No Desired field size (eg: 70%),applicable only forOptimizeFieldLengths

    IndicatorBodyColor No Size Indicator Backgroundcolor (only forShowRemainingFieldSizedirective)

    IndicatorTextColor No Size Indicator Text color (onlyfor ShowRemainingFieldSize

    directive)

    Syntax

    When touse

    Use this component to adjust the size of the fields for a uniform visualappearance and for to display the remaining character size whileentering data in a specific field (for which a maximum character limit isset)

  • 7/28/2019 STEROID Developer Guide

    7/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Highlighter

    Highlighter component highlights a set of fields based a business rule.

    Name Highlighter

    Description Highlights a set of fields based a business rule

    Attributes Directive supports 4 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Condition Yes The Business Condition for the

    highlighterFieldsList Yes List of fields to be impacted by

    Highlighter

    Color No Highlight colorSyntax

    When to use Use this component to highlight a set of fields based on a business rule

  • 7/28/2019 STEROID Developer Guide

    8/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID List

    List component generates a smart & qualified list with navigational, sort, filter and inlineedit controls.

    Name List

    Description Generates a smart & qualified list

    Attributes Directive supports 7 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Object Yes List ObjectColumns Yes Columns to be displayedNew Yes New Action URL

    WhereClause No Where Clause for the ListTitle No List TitleFramecolor No Frame color for easy visual

    identification

    Syntax When to use Use this component to display smart & qualified lists like all Open

    Opportunities OR All Close Cases etc

  • 7/28/2019 STEROID Developer Guide

    9/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Reference Data

    Reference Data component displays data from a Related Object inline with the parentfields

    Name Reference Data

    Description Displays data from a Related Object inline with the parent fields

    Attributes Reference Data supports 7 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Anchor Yes Id of the field for the PopupObjectId Yes 18 digit Id for the Related

    Object

    FieldsList Yes The list of the fields from theRelated Object that would bedisplayed in the popup window

    Title Yes TitleFrameColor No Frame colorBodyColor No Body color

    Syntax

    When touse

    Use this component when you need to show data from a RelatedObject inline with the parent data

  • 7/28/2019 STEROID Developer Guide

    10/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Section

    Section component renders a section (Edit OR Detail) with specified fields

    Name Section

    Description Renders a Section (Edit OR Detail) with specified fields

    Attributes Section supports 6 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}FieldsList Yes The list of fields for the sectionHeading No Section HeadingMode No Section ModeColumns No Number Of Columns

    Guidance No Section GuidanceSyntax

    When touse

    Use this component to quickly create a section in Edit OR Detail mode.

  • 7/28/2019 STEROID Developer Guide

    11/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Shortcut

    Shortcut component creates a keyboard shortcut

    Name Shortcut

    Description Creates a keyboard shortcut

    Attributes Shortcut supports 7 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Sequence Yes Key SequenceKeyAction Yes ActionLabel Yes Display LabelMessage No Display Message when this

    shortcut is executedConfirmMessage No Confirmation Message for this

    shortcutInline No Future Reference

    Syntax

    When to use Use this component to create keyboard shortcuts

  • 7/28/2019 STEROID Developer Guide

    12/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Step

    Step component creates a step in a wizard.

    Name Step

    Description Creates a step in a wizard.

    Attributes Step supports 7 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Heading No Step HeadingPosition Yes Step PositionMode No Step ModeColumns No Number of Columns

    FieldsList Yes The list of fields for the stepGuidance No Step Guidance

    Syntax

    When to use Use this component to create a step in a wizard

  • 7/28/2019 STEROID Developer Guide

    13/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Sticky

    Sticky component displays contextual business notifications

    Name Sticky

    Description Displays contextual business notifications

    Attributes Sticky supports 9 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Title No TitleMessage Yes MessageCondition Yes Business ConditionPosition No Display Position

    Width No Sticky widthHeight No Sticky HeightBodyColor No Body ColorTextColor No Text Color

    Syntax

    When to use Use this component to display contextual business alerts

  • 7/28/2019 STEROID Developer Guide

    14/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Text Hover

    Text Hover component loads a Popup with supplied text when hovers over a specifiedfield on the UI.

    Name Text Hover

    Description Loads a Popup with supplied text

    Attributes Text Hover supports 7 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Anchor Yes Id of the field for the PopupText Yes Text for the PopupTitle Yes Title for the Popup window

    Width No Width of the popup windowFrameColor No Popup frame colorBodyColor No Popup body color

    Syntax

    When to use Use this component when you need to show popup Text when theuser hovers over a specific field

  • 7/28/2019 STEROID Developer Guide

    15/15

    STEROID

    Worlds-first custom components framework for Force.com

    Clerisoft, Inc (2008 2012) www.clerisoft.com / [email protected] / (408) 637 5710

    STEROID Wizard

    Wizard component creates a multi-page wizard with navigational controls

    Name Wizard

    Description Creates a multi-page wizard with navigational controls

    Attributes Wizard supports 8 attributes

    Name Required? SampleRuntime Yes Runtime={!Runtime}Steps Yes Number of Wizard StepsTitle Yes TitleSubTitle Yes SubTitleHeaderBackground No Header Background

    HeaderColor No Header Text ColorBodyBackground No Body Background ColorBodyColor No Body Text Color

    Syntax

    When touse

    Use this component to create a multi-page wizard