### Complete Homepage Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepage A comprehensive example demonstrating the full structure of a homepage configuration. This includes definition, reference, profiles, version, welcome message, actions, widgets, and detailed page layouts with filters and item arrangements. ```YAML data: definition: iwe-HomePage ref: home-client profile: - client homeVersion: 2 config: welcomeMessage: fr: Bienvenue dans votre espace de gestion des demandes fabActions: - action: createCase case: Issue icon: campaign label: Une demande creationWizard: name: Déclaration anomalie activityName: Ouverture anomalie label: fr: Déclaration d'anomalie widgetsFrom: - 'widgets/@widgets-issues.yml' - 'widgets/@widgets-issues-client.yml' - 'widgets/@widgets-communications.yml' - 'widgets/@widgets-release.yml' pages: - # Page: Demandes ref: demandes-tab title: Demandes filters: - def: Application field: _id ref: app-filter overrideLabel: Application options: select: true - label: fr: Priorité ref: priorite-filter type: name: Enum params: values: P1: P1 P2: P2 P3: P3 layout: - items: - issues-being-declared-counter-widget - issues-infos-counter-widget - anomalie-list-client-widget - evolution-list-client-widget width: xs: 12 sm: 6 md: 3 - items: - issues-planified-counter-client-widget - planified-anomalie-list-client-widget - planified-evolution-list-client-widget width: xs: 12 sm: 6 md: 3 ``` -------------------------------- ### Assign Me Button YAML Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/assignmeactionbutton A YAML configuration example demonstrating how to set up an 'assignMe' button to assign a user to a case, specifying the source object, party, and participant role type. ```YAML - type: assignMe config: action: from: claimObject party: insured fill: roletype: accueilExpertise ``` -------------------------------- ### YAML Configuration Example for EntityList Component Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/addaction Provides a YAML configuration example for an 'entityList' component. It demonstrates setting multilingual titles, defining the component type, specifying a data relation, and configuring an 'addAction' of type 'link' to a specific page and section. The example also shows a placeholder for table component fields. ```yaml - title: en: Coverages fr: 'Garanties du contrat' type: entityList relation: $root.contract.coverages addAction: type: link relation: $root page: Analyse section: CONTRACT_COVERAGES_SECTION components: table: fields: ... ``` -------------------------------- ### Example YAML Configuration for ActionsReportList Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/actionsreportlist This YAML-like configuration snippet demonstrates how to define creation actions and specify entities for which the global trash can be displayed within the 'More menu' of an application. It lists 'Contact' and 'Organization' as examples for both creation and trash access. ```YAML actions: creation: - Contact - Organization displayTrashFor: - Contact - Organization ``` -------------------------------- ### Example Wizard Configuration YAML Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-wizards/wizardform Provides a practical YAML example demonstrating how to configure a wizard. It showcases the 'show' property for task visibility, and the 'finish' and 'cancel' actions, including nested action types like 'customAction', 'generateDocument', and 'navigate', along with internationalized labels. ```YAML how: - 'Déclaration du sinistre' finish: label: en: Declare contract fr: Déclarer contrat {{LABEL(:context.top.contract.contractType, 'Contract.contractType')}} actions: - type: customAction actionRef: claim-declaration expression: '{claimUrl: $root.$self.href}' - type: generateDocument cond: ':context.top.contract.contractType == "activity"' template: Declaration_sinistre_activite - type: generateDocument cond: ':context.top.contract.contractType == "construction"' template: Declaration_sinistre_chantier - type: navigate relation: $root cancel: tooltip: fr: Annuler la déclaration en cours en: Cancel declaration actions: - type: customAction actionRef: claim-cancel-declaration - type: navigate home: true ``` -------------------------------- ### Example Entity Forms Configuration File Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms This YAML example demonstrates the mapping of entity definition names to their respective form file names. It also shows the inclusion of special configuration files for helper texts, documents, and switches. ```YAML version: 1.1 Contact: form_Contact Contact.create: form_Contact.create Organization: form_Organization Organization.create: form_Organization.create @helper-txt: @helper-txt @documents: @documents @switches: @switches ``` -------------------------------- ### YAML Example: Configuring Welcome Message Display Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepageconfig Demonstrates how to enable the welcome message and provide multi-language content using YAML configuration for the homepage. ```YAML showWelcomeMessage: true welcomeMessage: fr: Bienvenue dans votre application de déclaration de sinistres construction en: Welcome to your claim submission application ``` -------------------------------- ### Example Section Configuration for Wizard Action Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-sections/wizardactionsection A YAML configuration example demonstrating how to define a section of type 'wizardAction'. It includes localized titles, the associated task name, and a conditional 'show' expression based on management declaration date and status. ```yaml - title: en: Continue declaration fr: 'Reprendre la déclaration' type: wizardAction taskName: 'Déclaration du sinistre' show: "!management.declarationDate && status != 'cancelled'" ``` -------------------------------- ### Example YAML for HomePageWithData Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepagewithdata Illustrates the basic structure of a YAML file used to define a home page with `iwe-app-tools`, showing the `data` and `config` sections. ```YAML data: definition: iwe-HomePage ref: home-admin config: ... ``` -------------------------------- ### UnitsFormat Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/unitsformat An example demonstrating how to configure the UnitsFormat to specify 'years' and 'months' as the desired units within a 'format' block. ```YAML format: units: ['years', 'months'] ``` -------------------------------- ### YAML Configuration Example for Action Section Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-sections/actionsection This YAML example demonstrates how to configure an action section. It specifies the section's type, display text, tooltip, action type (link/linkEdit), relation, and conditional display logic using `show` and `section` properties for navigation. ```YAML - type: action actionText: en: View fr: Consulter tooltipText: en: Please navigate to the contract in order to edit it fr: "Consultez le contrat afin de l'éditer" action: link # "link" to only navigate to page/section, "linkEdit" to open section in edition mode relation: $root show: relatedTo # angular expression to display section. Displayed if none section: CONTRACT_EDIT # Note — the page will be deducted from the section ``` -------------------------------- ### YAML Example: Importing Widgets from External Files Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepageconfig Illustrates how to import widget definitions from multiple external YAML files into the homepage configuration for modularity and reuse. ```YAML widgetsFrom: - 'widgets/@widgets-apartment-block.yml' - 'widgets/@widgets-communication.yml' - 'widgets/@widgets-contacts.yml' ``` -------------------------------- ### Example: Define Homepage Access Profiles Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepage This snippet shows how to assign a list of user profiles that have access to this specific homepage configuration. Profiles are listed as an array of strings. ```YAML profile: - admin-appli-production - broker-production ``` -------------------------------- ### Example YAML Configuration for Reports Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/reportsitem Illustrates how to configure reports in YAML, showing how to reference existing reports and override aggregation settings like format and name. ```YAML reports: - "@ref": <<: *REPORT ref: recognitions-without-quote-report - id: "@ref": # replaced by tooling <<: *REPORT ref: my-new-quotes-report aggregations: - name: totalTaxInclusive format: number: notation: compact - name: count ``` -------------------------------- ### Example: Configure Homepage Welcome Message Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepage This snippet demonstrates how to configure the welcome message in multiple languages and control its visibility on the homepage. The message is displayed only if a company logo is present and `showWelcomeMessage` is active. ```YAML showWelcomeMessage: true welcomeMessage: fr: Bienvenue dans votre application de déclaration de sinistres construction en: Welcome to your claim submission application ``` -------------------------------- ### Example: Configuring Report Thresholds in YAML Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/reportsettings Demonstrates how to configure 'thresholds' and 'defaultThresholdLevel' within report settings using YAML. This example sets a default threshold level to 'OK' and defines two specific thresholds for 'WARN' and 'KO' levels with 'UP' direction. ```YAML settings: <<: *SETTINGS defaultThresholdLevel: OK thresholds: - level: WARN value: 1 direction: UP - level: KO value: 2 direction: UP ``` -------------------------------- ### Example YAML for Section Type Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-sections/commentssection A simple YAML example demonstrating how to define a section with the type 'comments'. This snippet shows the basic structure for specifying a section type. ```YAML - type: comments ``` -------------------------------- ### Example Configuration for UnionAllTypeStep Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/query/unionalltypestep Illustrates how to configure a `unionAll` type step, named `unionClientsStep`, to concatenate results from `queryOrganizationsStep` and `queryContactsStep` using the `collections` property. ```YAML unionClientsStep: type: unionAll rs: true dependsOn: [queryOrganizationsStep, queryContactsStep] config: collections: [queryOrganizationsStep, queryContactsStep] ``` -------------------------------- ### openWizard Action Properties Reference Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/actions/actions/openwizardaction Detailed reference for each property available in the 'openWizard' action, including their purpose, data types, and usage examples for iWE expressions. ```APIDOC openWizard Action Properties: assignRelatedEntity: Description: Specification of how _relatedTo is set for the created task. By default, _relatedTo is not set. To assign the selected line, you have to set assignRelatedEntity to true. For more specific use cases, you can set assignRelatedEntity to expr: iweExpression. In this case the provided iweExpression shall return a single entity that will be linked to the created task. Datatype: Boolean | {expr: String} Examples: - Code: expr: IF(:context.selectedLines.length == 1, :context.selectedLines[0].contact) - Code: IF(:context.selectedLines.length == 1 && :context.selectedLines[0].status == 'valid'), :context.selectedLines[0]) Tips: selectectLine: true and expr: IF(:context.selectedLines.length == 1, :context.selectedLines[0]) are equivalent. For fieldGroup like sections, setting assignRelatedEntity: true will assign _relatedTo with fieldGroup data (it is equivalent to the following formula expr :data). cond: Description: An iWE Expression that allows you to perform an action depending on a given condition Datatype: String input: Description: When chaining actions in a combined actions it's a variable that allows to use the output of the previous action as the input of the current action Datatype: String message: Description: Snackbar displayed Datatype: I18nString openSideBar: Description: If openSideBar true, open the wizard and its task sidebar. Datatype: Boolean output: Description: When chaining actions in a combined actions it's a variable that allows to use the output of an action as the input of the following action Datatype: String taskRef: Description: The reference of the task linked to the wizard. Datatype: String, required=true type: Description: The action type. Datatype: "openWizard", required=true wizardRef: Description: The reference of the wizard to open. Datatype: String, required=true ``` -------------------------------- ### Example NumberFormat Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/numberformat Illustrates how to configure the NumberFormat with specific fraction size, decimal, and group separators in a YAML format. This example sets two decimal places, a dot as the decimal separator, and a space as the group separator. ```YAML format: number: fractionSize: 2 decimalSeparator: '.' groupSeparator: ' ' ``` -------------------------------- ### ExtraLight Aspect Configuration and Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspects Explains the 'extraLight' aspect, which defines a minimal set of fields for entity representation. Includes its configuration parameters and a JSON example. ```APIDOC extraLight: fields: type: List of String description: fields is a list of field name. ``` ```JSON { "aspects": { "extraLight": [ "ref", "status", "label" ] } } ``` -------------------------------- ### Responsive Layout Width Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/layout Demonstrates how to define responsive widths for layout items within a `layout` structure. It shows using an object for `xs` and `sm` breakpoints, and also a single number which defaults to `xs`. ```YAML/Configuration layout: - items: - en-cours width: xs: 12, sm: 4 # for sizes small and above - items: - clos width: 4 # equivalent to width: {xs: 4} - items: - declarer width: 4 ``` -------------------------------- ### Basic CaseTableField Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/casetablefield Demonstrates a basic YAML configuration for `CaseTableField` within a table component, specifying field names and properties like `url`. ```yaml components: table: fields: - name: ref url: true - name: name - name: versionRelease - ``` -------------------------------- ### iWE Query Parameter YAML Declaration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/query/parametersquery Illustrates the YAML syntax for declaring a query parameter in an iWE configuration. This example defines a `lastModificationDateParam` of type `date` with an internationalized label, demonstrating how parameters are structured within the `parameters` section. ```YAML iwe: ... parameters: # Parameters declaration - name: lastModificationDateParam type: date label: en: Modified after ``` -------------------------------- ### ObjectStock YAML Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/objectstock Illustrates a basic YAML configuration for the `stock` property, setting the `acknowledged` field to `false` within an `ObjectStock` context. ```YAML stock: acknowledged: false ``` -------------------------------- ### Example ResultObjects Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/query/resultobject Illustrates the structure for defining a `resultObject` within a `resultObjects` block, including its definition, data path, list of fields to extract, and associated query steps. This configuration is essential for specifying how data is extracted and structured. ```YAML resultObjects: annonceObject: def: Annonce path: Annonce/{annonceObject._id} fields: - _id - reference - status - synchroStatus - broadcastCriterion - broadcastBeginDate - broadcastEndDate - broadcastExpired querySteps: - queryAnnoncesStep ``` -------------------------------- ### YAML Example for Aggregation Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/aggregation Illustrates how to configure an aggregation block using `name`, `type`, `field`, `valueType`, `format` with `notation` and `fractionSize`, and `thresholds` with `level`, `direction`, and `value`. ```yaml aggregations: - name: totalTTC type: sum field: quoteObject.globalAmount valueType: Money format: number: notation: 'compact' fractionSize: 0 thresholds: - level: 'OK' direction: 'UP' value: 8000 ``` -------------------------------- ### RangeFormat Example Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/rangeformat Demonstrates how to define a range using `from` and `to` properties within the `format` configuration for a Year type field. ```YAML format: range: from: "2000" to: "CURRENT_YEAR + 1" ``` -------------------------------- ### Example JSON for SpecializationWith Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/definition/specializationwith Illustrates how to use the 'with' property to map abstract definitions to concrete implementations within a template configuration, specifically for 'iwe-Task' with 'iwe-Document' to 'grl-Document' and 'iwe-Participant' to 'grl-Participant'. ```JSON { "template": "iwe-Task", "with": [ { "abstract": "iwe-Document", "impl": "grl-Document" }, { "abstract": "iwe-Participant", "impl": "grl-Participant" } ] } ``` -------------------------------- ### JSON Configuration Example for Initial Sharing Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspectinitialsharingparams This JSON snippet demonstrates how to set up initial sharing for an entity, specifying a restricted level, excluding all roles by default, including specific manager and member roles, and sharing with 'admin' and 'manager' groups. ```json { "initialSharing": { "level": "restricted", "allRoles": false, "roles": ["manager", "member"], "groups": [ "admin", "manager" ] } } ``` -------------------------------- ### YAML Example for Search Bar Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/searchbar Illustrates how to configure a search bar in a YAML file, enabling its display and specifying 'name' as the field for searching within a 'documents' section. ```YAML - title: Documents type: documents relation: documents searchBar: display: true searchOn: - name ``` -------------------------------- ### Example: Defining Access Profiles for IWe Query Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/query/query Illustrates how to define access profiles for an IWe Query using a YAML-like syntax. This example shows how to specify a 'manager' profile and how ABAC rules can use this profile to control access to the query, limiting access based on user profiles. ```YAML -- Query: profiles: ['manager'] -- ABAC allowIf: - "IN(object.profiles, user.profile)" ``` -------------------------------- ### Example JSON for AspectExtraLightParams Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspectextralightparams This JSON snippet demonstrates how to configure the 'extraLight' aspect with a list of field names such as 'ref', 'status', and 'label'. ```JSON { "aspects": { "extraLight": [ "ref", "status", "label" ] } } ``` -------------------------------- ### Example Configuration for Thresholds Property Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/threshold This YAML snippet demonstrates how to configure the `thresholds` property within `settings`, including a `defaultThresholdLevel` and multiple threshold objects with `level`, `value`, and `direction`. ```YAML settings: <<: *SETTINGS defaultThresholdLevel: OK thresholds: - level: WARN value: 1 direction: UP - level: KO value: 2 direction: UP ``` -------------------------------- ### CurrencyFormat Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/currencyformat Illustrates how to configure the `CurrencyFormat` with the `displaySymbol` property set to true within a `format` block. This snippet shows a basic YAML structure for applying currency formatting. ```yaml format: displaySymbol: true ``` -------------------------------- ### Example JSON for System Aspect Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspectsystemparams This JSON snippet demonstrates the structure for configuring system aspect parameters, specifically listing the system fields that are typically managed by the system and cannot be directly modified by end-users. ```JSON "system": { "fields": ["createdBy", "modifiedBy", "deletedBy", "dateCreated", "dateModified", "dateDeleted", "instanceDefVersion", "instanceTemplate", "counters", "frozen"] } ``` -------------------------------- ### Example YAML for ExtractFieldTypeStep Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/query/extractfieldtypestep Demonstrates how to configure the `extractField` type to extract a specific field from a step's result, such as `company._id` from `queryMyOfficeStep`. ```yaml # return an array of company._id of queryMyOfficeStep step extractMyOfficeIdStep: type: extractField dependsOn: [queryMyOfficeStep] config: path: .queryMyOfficeStep.company._id ``` -------------------------------- ### YAML Configuration Example for Proposal Type Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/proposalfield Illustrates a YAML configuration block for a 'Proposal' type, demonstrating `copyFields` for data transformation and `searchOn` with complex nested filters using logical operators (`and`, `or`) and context-dependent expressions (`$expr`). ```YAML - name: label type: Proposal params: copyFields: - from: amount to: unitPrice - from: unit to: unit searchOn: definition: LigneBpu fields: - libelle - genre filters: and: - or: - bpu._id: $expr: ":context.top.bpuMandant._id || 'pas'" - bpu._id: $expr: ":context.top.bpuUp._id || 'pas'" - or: - nature: MES - nature: '*' ``` -------------------------------- ### Examples of iWE Unary NOT Operator (!) Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/expression/expressions Provides examples demonstrating the usage of the `!` (NOT) unary operator in iWE expressions for logical negation of boolean and comparison results. ```Javascript // data: // { // "a": 1, // "b": 2 // } !(a > b) // ==> true // data: // { // "a": true // } !a // ==> false ``` -------------------------------- ### Cartridge Aspect Configuration and Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspects Details the 'cartridge' aspect, which designates fields for email notifications. Includes its configuration parameters and a JSON example of its usage. ```APIDOC cartridge: fields: type: List of String required: true description: Designation of the cartridge fields for an mail notification. ``` ```JSON { "cartridge": { "fields": [ "_ref", "title", "type" ] } } ``` -------------------------------- ### CreateOnly Aspect Configuration and Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspects Explains the 'createOnly' aspect, which prevents updates to specified fields after entity creation. Includes its configuration parameters and a JSON example. ```APIDOC createOnly: fields: type: List of String required: true description: fields to deny updates after entity creation ``` ```JSON { "createOnly": { "fields": [<>, <> ...] } } ``` -------------------------------- ### Example: Participant Assignment on Claims Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/assignmentactionbutton This YAML configuration demonstrates how to set up an assignment button for claims. It specifies the report to use for searching entities, multi-language labels for the popup and buttons, and an action configuration including the assignment mode and fields to fill. ```YAML buttons: - type: assignment config: report: all-cabinets-orgs-report label: fr: Sélectionner un cabinet d'expertise en: Select a loss assessment firm selectLabel: fr: Assigner au cabinet en: Assign to firm buttonLabel: fr: Assigner un cabinet en: Assign a firm action: mode: replace fill: roletype: telechiffreur ``` -------------------------------- ### AspectLabelledParams Configuration Example for Label Expression Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspectlabelledparams This example demonstrates how to configure the `_label` attribute for an object, such as a contact, using a Handlebars-like expression within a JSON structure. The `expression` field defines how the label is generated from object properties. ```JSON "labelled": { "expression": "{{firstName}} {{lastName}}" } ``` -------------------------------- ### YAML Example for infoMessage Section Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-sections/infomessage This YAML snippet illustrates how to configure an 'infoMessage' section. It demonstrates the use of conditional display logic ('show' expression) and a multi-line message body that incorporates dynamic data formatting and bold text, showcasing a practical application of the section properties. ```YAML - type: infoMessage components: messages: list: - level: WARN show: "IN(['aAnalyser', 'acceptee', 'nouvelle'], statut)" body: | Votre demande du {{FORMAT_DATE(dateDemande, "Do MMMM YYYY")}} est bien prise en compte, elle est en cours d'étude par nos services. Statut de votre demande en gras : **{{statut}}** Une liste avec des boulettes : - boulette 1 - boulette 2 - boulette 3 ``` -------------------------------- ### Example YAML Configuration for Table Footer Fields Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/footerfield Illustrative YAML configuration demonstrating various table footer field properties such as sum calculation, expressions, and internationalized titles within a table structure. ```YAML table: footer: - hide: "" fields: - key: field001 title: fr: Total en: Total - key: field002 displaySum: true currency: EUR - key: field004 name: globalAmount - key: field003 type: Expression expr: "{{(damages | iweSum:'valueBeforeDilapidationWoVAT' | iweCurrency:'EUR') || '-'}}" - key: field005 type: Expression iweExpression: true expr: "SUM(MAP(damages, valueBeforeDilapidationWoVAT)) €" fields: - name: label - name: unit key: field001 - name: unitPrice key: field002 - name: discount - name: unitPriceDiscounted key: field003 ``` -------------------------------- ### Example JSON Configuration for createOnly Fields Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspectcreateonlyparams Provides a practical JSON example demonstrating how to configure the `createOnly` constraint. It shows the structure for specifying a list of fields (represented by placeholders `<>`, `<>`, etc.) that will be restricted from updates after an entity is created. ```JSON "createOnly": { "fields": [<>, <> ...] } ``` -------------------------------- ### Example Filter Configuration with Strict Mode Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/filter Demonstrates how to configure a filter with strict matching enabled and specific field values for beneficiaryRoletype and isCompany. This configuration applies a precise filter to a list of items. ```YAML filter: strict: true beneficiaryRoletype: insured isCompany: false ``` -------------------------------- ### API Reference: Homepage Configuration (`config`) Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepage Defines the configuration options for the homepage. This property is required and points to a `HomePageConfig` object, which includes settings for welcome messages and their display. ```APIDOC config: HomePageConfig (Required) welcomeMessage: Object fr: String (French welcome message) en: String (English welcome message) showWelcomeMessage: Boolean Description: Controls the visibility of the welcome message. Message is displayed only if user has a company logo and this option is active. ``` -------------------------------- ### JSON Configuration Example for 'PhoneNumber' Field Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/field-data-type/phonenumber This JSON snippet demonstrates how to configure a field, named 'fieldName' in this example, to utilize the 'PhoneNumber' type. This type provides international phone validation and the ability to link to place a call. ```JSON "fieldName": { "type": { "name": "PhoneNumber" } } ``` -------------------------------- ### Currency Aspect Configuration and Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspects Documents the 'currency' aspect, used to define the currency field for 'Money' type fields within an object. Includes its configuration and a comprehensive JSON example showing its integration with field definitions. ```APIDOC currency: field: type: String required: true description: The currency used (Euro, Dollar...) on a case for all Money fields is defined and stored at the object level using the "currency" Aspect: ``` ```JSON { "aspects": { ... "currency": { "field": "currency" } ... }, "fields": { ... "currency": { "labelen": "My currency on this case", "labelfr": "Ma devise sur ce dossier", "type": { "name": "CurrencySelector" } }, "montantTotal": { "labelen": "...", "labelfr": "...", "type": { "name": "Money" } } ... } } ``` -------------------------------- ### Dynamic Filter Links YAML Configuration Example Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/dynamicfilterlink Example YAML configuration demonstrating the use of the 'links' array within dynamic filter definitions. It shows how filters like 'assignedToObject' and 'assignedToExpert' can be linked to 'linkedOrganizationObject' or 'organizationObject' to create dependencies. ```YAML - object: linkedOrganizationObject field: _id query: ref: linked-organization-filter-query resultObject: linkedOrganizationObject fields: - linkedOrganizationObject.name - object: assignedToObject field: _id query: ref: organization-filter-query resultObject: organizationObject fields: - organizationObject.name links: - filter: linkedOrganizationObject._id resultObject: linkedOrganizationObject - object: assignedToExpert field: _id query: ref: contact-filter-query resultObject: contactObject fields: - contactObject.fullName links: - filter: assignedToObject._id resultObject: organizationObject - filter: linkedOrganizationObject._id resultObject: linkedOrganizationObject ``` -------------------------------- ### API Reference: Common Configuration and Process Components Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-wizards/wizardpageactions Detailed listing of API entities, configuration options, and process-related components available in the application, including their purpose and relationships. ```APIDOC Common Field Formats: - DateFieldFormat: Defines format for date fields. - DocListFieldFormat: Defines format for document list fields. - DurationFieldFormat: Defines format for duration fields. - EnumFieldFormat: Defines format for enumeration fields. - FieldFormat: Base format for fields. - FieldOptions: Options for fields. - FieldOptionsStyle: Styling options for fields. - FieldShowConfig: Configuration for field visibility. - Helper: Utility helper. - LongTextFieldFormat: Defines format for long text fields. - NumberFieldFormat: Defines format for number fields. - NumberFormat: Defines number formatting. - PhoneFieldFormat: Defines format for phone number fields. - RangeFormat: Defines format for ranges. - UnitsFormat: Defines format for units. - YearFieldFormat: Defines format for year fields. Common UI/Data Components: - Filter: Configuration for data filtering. - FooterField: Defines fields in a footer. - ListFooter: Configuration for list footers. - Column: Defines table columns. - SliceSelector: Selector for data slices. - LevelStock: Configuration for level stock. - ObjectStock: Configuration for object stock. - searchOn (SearchBar): Configuration for search bar functionality. Common Action/Message/Report Components: - AddAction: Defines an add action. - MessageInfo: Configuration for message information. - ParticipantConfig: Configuration for participants. - PlaceholderConfig: Configuration for placeholders. - ReportConfig: Configuration for reports. - ReportParams: Parameters for reports. - TaskActions: Actions related to tasks. Process Definitions: - Process: General process definition. Wizard Components: - WizardPageActions: Actions related to a wizard page. ``` -------------------------------- ### Example YAML Configuration for Table Fields Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/tablefield This YAML snippet demonstrates how to define a list of table fields within a `components.table.fields` structure. It shows how to specify a field's `name` and additional properties like `url` for specific fields. ```YAML components: table: fields: - name: ref url: true - name: name - name: versionRelease ``` -------------------------------- ### API Reference: `welcomeLogo` Property Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepageconfig Specifies the welcome logo to be displayed on the homepage, typically a String path or identifier. ```APIDOC welcomeLogo?: String ``` -------------------------------- ### Example: Customizing Report Column Groups (YAML) Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/reportsettings This YAML example demonstrates how to define custom column groups for a report, allowing fields from different objects (e.g., expertiseObject.status in claimObject group) to be displayed together. If columnGroups is present, it exhaustively defines the displayed columns. ```YAML columnGroups: - name: claimObject columns: - claimObject.refInsurer - expertiseObject.status # <-- NEW - claimObject.typeCoverage - name: expertiseObject columns: - expertiseObject.lossAdjusterMissionType - expertiseObject.openingDate ``` -------------------------------- ### voidEnvelope Action API Documentation Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/actions/actions/voidenvelopeaction API documentation for the 'voidEnvelope' action, detailing its purpose and inheritance. ```APIDOC Action: voidEnvelope Description: Cancel a docusign envelope Extends: Action ``` -------------------------------- ### Example LevelStock Configuration for Enum Field Filtering Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/configuration-options/common/levelstock This YAML snippet demonstrates how to configure the 'stock' property using 'field' and 'level' to filter on Enum fields. It shows two examples: one with 'status' and 'WARN' level, and another with 'signaturesStatus', 'WARN' level, and 'strict' set to true. ```YAML stock: - field: status level: WARN - field: signaturesStatus level: WARN strict: true ``` -------------------------------- ### YAML Configuration for Assignment Button Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/assignmentconfig Example YAML configuration for a mass assignment button, demonstrating how to set up labels, actions, and report references for participant assignment on Claims. This configuration defines the button's type, associated report, multi-language labels for the popup and button, and the specific action to perform upon assignment. ```yaml buttons: - type: assignment config: report: all-cabinets-orgs-report label: fr: Sélectionner un cabinet d'expertise en: Select a loss assessment firm selectLabel: fr: Assigner au cabinet en: Assign to firm buttonLabel: fr: Assigner un cabinet en: Assign a firm action: mode: replace fill: roletype: telechiffreur ``` -------------------------------- ### Homepage Properties Applicability Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepagepage These configuration options are applicable to the HomePageConfig. ```APIDOC Applicable to: - HomePageConfig ``` -------------------------------- ### YAML Configuration for Report List Widgets Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/widgets This YAML configuration defines two distinct report list widgets. Each widget specifies a unique reference, type, title, icon, and a list of reports it displays. The first widget, 'report-widget', is titled 'Mes actions MAGI sur durée de promotion sur le loyer' and links to 'my-rent-promotion-duration-actions-magi-report'. The second widget, 'all-rent-promotion-duration-actions-magi-report-widget', is titled 'Les actions MAGI sur durée de promotion sur le loyer' and links to 'all-rent-promotion-duration-actions-magi-report'. ```YAML - ref: report-widget type: report-list config: title: Mes actions MAGI sur durée de promotion sur le loyer icon: description reports: - ref: my-rent-promotion-duration-actions-magi-report - ref: all-rent-promotion-duration-actions-magi-report-widget type: report-list config: title: Les actions MAGI sur durée de promotion sur le loyer icon: description reports: - ref: all-rent-promotion-duration-actions-magi-report ``` -------------------------------- ### JSON Example: Money Field Type and Currency Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/field-data-type/money Provides a JSON example demonstrating the structure of currency configuration retrieved from the MyConfig API, including `defaultCurrency` and `availableCurrencies`. It also shows how to define a 'Money' field type with `min` and `max` parameters within a field definition. ```json { "_links":{}, "envId":{"$id":"..."}, "defaultCurrency":"USD", "availableCurrencies":["EUR","USD"] } "fieldName": { "type": { "name": "Money", "params":{ "min": 0, "max": 15000 } } } ``` -------------------------------- ### JSON Configuration for Currency and Money Fields Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspectcurrencyparams This JSON example demonstrates the configuration of 'currency' and 'money' field types within an application's aspects and fields definitions. It shows how to define a 'CurrencySelector' for a currency field and a 'Money' type for a monetary amount, along with their respective labels. The example highlights the structure for defining custom field behaviors and how currency is determined for sub-entities. ```JSON { "aspects": { ... "currency": { "field": "currency" } ... }, "fields": { ... "currency": { "labelen": "My currency on this case", "labelfr": "Ma devise sur ce dossier", "type": { "name": "CurrencySelector" } }, "montantTotal": { "labelen": "...", "labelfr": "...", "type": { "name": "Money" } } ... } } ``` -------------------------------- ### Navigate Action API Reference Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/actions/actions/navigateaction Provides API documentation for the 'navigate' action, detailing its purpose, behavior under different contexts (sidebar, integration service response), and configurable parameters. This action allows navigation to a specified relation or a static URL. ```APIDOC navigate Action: Description: Navigates to a relation from the entity. If the action is called in sidebar, navigates to a relation from the task. If the action is used in an integration service (IS) response within executeActions, it will navigate to a relation from the entity of the section that called the IS. If url is passed instead of relation, it navigates to this url. Extends: Action Configuration: relation: relation from the task to the entity using .p syntax. section: navigate and display a given section found by its section id. url: static url to an iWe entity. Use real link as UI will transform the url to properly redirect to the entity page. ``` -------------------------------- ### open Property Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-sections/documents No description ```APIDOC open: boolean ``` -------------------------------- ### COUNT Function: Get Array Length Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/expression/expressions Returns the number of items in an array. ```APIDOC COUNT(array) ``` ```Expression Language COUNT([1, 2, 4]) ==> 3 ``` -------------------------------- ### @import Property Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-sections/documents No description ```APIDOC @import: string ``` -------------------------------- ### FIRST Function: Get First Element of Array Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/expression/expressions Returns the first element of an array. ```APIDOC FIRST(array) ``` ```Expression Language FIRST([2, 4, 6]) ==> 2 ``` -------------------------------- ### STARTOF Function Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/expression/expressions Returns the start of a period (day, month, year) for a given date. ```APIDOC STARTOF(date, "month") ``` ```Expression Language STARTOF('02/02/2024','year') ==> 01/01/2024 ``` -------------------------------- ### Example: AspectRefParams Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/aspects/aspectrefparams Illustrates the basic JSON structure for configuring an AspectRefParams object, specifying 'reference' as the field for entity identification. ```JSON "ref": { "fields": [ "reference" ] } ``` -------------------------------- ### HomePage v2 Configuration Properties Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepage Defines the structure and required fields for configuring the HomePage v2, which is activated when `homeVersion` is set to 2. ```APIDOC HomePage: Description: The homepage v2 configuration is located under the config field in the homepage declaration. It is activated only if the field homeVersion is set to 2. Properties: config: Required: true definition: Required: true homeVersion: Required: true profile: Required: true ref: Required: true ``` -------------------------------- ### title Property Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/forms/forms-sections/documents No description ```APIDOC title: I18nString ``` -------------------------------- ### Download Action API Reference Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/actions/actions/downloadaction Defines the 'download' action, which enables users to download documents to their computer. It extends the base 'Action' class, inheriting its properties and behaviors. ```APIDOC Action: download Description: Download a document on user computer Extends: Action ``` -------------------------------- ### Assign Me Button Configuration Options API Reference Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/report/assignmeactionbutton Detailed API documentation for the 'assignMe' button's `action` configuration, including `from`, `party`, `fill` (with `roletype`), `mode` (replace/create), and `parentOrg` parameters. ```APIDOC action: object from: string (name of the report object which URL will be sent to the server) party: string (party in which the contact will be added as participant) fill: object roletype: string (participant roletype) mode: string (optional, 'replace' or 'create') - 'replace': If replaced, and there is no empty placeholder, it will replace the participant contact by the selected contact. - 'create': If mode create, and there is no empty placeholder, it will create a new participant with the roletype defined in the button config in the correct party. parentOrg: boolean (default: false) - If true, and the user contact has a company, it will add the company in a participant using the roletypeOrganization configuration to guess the correct roletype. - If the parent is already assigned and in mode replace, it will replace it by the contact company. - If mode create and there is no empty participant with the correct roletype it will create a new one. - If the parent participant is already assigned and no mode is defined it won't do anything. ``` -------------------------------- ### FORMAT_COUNTRY Function: Get Country Name from ISO Code Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/expression/expressions Returns the name of a country from its ISO code. ```APIDOC FORMAT_COUNTRY(country) ``` ```Expression Language FORMAT_COUNTRY('FR') ==> 'France' ``` -------------------------------- ### Homepage Property: header Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/query-report-home-page/homepage/homepagepage The header property contains all home page header display configurations. ```APIDOC header?: Header description: The header is the property that contains all home page header display. ``` -------------------------------- ### COUNTER Function: Get Next Counter Value Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/expression/expressions Returns the next counter value for a given identifier. ```APIDOC COUNTER(identifier) ``` ```Expression Language "I-" + COUNTER(items) ``` -------------------------------- ### Example of iWE Unary Minus Operator (-) Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/expression/expressions Demonstrates the application of the unary `-` operator in iWE expressions to negate a numerical value. ```Javascript // data: // { // "a": 1 // } -a // ==> -1 ``` -------------------------------- ### Example JSON for Iban Field Type Configuration Source: https://iwe.gitbook.io/applications-reference-manual/7elD1eaNC1RNiRUu1pMb/7elD1eaNC1RNiRUu1pMb/definitions/field-data-type/iban Illustrates the JSON structure for defining a field with the 'Iban' type within a configuration object. ```json "fieldName": { "type": { "name": "Iban" } } ```