@ind-rcg/modeler-sfdx-cli-plugin 246.1042.1

package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/SaveAsync/Bo${NAME}.BeforeSaveAsync.bl.js

@@ -0,0 +1,56 @@
+"use strict";
+
+///////////////////////////////////////////////////////////////////////////////////////////////
+//                 IMPORTANT - DO NOT MODIFY AUTO-GENERATED CODE OR COMMENTS                 //
+//Parts of this file are auto-generated and modifications to those sections will be          //
+//overwritten. You are allowed to modify:                                                    //
+// - the tags in the jsDoc as described in the corresponding section                         //
+// - the function name and its parameters                                                    //
+// - the function body between the insertion ranges                                          //
+//         "Add your customizing javaScript code below / above"                              //
+//                                                                                           //
+///////////////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Use the following jsDoc tags to describe the BL function. Setting these tags will
+ * change the runtime behavior in the mobile app. The values specified in the tags determine
+ * the name of the contract file. The filename format is “@this . @function .bl.js”.
+ * For example, LoVisit.BeforeLoadAsync.bl.js
+ * -> function: Name of the businessLogic function.
+ * -> this: The LO, BO, or LU object that this function belongs to (and it is part of the filename).
+ * -> kind: Type of object this function belongs to. Most common value is "businessobject".
+ * -> async: If declared as async then the function should return a promise.
+ * -> param: List of parameters the function accepts. Make sure the parameters match the function signature.
+ * -> namespace: Use CORE or CUSTOM. If you are a Salesforce client or an implementation partner, always use CUSTOM to enable a seamless release upgrade.
+ * -> extends: Base class of the LO, BO, and LU objects that this function belongs to.
+ * -> maxRuntime: Maximum time this function is allowed to run, takes integer value in ms. If the max time is exceeded, error is logged.
+ * -> returns: Type and variable name in which the return value is stored.
+ * @function beforeSaveAsync
+ * @this Bo${NAME}
+ * @kind businessobject
+ * @async
+ * @namespace ${NAMESPACE}
+ * @param {Object} context
+ * @returns promise
+ */
+function beforeSaveAsync(context){
+    var me = this;
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    //                                                                                           //
+    //               Add your customizing javaScript code below.                                 //
+    //                                                                                           //
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    
+    
+    var promise=when.resolve(context);
+		
+   
+  
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+    //                                                                                           //
+    //               Add your customizing javaScript code above.                                 //
+    //                                                                                           //
+    ///////////////////////////////////////////////////////////////////////////////////////////////
+
+    return promise;
+}

package/templates/contractTemplates/BO_BusinessObject/businessobject/BusinessObject.md

@@ -0,0 +1,186 @@
+# Business Object (BO) Contract Definition
+
+## Description
+The Business Object Contract specifies the Business Objects used in the Mobility Application.
+
+### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|simpleEditorOnly|Boolean|yes (default='false')| If this attribute is set to true, the modeler prevents opening in tree editor. This might be necessary as an early adaptor of the modeler to use features of the framework before Editor support is available |none|
+|name|String|no|Defines the name of the Business Object as well as the name of the JS File generated.| Name needs to be unique for all BOs in the Model|
+|generateLoadMethod|Boolean|yes (default='true')|Specifies if a load method should be generated for this BO. If Property is 'False', the customizer|designer has to care for the implementation on his own (in the beforeLoadAsync or afterLoadAsync Method)||
+|generateCreateMethod|Boolean|yes (default='true')|Specifies if a create method should be generated for this BO. If Property is 'False', the customizer|designer has to care for the implementation on his own (in the beforeLoadAsync or afterLoadAsync Method)||
+|baseClass|String|yes|comboBox values: "FrameworkUser" or "[empty]".||
+
+### Example
+```
+<BusinessObject name="BoOrder" generateLoadMethod="false" generateCreateMethod="false">
+```
+## Sections inside the BO contract
+### DataSource
+Each BusinessObject Contract has exactly one DataSource Node. It defines the relation to the Data Source. The only Attribute of the Data Source Node is the Name of the Data Source. 
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Defines the name of the DataSource|DataSource with this name must exist in the model|
+
+#### Example
+```
+<DataSource name="DsBoOrder" />
+```
+
+### SimpleProperties
+SimpleProperties contains a list of Simple Properties (1..N) of the Business Object. The SimpleProperties Node does not have any attributes, but it has a list of SimpleProperty SubNodes.
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Defines the name of the Simple Property|Must be unique in the List of simple Properties, nested Objects, nested Lookup, nested List Objects, Methods and Validations.|
+|type|Name of a Domain or JavaScript Type (Boolean, Sting, Object,...)|no|Defines the Type of the Simple Property. Important for Validations and Constistency Checks.|Must be in the List of Domain Names or in a list of reserved JS Types.|
+|id|Boolean|no|One of the Simple Properities has to be defined as id Property|Exactly one of the Simple Properties needs to be specified as ID Property|
+|dataSourceProperty|String (List of DataSource.Attributes.Attribute.@name / DataSource.Attributes.PivotItems.PivotItem.Attribute.@name / DataSource.Attributes.PivotItems.PivotItem.PivotConstant.@name / DataSource.Attributes.PivotItems.PivotItem.PivotDerivedAttribute.@name / DataSource.Attributes.PivotItems.PivotItem.DateTimeAttribute.@dateName / DataSource.Attributes.PivotItems.PivotItem.DateTimeAttribute.@timeName / of the specified DataSource)|no|In current Contracts many Simple Properties are defined without valid dataSourceProperties (Attribute exists but content not valid)|DataSourceProperty must exist in the List of Attributes of the DataSource. Types must match|
+|nullable|Boolean|yes| ability to specify emtpy nubmers| if true, must match related column in dbTable contract|
+|blobPkeyField|String|yes||if set, depending property:blobTable|
+|blobTable|String|yes||if set, depending property: blobPKeyField|
+
+
+```
+<SimpleProperty name="orderId" type="DomId" id="true" dataSourceProperty="orderId" />
+<SimpleProperty name="commitDate" type="DomDate" dataSourceProperty="commitDate" />
+```
+
+#### Events [optional]
+The Events node is optional and contains exactly one "Event" Subnode.
+
+##### Event
+An Event Node has no further Subnodes
+###### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Fixed "onChanged" for simpleProperty Events|Fixed "onChanged" for simpleProperty Events|
+|eventHandler|String|no|Defines the Method whoch should be called if the value of the simple property changes|Must be part of the defined Methods of this BO|
+
+```
+<SimpleProperty name="deliveryDate" type="DomDate" dataSourceProperty="deliveryDate">
+    <Events>
+        <Event name="onChanged" eventHandler="onHeaderDeliveryDateChanged" />
+    </Events>
+</SimpleProperty>
+
+```
+
+### NestedObjects
+NestedObjects contains a list of nested Business Objects(0..N) of the Business Object. The NestedObjects Node does not have any attributes, but it has a list of NestedObject SubNodes.
+#### NestedObject
+A NestedObject Node has no further Subnodes
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Defines the name of the nested Business Object|Must be unique in the List of simple Properties, nested Objects, nested Lookup, nested List Objects, Methods and Validations.|
+|objectClass|Name of the referenced BusinessObject|no|Defines the Type of the Business Object. Important for Validations and Constistency Checks|Must be in the List of Business Objects Names|
+|dataSourceProperty|String (List of Simple Properties of the BO)|no|This Property is used as input to load the nested Busienss Object|dataSourceProperty is available as Simple Property of the Business Object|
+|nestingProperty|String (List of Simple Properties of the nested Business Object)|no|This Property is used to load the nested Business Object|nestingProperty is available as SimpleProperty of the nested Business Object|
+
+##### Example
+```
+<NestedObjects>
+    <NestedObject name="hurdleEvaluationHelper" objectClass="BoHurdleEvaluationHelper" dataSourceProperty="empty" nestingProperty="empty" />
+</NestedObjects>
+```
+### ObjectLookups
+ObjectLookups contains a list of Object Lookups (0..N) of the Business Object. The ObjectLookups Node does not have any attributes, but it has a list of ObjectLookup SubNodes.
+#### ObjectLookup
+A ObjectLookup Node has no further Subnodes
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Defines the name of the nested Object Lookup|Must be unique in the List of simple Properties, nested Objects, nested Lookup, nested List Objects, Methods and Validations.|
+|objectClass|Name of the referenced LookupObjects|no|Defines the Type of the LookupObjects. Important for Validations and Constistency Checks.|Must be in the List of Lookup Objects Names|
+|dataSourceProperty|String (List of Simple Properties of the BO)|no|This Property is used as input to load the Lookup Object|dataSourceProperty is available as Simple Property of the Business Object|
+|lookupProperty|String (List of Simple Properties of the nested Lookup Object)|no|This Property is used to load the Lookup Object|lookupProperty is available as SimpleProperty of the nested Lookup Object|
+##### Example
+```
+<ObjectLookups>
+    <ObjectLookup name="luOrderer" objectClass="LuOrderer" dataSourceProperty="ordererPKey" lookupProperty="pKey" />
+</ObjectLookups>
+```
+### ListObjects
+ListObjects contains a list of nested List Objects(0..N) of the Business Object. The ListObjects Node does not have any attributes, but it has a list of ListObject SubNodes.
+#### ListObject
+Can have a subnode of Events
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Defines the name of the nested List Object|Must be unique in the List of simple Properties, nested Objects, nested Lookup, nested List Objects, Methods and Validations.|
+|objectClass|Name of the referenced ListObject|no|Defines the Type of the List Object. Important for Validations and Constistency Checks.|Must be in the List of List Objects Names|
+|dataSourceProperty|String (List of Simple Properties of the BO)|no|This Property is used as input to load the ListObject|dataSourceProperty is available as Simple Property of the Business Object|
+|listProperty|String (List of Simple Properties of the nested ListObject/ ListItem)|no|This Property is used to load the List Object|listProperty is available as SimpleProperty of the nested ListObject/ ListItem|
+
+##### Example
+```
+  <ListObjects>
+    <ListObject name="LoItems" objectClass="LoOrderItems" dataSourceProperty="pKey" listProperty="sdoMainPKey" />
+  </ListObjects>
+```
+
+##### Events [optional]
+The Events node is optional and contains exactly one "Event" Subnode.
+
+###### Event
+An Event Node has no further Subnodes
+###### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Fixed "listItemChanged" for ListObejct Events|Fixed "listItemChanged" for ListObejct Events|
+|eventHandler|String|no|Defines the Method whoch should be called if an Item of this List Object changes|Must be part of the defined Methods of this BO|
+
+##### Example
+```
+<Events>
+    <Event name="listItemChanged" eventHandler="onNotesChanged" />
+</Events>
+```
+
+
+### Validations [optional]
+The Validations Node has no attributes but a list of Validation Sub Nodes (0..N)
+
+#### Validation
+No Sub Nodes are available
+
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Defines the name of the Validation|A Method with this name must exist in the model and this method has a relation to this BO|
+
+##### Example
+```
+  <Validations>
+    <Validation name="validateOrderValue" />
+  </Validations>
+```
+
+### Methods 
+The Methods Node has no attributes but a list of Method Sub Nodes (0..N)
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Defines the name of the Method|A Method with this name must exist in the model and this method has a relation to this BO|
+
+#### Example
+```
+  <Methods>
+    <Method name="beforeSaveAsync" />
+    <Method name="afterSaveAsync" />
+    <Method name="beforeLoadAsync" />
+    <Method name="afterLoadAsync" />
+    <Method name="beforeInitialize" />
+    <Method name="afterInitialize" />
+    <Method name="beforeDoValidateAsync" />
+    <Method name="afterDoValidateAsync" />
+    <Method name="beforeCreateAsync" />
+    <Method name="afterCreateAsync" />
+    <Method name="loadAsync" />
+    <Method name="saveAsync" />
+    <Method name="createAsync" />
+  </Methods>
+```

package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectListObjectsListObjectEventsSnipp.xml

@@ -0,0 +1,3 @@
+<Events>
+	<Event name="listItemChanged" eventHandler="${#name#}" />
+</Events>

package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectListObjectsListObjectSnipp.xml

@@ -0,0 +1 @@
+<ListObject name="${#name#}" objectClass="" dataSourceProperty="" listProperty="" />

package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectNestedObjectsNestedObjectSnipp.xml

@@ -0,0 +1 @@
+<NestedObject name="${#name#}" objectClass="" dataSourceProperty="" nestingProperty=""/>

package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectObjectLookupsObjectLookupEventsSnipp.xml

@@ -0,0 +1,3 @@
+<Events>
+	<Event name="onChanged" eventHandler="${#name#}" />
+</Events>

package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectObjectLookupsObjectLookupSnipp.xml

@@ -0,0 +1 @@
+<ObjectLookup name="${#name#}" objectClass="" dataSourceProperty="" lookupProperty=""/>

package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectSimplePropertiesSimplePropertyEventsSnipp.xml

@@ -0,0 +1,3 @@
+<Events>
+	<Event name="onChanged" eventHandler="${#name#}" />
+</Events>

package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectSimplePropertiesSimplePropertySnipp.xml

@@ -0,0 +1 @@
+<SimpleProperty name="${#name#}" type="" id="false" dataSourceProperty=""/>

package/templates/contractTemplates/BO_BusinessObject/businessobjecthelper/snippets/BusinessObjectHelperSimplePropertiesSimplePropertySnipp.xml

@@ -0,0 +1 @@
+<SimpleProperty name="${#name#}" type="${#type#}"/>

package/templates/contractTemplates/BO_BusinessObject/validationmessages/ValidationMessage.md

@@ -0,0 +1,38 @@
+# Validation Message Contract Definition
+## Description
+A validation messages contract holds all of the validation messages for a particular business object. There is one validation message contract per business object.For example, the validation message contract for the Order business object is called BO_Order_ValidationMessages. Individual validation messages in the validation messages contract can be called from Validate methods (business logic contracts).  Each validation message can be referenced via its name. In the Validate method, the "messageID" refers to the value of the "name" attribute of the validation message.
+
+## Validation Message Contract Definition
+Hierarchical Definition of the Nodes, Attributes and possible Subnodes.
+
+### Root Node (ValidationMessages Node)
+#### Example
+```
+<ValidationMessages name="BoCallMessages" businessObject="BoCall" schemaVersion="0.0.0.5">  
+  <ValidationMessage name="CasClbRemainingOpenOrders" defaultMessage="Validation notification! There are still open orders!" comment=" " />  
+  <ValidationMessage name="CasClbNotAllMandatoryStoreSurveysAnswered" defaultMessage="Validation notification! Not all mandatory store surveys are answered! #questions#" comment=" " />  
+  ...
+</ValidationMessages>
+```
+#### Parameters:
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|The name used to identify the validation messages||
+|businessObject|String|no|Name of the businessobject, the messages are related to||
+|schemaVersion|String|no|Version of the design contract||
+ 
+#### Sub Nodes:
+
+##### ValidationMessage
+Every <Validationmessages> node contains 1..n <Validationmessage> childnodes
+
+#### ValidationMessage Node
+This node describes a single validaiton message
+
+##### Parameters:
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|The name used to identify a single validation message|name must be unique for the contract|
+|defaultMessage|String|no|The default message that will be displayed if there is no applicable translation||
+|comment|String|yes|A comment that is only visible to the custimizer who looks at the conract in the modeler||
+

package/templates/contractTemplates/BO_BusinessObject/validationmessages/snippets/ValidationMessagesValidationMessageSnipp.xml

@@ -0,0 +1 @@
+<ValidationMessage name="${#name#}" defaultMessage="${#defaultMessage#}" comment="${#comment#}" />

package/templates/contractTemplates/DS_DataSource/DataSource.md

@@ -0,0 +1,319 @@
+# DataSource (DS) Contract Definition
+
+## Description
+DataSource Contracts are design time artifacts describing a common way for data access and manipulation of existing enterprise information system.
+The main goal of this document is to have a common understanding of the different elements that constitute a definition of a DataSource Contract.
+
+## Contracts Elements
+The following sections describe all elements that could be find in a definition of a DataSource Contract. The DataSource Node has the following Parameters
+
+## Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Name of the Data Source||
+|businessObjectClass|String|no|Name of the assigned BO||
+|external|Boolean|yes|external DataSources provide Javascript Methods to build the Select, Update, Insert or Delete Statements|True|
+|editableEntity|String|yes|	contains the name of the editable Entity (for editable DataSources relevant only)||
+|distinct|Boolean|yes|specifies if a Distinct Select Statement is generated|False| 
+|readOnly|Boolean|yes|specifies if the Update, Delete and Insert Statements are generated|False|
+|schemaVersion|String|no|Version of the design contract.||	 
+|backendSystem|String|no|specifies the target Backend System of the Data Source. Currently only sf is allowed|sf|
+
+### Attributes
+Attributes contains a list of Attributes (1..N) of the Datasource. The <Attributes> node does not have any attributes itself, but it has a list of <Attribute> SubNodes. The DS Attributes are mapped to the Business Objects Simple Properties. There are four types of supported attribute nodes
+
+#### Attribute (most common)
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Name of the Attribute||
+|table|String|no|Name of the assigned table||
+|column|String|no|Name of the assigned column||
+
+#### DerivedAttribute
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Name of the Attribute||	 
+|value|String|no|value of derived attribute||	
+ 
+#### DateTimeAttribute
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|dateName|String|no|||	 
+|timeName|String|no|||	
+|table|String|no|Name of the assigned table||	 
+|column|String|no|Name of the assigned column||
+
+#### PivotItems
+Can have multiple PovotItem elements
+PivotItems does not have any parameter. Only the node name
+
+### Example
+```
+  <PivotItems>
+  <!-- Delivery Recipient Role-->
+  <PivotItem id="deliveryrecipient">
+    <Attribute name="customerPKey" table="Account_Extension__c" column="Account__c" />
+    <Attribute name="validThru" table="Account_Extension__c" column="Delivery_Role_Valid_Thru__c" />
+    <Attribute name="validFrom" table="Account_Extension__c" column="Delivery_Role_Valid_From__c" />
+    <PivotConstant name="salesOrg" value="'#SalesOrg#'" />
+    <PivotConstant name="bpaRoleMetaPKey" value="' '" />
+    <PivotDerivedAttribute name="category" pivotName="deliveryRoleCategory" value="CASE WHEN #compareAsDate('Delivery_Role_Valid_From__c', 'Date','le',#TodayAsDate#, 'Date')#  AND #compareAsDate('Delivery_Role_Valid_Thru__c', 'Date','ge',#TodayAsDate#, 'Date')# THEN 'deliveryrecipient' ELSE ' ' END" />
+  </PivotItem>
+```
+
+##### PivotItem
+Contains a list of Attributes (1..N) of the datasource. Does also support PivotConstant and PivotDerivedAttribute
+
+##### Attribute
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Name of the Attribute||
+|table|String|no|Name of the assigned table||
+|column|String|no|Name of the assigned column||
+
+##### PivotConstant
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|Name of the Attribute||
+|value|String|value or macro in single quots||
+
+##### PivotDerivedAttribute
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Name of the Attribute||
+|pivotName|String|no|Pivot name of the attribute||
+|value|String|no|formula in sql language||
+
+### Entities
+Entities contains a list of Entities (1..N) of the Datasource. The <Entities> node does not have any attributes itself, but it has a list of <Entity> SubNodes. The Entities specify the Database Table where the Data is collected from. Only one of the Entities can be stored (R10 restriction). Each entity except the Start Entity has a JOIN Condition
+
+### Example
+```
+  <Entities>
+    <Entity name="Order__c" alias="" idAttribute="Id" />
+    <Entity name="Order_Template__c" alias="">
+      <Join Type="inner">
+        <SimpleJoin>
+          <Condition leftSideValue="Order_Template__c.Id" comparator="eq" rightSideType="Attribute" rightSideValue="Order__c.Order_Template__c" />
+        </SimpleJoin>
+      </Join>
+    </Entity>
+  </Entities>
+```
+
+#### Entity
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Name of the Entity||	 
+|alias|String|yes|Alias name of the entity||
+|idAttribute|String|yes|Literal	unique key row of entity||
+
+##### Join
+Join describes the join type between two entities (inner, left ,left outer)
+##### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|type|String|no|Could have the values inner, left, left outer||
+
+###### SimpleJoin condition
+one ore more  modeled  relations between entities
+
+###### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|leftSideValue|String|no|||	 
+|comparator|String|no|||	 
+|rightSideType|String|no|Attribute, Parameter or Literal||
+|rightSideValue|String|no|||	 
+
+###### ComplexJoin condition
+describes a relation between entities with a SQL code snippet. Complex Join nodes contain only a CDATA section with the SQL code.
+
+###### Example 
+```
+<Join Type="inner">
+  <ComplexJoin><![CDATA[
+      PrdSales.#criterionAttribute# = PrdGroup.Id #addCond_criterionFilterValue#
+      ]]></ComplexJoin>
+</Join>
+```
+
+###### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|<![CDATA[Your join condition to be enter here]]>|String|no|||
+
+### QueryCondition
+Each Data Source has one Query Condition. The Query Condition is a SQL Snippet which is pasted by the Generator into the WHERE Part of the Select Statement. A Query Condition can contain Parameters which are defined for the Data Source
+
+### Example
+```
+<QueryCondition><![CDATA[
+      PrdSales.SalesSegmentState = '4'
+          AND PrdProduct.State='4'
+          AND CndMain.ValidFrom <= '#commitDate#'
+          AND CndMain.ValidThru >= '#commitDate#'      
+      AND CndMain.PriceType = CndMain.DefaultPriceType
+      AND CndMain.PriceListType = CndMain.DefaultPriceListType
+      AND CndMain.MetaId = 'ProductPrice'       
+          #addCond_FieldState#
+          #addCond_NewState#
+          #addCond_ForeignProduct#
+  ]]></QueryCondition>
+  ```
+
+### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|<![CDATA[Your where condition to be enter here]]>|String|no|||
+
+
+### OrderCiteria
+describes the sort order of the query result set
+
+### Example
+```
+  <OrderCriteria>
+    <OrderCriterion entity="Order__c" attribute="Order_Id__c" direction="ASC" />
+  </OrderCriteria>
+```
+
+### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|entity|String|no|||	 
+|attribute|String|no|||	 
+|direction|String|no|||	
+
+### GroupBy
+The GroupBy element defines the Attributes and their order which are used to create the Group By Clause of the Select Statement. Each GroupByCriterion must define the following attribues.
+
+### Example
+```
+  <GroupBy>
+    <GroupByCriterion entity="Visit_Job__c" attribute="Product__c" />
+  </GroupBy>
+```
+
+### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|entity|String|no|Name of the Entity for the Group By Criterion||	 
+|attribute|String|no|Name of the Attribute for the Group By Criterion||
+
+### Parameters
+Parameters are modeled and can be used in the JOIN and the QUERY Conditions to filter the Result Set
+
+### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|||	 
+|baseType|String|yes|Date, Time or DateTime||
+|type|String|yes|SQLite type (NULL, INTEGER, REAL, TEXT, LIST)||
+|treatAs|String|no|can be set to "sqlSnippet" to include the parameter directly into the statement (not as parameter)||
+
+Type "LIST" is used for parameters used in "IN" conditions. All items of the list (Array or comma separated list in a string) must be the same type (string or numeric).
+
+### Macros
+Macros are shortcuts used in the SQL-Statements that are replaced at runtime. There are framework macros that represent frequently used parameters and default parameters and parameter macros that are customizable at design time.
+
+#### Framework macros
+The framework knows the following macros and replacements
+
+| Macro          | Replacement  | Annotation  |
+|:---------------|:-------------|:------------|
+|#Language#|The user's spoken language as configured in the user object|Defaults to "en"|
+|#SalesOrg#|The sales organisation code assigned to the user|Defaults to "0001"|
+|#Client#|The client set for the user|Defaults to "010"|
+|#UserPKey#|The PKey value of the current user|No default, since a valid user is required to use the app|
+|#Today#|The current date in short ANSI format|"YYYY-MM-DD"|
+|#MaxDate#|System wide maximum date value in short ANSI format|Fixed at "9999-12-31"|
+|#MinDate#|System wide minimum date value in short ANSI format|Fixed at "1800-01-01"|
+|#BusinessModified#|Used in tables that have a businessModified column to mark the latest change in short ANSI date/time format|"YYYY-MM-DD HH:MM:SS"|
+
+#### Parameter macros
+All parameter macros use the format #<ParameterName>#. Only parameters listed in the contract (see 2.5. Parameters) can be used here. If at runtime a parameter is not provided, the macro will be replaced by the empty string otherwise it will be replaced by the value provided for that parameter. The datasource designer is responsible for the correct parameter format, e.g. if a parameter is a string value, the macro must be surrounded by quotation marks. ( ' ).
+
+### Quick Search Parameters
+The Generator creates code to add Quick Search Parameter to the Select Statement if at least one Quick Search Parameter is available
+
+### Example
+```
+<QuickSearchParameters>
+  <QuickSearchParameter name="customer.name"/>
+  <QuickSearchParameter name="customer.id"/>
+  <QuickSearchParameter name="address.fullAddress"/>
+</QuickSearchParameters>
+```
+Each Quick Search must define the following properties.
+
+### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|Name of the Attribute to search (if ambiguous "table.column" notation can be used)|Attribute must be available and not ambiguous|
+
+The generator creates the following source code:
+```
+if (Utils.isDefined(jsonQuery) && Utils.isDefined(jsonQuery.__quickSearchTermArray)) {
+   sqlStmt += "AND ( 1 = 0 ";
+   for (var idx = 0; idx < jsonQuery.__quickSearchTermArray.length; idx++) {
+      var qsSearchTerm = jsonQuery.__quickSearchTermArray[idx];
+      sqlStmt += " OR field1 LIKE " + qsSearchTerm;
+      ...
+      sqlStmt += " OR fieldN LIKE " + qsSearchTerm;
+   }
+   sqlStmt += ")";
+}
+```
+
+### Conditional Parameters
+Conditional Parameters create conditions if the Parameter is passed into the DataSource.
+
+#### Conditional Parameter
+Conditional Parameters are modeled and define additional Conditions if the parameter is passed into the datasource
+
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|name|String|no|||
+
+#### SimpleConditions
+one ore more  modeled  Conditions if a Parameter is set
+
+#### Properties
+| name           | Type  | optional | Annotation                              | Validations/Checks|
+|:---------------|:------|:---------|:----------------------------------------|:------------------|
+|leftSideValue|String|no|||	 
+|comparator|String|no|||	 
+|rightSideType|String|no|literal	Attribute, Parameter or Literal||	 
+|rightSideValue|String|no|||
+
+#### Example
+```
+<ConditionalParameters>
+    <ConditionalParameter name="customerPKey">
+      <SimpleConditions>
+        <Condition leftSideValue="BpaOrderRole.CustomerPKey" comparator="EQ" rightSideType="Attribute" rightSideValue="'#customerPKey#'" />
+      </SimpleConditions>
+    </ConditionalParameter>
+  </ConditionalParameters>
+```
+
+## Comparison operators
+The following comparison operators could be used within join or where clause.
+
+|Operator| Equivalent SQL Operator| Description|
+|:-------|:-----------------------|:-----------|
+|EQ|=|Equals|
+|NE|<>|Not Equals|
+|LT|<|Less Than|
+|LE|<=|Less or Equals Than|
+|GT|>|Greather Than|
+|GE|>=|Greather or Equals Than|

package/templates/contractTemplates/DS_DataSource/Ds${NAME}_sf.datasource.xml

@@ -0,0 +1,11 @@
+<DataSource name="Ds${NAME}" backendSystem="sf" businessObjectClass="${REFERENCE_OBJECT}" external="false" editableEntity="" schemaVersion="2.0">
+  <Attributes>
+    <Attribute name="" table="" column="" />
+  </Attributes>
+  <Entities>
+    <Entity name="" alias="" idAttribute="" />
+  </Entities>
+  <QueryCondition />
+  <OrderCriteria />
+  <Parameters />
+</DataSource>