Generated Project Developer Documentation

mikeVersion: "1.0.0"
mikeDir: "mike"
sourceRootDirName: "src/main/java"
resourceRootDirName: "src/main/resources"
previewDirName: "mike-preview"
apiKey: "YOUR-API-KEY"
hostUrl: "https://app.codemike.dev/gen"
requestTimeout: 120
techStack: "SpringVaadin"
undoStackSize: 5

# Configurations of your project
# Main descriptor
mainMikeFile: main.mike
java:
  package:
    # Base package of the project
    base: hu.rts.mike.example.dev.crm
projectName: "CRM-dev"
languages:
  - "hu-HU"
  - "en-US"

data {
    entity Partner @display("{0}", name) {
        id: Int @primary
        name: String!
        taxNumber: String
        zipCode: String  # String so it can start with 0
        city: String
        streetName: String
        streetKind: String
        streetNumber: Int
        invoicingEmail: String
        createdAt: DateTime @value(CREATED_AT)

        contacts: [Contact] @mappedBy(partner)
        companySizeData: [CompanySize] @mappedBy(partner)
        leads: [Lead] @mappedBy(partner)
    }

    entity Contact {
        id: Int @primary
        name: String!
        email: String
        phone: String
        position: String
        modifiedAt: DateTime @value(MODIFIED_AT)
        inactive: DateTime @value(DELETED_AT)

        partner: Partner!
    }

    entity CompanySize {
        id: Int @primary
        year: Int!
        revenue: Int!
        profit: Int!
        headcount: Int!

        partner: Partner!
    }

    entity Lead
        @display("{0} |Salesperson: {1} - Customer: {2} |{3}%", createdAt, vendor.name, partner.name, chanceOfSuccess)
    {
        id: Int @primary
        soreSpot: String!
        createdAt: Date @value(CREATED_AT)
        daysFromCreatedAt: Int @value(COMPUTED)

        chanceOfSuccess: Int @value(COMPUTED)
        estimatedIncome: Int @value(COMPUTED)
        expectedValue: Int @value(COMPUTED)

        vendor: Vendor!
        partner: Partner!
        discounts: [Discount] @unidirectional
        marketingChannel: MarketingChannel!
        events: [Event] @mappedBy(lead)
        products: [Product]
    }

    entity Product @display("{0}", name) {
        id: Int @primary
        name: String!
        regularity: Regularity!
        addQuantityAtBilling: Bool
        price: Int
        tax: Int
        currency: MediumOfExchange!
        note: String

        leads: [Lead] @mappedBy(products)
    }

    enum Regularity: String {
        OCCASIONALLY @storedAs("Occasional")
        MONTHLY @storedAs("Monthly")
        QUARTER @storedAs("Quarterly")
        YEARLY @storedAs("Annual")
    }

    enum MediumOfExchange: String {
        HUF @storedAs("Ft")
        EUR @storedAs("€")
        USD @storedAs("$")
    }

    entity Discount @unique(name, discountType, value) @display("{0} - {1}", name, discountType) {
        id: Int @primary
        name: String!
        discountType: DiscountType!
        value: Int!
    }

    enum DiscountType: String {
        AMOUNT @storedAs("Lump sum")
        PERCENTAGE @storedAs("Percentage")
    }

    entity Event {
        id: Int @primary
        eventDetails: String! @default("Lead recorded")
        nextAppointment: Date!
        chanceOfSuccess: Int!

        communicationChannel: CommunicationChannel! @unidirectional
        lead: Lead
    }

    entity CommunicationChannel @display("{0}", name) {
        id: Int @primary
        name: String!
    }

    entity MarketingChannel @display("{0}", name) {
        id: Int @primary
        name: String!

        leads: [Lead] @mappedBy(marketingChannel)
        budgets: [Budget] @mappedBy(marketingChannel)
    }

    entity Vendor @display("{0}", name) {
        id: Int @primary
        name: String!

        leads: [Lead] @mappedBy(vendor)
    }

    entity Budget @unique(year, month, marketingChannel) {
        id: Int @primary
        year: BudgetYear!
        month: BudgetMonth!
        marketingChannel: MarketingChannel!

        marketingBudgetPlan: Int
        numberOfLeadsPlan: Int
        numberOfSuccessfulLeadsPlan: Int
        revenuePlan: Int

        marketingBudgetActual: Int
        numberOfLeadsActual: Int @value(COMPUTED)
        numberOfSuccessfulLeadsActual: Int @value(COMPUTED)
        revenueActual: Int @value(COMPUTED)
    }

    enum BudgetYear: String {
        YEAR_2023 @storedAs("2023")
        YEAR_2024 @storedAs("2024")
    }

    enum BudgetMonth: String {
        JANUARY @storedAs("January")
        FEBRUARY @storedAs("February")
        MARCH @storedAs("March")
        APRIL @storedAs("April")
        MAY @storedAs("May")
        JUNE @storedAs("June")
        JULY @storedAs("July")
        AUGUST @storedAs("August")
        SEPTEMBER @storedAs("September")
        OCTOBER @storedAs("October")
        NOVEMBER @storedAs("November")
        DECEMBER @storedAs("December")
    }
}

ui {
    navigation CrmNav {
        item MarketingItem @title("Marketing") @icon("fas:chart-column") {
            item CommunicationChannelNavItem: CommunicationChannels @title("Communication channels")
            item MarketingChannelNavItem: MarketingChannels @title("Marketing channels")
        }

        item SalesItem @title("Sales") @icon("fas:dollar") {
            item ProductsNavItem: Products @title("Products")
            item DiscountsNavItem: Discounts @title("Discounts")
            item VendorsNavItem: Vendors @title("Sales people")
            item PartnersNavItem: Partners @title("Partners")
            item ContactsNavItem: Contacts @title("Contacts")
            item LeadsNavItem: Leads @title("Leads")
        }
    }

    page Partners @title("Partners") @home {
        table PartnersList: Partner
            @hiddenFilters
            @searchBar(name, city, streetName, taxNumber)
            @viewPage(ViewPartner)
            @createPage(AddNewPartner)
            @editPage(EditPartner)
        {
            column: name @title("Name")
            column: zipCode @title("Zip code")
            column: city @title("City")
            column: streetName @title("Street")
            column: streetKind @title("Public area type")
            column: streetNumber @title("House number")
            column: taxNumber @title("Tax number")
        }
    }

    page AddNewPartner @title("New partner") {
        form AddNewPartnerForm: Partner {
            input: name @title("Name")
            input: taxNumber @title("Tax number")
            input: zipCode @title("Zip code")
            input: city @title("City")
            input: streetName @title("Street")
            input: streetKind @title("Public area type")
            input: streetNumber @title("House number")
            input: invoicingEmail @title("Billing e-mail")
        }
    }

    page EditPartner requires Partner as partner @title("Edit partner") {
        form EditPartnerForm: Partner using partner {
            input: name @title("Name")
            input: taxNumber @title("Tax number")
            input: zipCode @title("Zip code")
            input: city @title("City")
            input: streetName @title("Street")
            input: streetKind @title("Public area type")
            input: streetNumber @title("House number")
            input: invoicingEmail @title("Billing e-mail")
        }
    }

    page ViewPartner requires Partner as partner @title("Partner profile") @layout(HORIZONTAL) {
        details ViewPartnerHeaderDetails: Partner using partner @editPage(EditPartner) {
            field: name @title("Name")
            field: taxNumber @title("Tax number")
            field: createdAt @title("Created at")
            field: zipCode @title("Zip code")
            field: city @title("City")
            field: streetName @title("Street")
            field: streetKind @title("Public area type")
            field: streetNumber @title("House number")
        }

        container ViewPartnerBodyContainer @layout(TABBED) {
            table ViewPartnerBodyContactsTable: Contact using partner.contacts
                @omitted(VIEW)
                @editPage(ContactEdit)
                @createPage(ContactAddNew)
                @hiddenFilters
                @heading("Contacts")
            {
                column: name @title("Name")
                column: position @title("Position")
                column: phone @title("Phone")
                column: email @title("E-mail")
                column: modifiedAt @title("Last modified")
            }

            table ViewPartnerBodyCompanySizeTable: CompanySize using partner.companySizeData
                @omitted(VIEW)
                @omitted(DELETE)
                @editPage(CompanySizeEdit)
                @createPage(CompanySizeAddNew)
                @hiddenFilters
                @heading("Company size")
            {
                column: year @title("Year")
                column: revenue @title("Revenue")
                column: profit @title("Profit")
                column: headcount @title("Headcount")
            }
        }
    }

    page ContactAddNew @title("New contact") {
        form ContactAddNewForm: Contact {
            input: name @title("Name")
            input: position @title("Position")
            input: phone @title("Phone")
            input: email @title("E-mail")
            input: partner @title("Partner")
        }
    }

    page ContactEdit requires Contact as contact @title("Edit contact") {
        form ContactEditForm: Contact using contact {
            input: name @title("Name")
            input: position @title("Position")
            input: phone @title("Phone")
            input: email @title("E-mail")
            input: partner @title("Partner")
        }
    }

    page CompanySizeAddNew @title("New company size") {
        form CompanySizeAddNewForm: CompanySize {
            input: year @title("Year")
            input: revenue @title("Revenue")
            input: profit @title("Profit")
            input: headcount @title("Headcount")
            input: partner @title("Partner")
        }
    }

    page CompanySizeEdit requires CompanySize as companySize @title("Edit company size") {
        form CompanySizeEditForm: CompanySize using companySize {
            input: year @title("Year")
            input: revenue @title("Revenue")
            input: profit @title("Profit")
            input: headcount @title("Headcount")
            input: partner @title("Partner")
        }
    }

    page Products @title("Products") {
        table ProductsTable: Product @omitted(VIEW) @createPage(CreateProduct) @editPage(EditProduct) {
            column: name @title("Name")
            column: price @title("Price")
            column: currency @title("Currency")
        }
    }

    page CreateProduct {
        form CreateProductForm: Product @heading("New product") {
            input: name @title("Name")
            input: regularity @title("Regularity")
            input: addQuantityAtBilling @title("Value to be entered at billing")
            input: price @title("Price")
            input: tax @title("Tax")
            input: currency @title("Currency")
            input: note @title("Note")
        }
    }

    page EditProduct requires Product as product {
        form EditProductForm: Product using product @heading("Edit product") {
            input: name @title("Name")
            input: regularity @title("Regularity")
            input: addQuantityAtBilling @title("Value to be entered at billing")
            input: price @title("Price")
            input: tax @title("Tax")
            input: currency @title("Currency")
            input: note @title("Note")
        }
    }

    page Discounts @title("Discounts") {
        table DiscountsTable: Discount
            @hiddenFilters
            @omitted(VIEW)
            @createPage(CreateDiscount)
            @editPage(EditDiscount)
        {
            column: name @title("Discount name")
            column: discountType @title("Type")
            column: value @title("Value")
        }
    }

    page CreateDiscount @title("New discount") {
        form CreateDiscountForm: Discount {
            input: name @title("Name")
            input: discountType @title("Type")
            input: value @title("Value")
        }
    }

    page EditDiscount requires Discount as discount @title("Edit discount") {
        form EditDiscountForm: Discount using discount {
            input: name @title("Name")
            input: discountType @title("Type")
            input: value @title("Value")
        }
    }

    page Leads @title("Leads") {
        table LeadsTable: Lead
            @omitted(DELETE)
            @omitted(EDIT)
            @createPage(AddNewLead)
            @viewPage(ViewLead)
        {
            column: id @title("#")
            column: chanceOfSuccess @title("Chance")
            column: estimatedIncome @title("Estimated revenue") @hidden
            column: expectedValue @title("Expected value") @hidden
            column: partner.name @title("Partner")
            column: vendor.name @title("Salesperson")
            column: createdAt @title("Created")
            column: daysFromCreatedAt @title("Elapsed") @hidden
            column: marketingChannel.name @title("Marketing channel")
        }
    }

    page AddNewLead @title("Add new lead") {
        form AddNewLeadForm: Lead {
            input: vendor @title("Salesperson")
            input: partner @title("Partner")
            input: discounts @title("Discounts")
            input: marketingChannel @title("Marketing channel")
            input: products @title("Products")
            input: soreSpot @title("Sore spot")
        }
    }

    page ViewLead requires Lead as lead @title("Lead profile") {
        container ViewLeadLeft @layout(HORIZONTAL) {
            details ViewLeadDetailsHeader: Lead using lead @heading("Lead") @omitted(EDIT) {
                field: partner.name @title("Partner")
                field: partner.taxNumber @title("Tax number")
                field: createdAt @title("Created at")
                field: soreSpot @title("Sore spot")
                field: vendor @title("Salesperson")
            }

            container ViewLeadTabbedContainer @layout(TABBED) {
                table ViewLeadBodyProductsTable: Product using lead.products
                    @omitted(VIEW)
                    @createPage(CreateProduct)
                    @editPage(EditProduct)
                    @hiddenFilters
                    @heading("Products")
                {
                    column: name @title("Name")
                    column: price @title("Price")
                    column: regularity @title("Regularity")
                    column: tax @title("Tax")
                    column: currency @title("Currency")
                }

                table ViewLeadBodyContactsTableRight: Contact using lead.partner.contacts
                    @omitted(VIEW)
                    @editPage(ContactEdit)
                    @createPage(ContactAddNew)
                    @hiddenFilters
                    @heading("Contacts")
                {
                    column: name @title("Name")
                    column: position @title("Position")
                    column: phone @title("Phone")
                    column: email @title("E-mail")
                    column: modifiedAt @title("Last modified") @hidden
                }

                table ViewLeadBodyCompanySizeTableRight: CompanySize using lead.partner.companySizeData
                    @omitted(VIEW)
                    @omitted(DELETE)
                    @editPage(CompanySizeEdit)
                    @createPage(CompanySizeAddNew)
                    @hiddenFilters
                    @heading("Company size")
                {
                    column: year @title("Year")
                    column: revenue @title("Revenue")
                    column: profit @title("Profit")
                    column: headcount @title("Headcount")
                }
            }
        }

        table ViewLeadEventsTable: Event using lead.events
            @omitted(EDIT)
            @omitted(DELETE)
            @omitted(VIEW)
            @heading("Events")
            @createPage(AddNewEventPage)
        {
            column: communicationChannel.name @title("Communication channel")
            column: lead.partner.name @title("Partner")
            column: chanceOfSuccess @title("Chance")
            column: nextAppointment @title("Appointment")
            column: eventDetails @title("Details")
        }
    }

    page AddNewEventPage @title("Add new event") {
        form AddNewEventForm: Event {
            input: communicationChannel @title("Communication channel")
            input: lead @title("Lead")
            input: chanceOfSuccess @title("Chance")
            input: nextAppointment @title("Appointment")
            input: eventDetails @title("Details")
        }
    }

    page CommunicationChannels @title("Communication channels") {
        table CommunicationChannelsTable: CommunicationChannel
            @heading("Communication channels")
            @omitted(VIEW)
            @editPage(EditCommunicationChannel)
            @createPage(AddNewCommunicationChannel)
        {
            column: name @title("Channel name")
        }
    }

    page EditCommunicationChannel requires CommunicationChannel as channel @title("Modify communication channel") {
        form MarketingChannelEditForm: CommunicationChannel using channel @heading("Modify communication channel") {
            input: name @title("Channel name")
        }
    }

    page AddNewCommunicationChannel @title("New communication channel") {
        form MarketingChannelEditForm: CommunicationChannel @heading("New communication channel") {
            input: name @title("Channel name")
        }
    }

    page MarketingChannels @title("Marketing channels") {
        table MarketingChannelsTable: MarketingChannel
            @heading("Marketing channels")
            @viewPage(ViewMarketingChannelBudget)
            @editPage(EditMarketingChannel)
            @createPage(AddNewMarketingChannel)
        {
            column: name @title("Channel name")
        }

    }

    page ViewMarketingChannelBudget requires MarketingChannel as channel @title("Marketing channel budget") {
        container MChannelBudgetContainer @layout(TABBED) {
            table MarketingChannelBudget: Budget using channel.budgets
                @omitted(VIEW)
                @createPage(AddNewMChannelBudget)
                @editPage(EditMChannelBudget)
                @title("Marketing channel budget")
            {
                column: year @title("Year")
                column: month @title("Month")
                column: marketingBudgetPlan @title("Planned marketing costs")
                column: numberOfLeadsPlan @title("No. of planned leads")
                column: numberOfSuccessfulLeadsPlan @title("No. of planned successful leads")
                column: revenuePlan @title("Planned revenue")
                column: marketingBudgetActual @title("Actual marketing costs")
                column: numberOfLeadsActual @title("No. of actual leads")
                column: numberOfSuccessfulLeadsActual @title("No. of actual successful leads")
                column: revenueActual @title("Actual revenue")
            }
        }
    }

    page AddNewMChannelBudget @title("Add new marketing channel budget") {
        form AddNewMChannelBudgetForm: Budget {
            input: year @title("Year")
            input: month @title("Month")
            input: marketingChannel @title("Marketing channel")
            input: marketingBudgetPlan @title("Planned marketing costs")
            input: numberOfLeadsPlan @title("No. of planned leads")
            input: numberOfSuccessfulLeadsPlan @title("No. of planned successful leads")
            input: revenuePlan @title("Planned revenue")
            input: marketingBudgetActual @title("Actual marketing costs")
        }
    }

    page EditMChannelBudget requires Budget as budget @title("Edit marketing channel budget") {
        form EditMChannelBudgetForm: Budget using budget {
            input: year @title("Year")
            input: month @title("Month")
            input: marketingChannel @title("Marketing channel")
            input: marketingBudgetPlan @title("Planned marketing costs")
            input: numberOfLeadsPlan @title("No. of planned leads")
            input: numberOfSuccessfulLeadsPlan @title("No. of planned successful leads")
            input: revenuePlan @title("Planned revenue")
            input: marketingBudgetActual @title("Actual marketing costs")
        }
    }

    page EditMarketingChannel requires MarketingChannel as channel @title("Modify marketing channel") {
        form MarketingChannelEditForm: MarketingChannel using channel @heading("Modify marketing channel") {
            input: name @title("Channel name")
        }
    }

    page AddNewMarketingChannel @title("New marketing channel") {
        form MarketingChannelEditForm: MarketingChannel @heading("New marketing channel") {
            input: name @title("Channel name")
        }
    }

    page Contacts @title("Contacts") {
        table ContactsTable: Contact @createPage(AddNewContact) @editPage(EditContact) @viewPage(ViewContact) {
            column: name @title("Name")
            column: email @title("E-mail")
            column: phone @title("Phone")
            column: position @title("Position")
            column: modifiedAt @title("Modified at") @hidden
            column: partner.name @title("Partner")
            column: inactive @title("Inactivated") @hidden
        }
    }

    page AddNewContact @title("Add new contact") {
        form AddNewContactForm: Contact {
            input: name @title("Name")
            input: email @title("E-mail")
            input: phone @title("Phone")
            input: position @title("Position")
            input: partner @title("Partner")

        }
    }

    page EditContact requires Contact as contact @title("Edit contact") {
        form EditContactForm: Contact using contact {
            input: name @title("Name")
            input: email @title("E-mail")
            input: phone @title("Phone")
            input: position @title("Position")
            input: partner @title("Partner")
        }
    }

    page ViewContact requires Contact as contact @title("Contact profile") {
        details ContactDetails: Contact using contact @editPage(EditContact) {
            field: name @title("Name")
            field: email @title("E-mail")
            field: phone @title("Phone")
            field: position @title("Position")
            field: partner.name @title("Partner")
        }
    }

    page Vendors @title("Sales people") {
        table VendorsTable: Vendor @viewPage(ViewVendor) @createPage(AddNewVendor) @editPage(EditVendor) {
            column: name @title("Name")
        }
    }

    page AddNewVendor @title("Add salesperson") {
        form AddNewVendorForm: Vendor {
            input: name @title("Name")
        }
    }

    page EditVendor requires Vendor as vendor @title("Edit salesperson") {
        form EditVendorForm: Vendor using vendor {
            input: name @title("Name")
        }
    }

    page ViewVendor requires Vendor as vendor @title("Salesperson profile") {
        details VendorDetails: Vendor using vendor @editPage(EditVendor) {
            field: name @title("Name")
        }

        container ViewVendorBody @layout(TABBED) {
            table VendorLeadsTable: Lead using vendor.leads
                @readonly
                @viewPage(ViewLead)
                @title("Salesperson's leads")
            {
                column: id @title("#")
                column: chanceOfSuccess @title("Chance")
                column: estimatedIncome @title("Estimated revenue")
                column: expectedValue @title("Expected value")
                column: partner.name @title("Partner")
                column: createdAt @title("Created")
                column: daysFromCreatedAt @title("Elapsed")
                column: marketingChannel.name @title("Marketing channel")
            }
        }
    }
}