1:HL["/_next/static/css/6bd36201de36b157.css",{"as":"style"}] 0:["SjwqWs581guB4LhqFq0Oc",[[["",{"children":["quickstart",{"children":["groups",{"children":["ubuntu",{"children":["__PAGE__",{}]}]}]}]},"$undefined","$undefined",true],"$L2",[[["$","link","0",{"rel":"stylesheet","href":"/_next/static/css/6bd36201de36b157.css","precedence":"next"}]],"$L3"]]]] 2:[null,"$L4",null] 3:[["$","meta","0",{"charSet":"utf-8"}],["$","title","1",{"children":"Protocol API Reference"}],["$","meta","2",{"name":"viewport","content":"width=device-width, initial-scale=1"}],["$","link","3",{"rel":"icon","href":"/favicon.ico","type":"image/x-icon","sizes":"256x256"}]] 5:I{"id":4129,"chunks":["9982:static/chunks/93854f56-9ae0c09bcc02b636.js","2420:static/chunks/9081a741-dd8e5993991f401c.js","6685:static/chunks/6685-a937dd3e2b88ed12.js","2435:static/chunks/2435-ac4b486d27c0bea1.js","6021:static/chunks/6021-3dfd29e59407678e.js","3222:static/chunks/3222-150407128078c3bc.js","1859:static/chunks/1859-ad392470f22235e6.js","5170:static/chunks/5170-d43543fb1d3902f8.js","3185:static/chunks/app/layout-0bb2a92c31dce64c.js"],"name":"Providers","async":false} 6:I{"id":7757,"chunks":["9982:static/chunks/93854f56-9ae0c09bcc02b636.js","2420:static/chunks/9081a741-dd8e5993991f401c.js","6685:static/chunks/6685-a937dd3e2b88ed12.js","2435:static/chunks/2435-ac4b486d27c0bea1.js","6021:static/chunks/6021-3dfd29e59407678e.js","3222:static/chunks/3222-150407128078c3bc.js","1859:static/chunks/1859-ad392470f22235e6.js","5170:static/chunks/5170-d43543fb1d3902f8.js","3185:static/chunks/app/layout-0bb2a92c31dce64c.js"],"name":"Layout","async":false} 7:I{"id":7767,"chunks":["2272:static/chunks/webpack-9c39eedf017990e3.js","2971:static/chunks/fd9d1056-0ec2db3eb7ac1547.js","596:static/chunks/596-aaaa00efe9da3984.js"],"name":"default","async":false} 8:I{"id":7920,"chunks":["2272:static/chunks/webpack-9c39eedf017990e3.js","2971:static/chunks/fd9d1056-0ec2db3eb7ac1547.js","596:static/chunks/596-aaaa00efe9da3984.js"],"name":"default","async":false} 9:I{"id":6685,"chunks":["6685:static/chunks/6685-a937dd3e2b88ed12.js","2435:static/chunks/2435-ac4b486d27c0bea1.js","5170:static/chunks/5170-d43543fb1d3902f8.js","9692:static/chunks/app/quickstart/groups/ubuntu/page-f5cc448376dafd8d.js"],"name":"","async":false} b:I{"id":3457,"chunks":["6685:static/chunks/6685-a937dd3e2b88ed12.js","2435:static/chunks/2435-ac4b486d27c0bea1.js","5170:static/chunks/5170-d43543fb1d3902f8.js","9692:static/chunks/app/quickstart/groups/ubuntu/page-f5cc448376dafd8d.js"],"name":"Pre","async":false} c:I{"id":3457,"chunks":["6685:static/chunks/6685-a937dd3e2b88ed12.js","2435:static/chunks/2435-ac4b486d27c0bea1.js","5170:static/chunks/5170-d43543fb1d3902f8.js","9692:static/chunks/app/quickstart/groups/ubuntu/page-f5cc448376dafd8d.js"],"name":"Code","async":false} d:I{"id":3106,"chunks":["6685:static/chunks/6685-a937dd3e2b88ed12.js","2435:static/chunks/2435-ac4b486d27c0bea1.js","5170:static/chunks/5170-d43543fb1d3902f8.js","9692:static/chunks/app/quickstart/groups/ubuntu/page-f5cc448376dafd8d.js"],"name":"Heading","async":false} f:I{"id":6577,"chunks":["6685:static/chunks/6685-a937dd3e2b88ed12.js","2435:static/chunks/2435-ac4b486d27c0bea1.js","5170:static/chunks/5170-d43543fb1d3902f8.js","9692:static/chunks/app/quickstart/groups/ubuntu/page-f5cc448376dafd8d.js"],"name":"Feedback","async":false} e:T2e75,version: '3.6' services: mongo: hostname: mongo image: mongo:4.0.10 # container_name: mongo ports: - "27017:27017" networks: - erxes-net healthcheck: test: test $$(echo "rs.initiate().ok || rs.status().ok" | mongo --quiet) -eq 1 interval: 2s timeout: 2s retries: 200 command: ["--replSet", "rs0", "--bind_ip_all"] extra_hosts: - "mongo:127.0.0.1" volumes: - ./data/db:/data/db redis: image: 'redis' # container_name: redis # command: redis-server --requirepass pass ports: - "6379:6379" networks: - erxes-net rabbitmq: image: rabbitmq:3.7.17-management # container_name: rabbitmq restart: unless-stopped hostname: rabbitmq ports: - "15672:15672" - "5672:5672" networks: - erxes-net # RabbitMQ data will be saved into ./rabbitmq-data folder. volumes: - ./rabbitmq-data:/var/lib/rabbitmq networks: erxes-net: driver: bridge 4:["$","html",null,{"lang":"en","className":"h-full","suppressHydrationWarning":true,"children":["$","body",null,{"className":"flex min-h-full bg-white antialiased dark:bg-zinc-900","children":["$","$L5",null,{"children":["$","div",null,{"className":"w-full","children":["$","$L6",null,{"allSections":{"/":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/authentication":[{"title":"GraphQL API","id":"graphql"},{"title":"Postman Collection","id":"postman"},{"title":"Code reference","id":"reference"}],"/conversations":[{"title":"System configuration","id":"system-configuration"},{"title":"Permission","id":"permission"},{"title":"Team member","id":"team-member"},{"title":"Brands","id":"brands"},{"title":"Import/Export","id":"import-export"},{"title":"Channel","id":"channel"},{"title":"Script Installation","id":"script-installation"}],"/contacts":[{"title":"Panel","id":"panel"},{"title":"Marketplace","id":"marketplace"}],"/customer":[{"title":"XM for B2B order","id":"xm-for-b2-b-order"},{"title":"XM for B2B Sales","id":"xm-for-b2-b-sales"},{"title":"XM for Catering","id":"xm-for-catering"},{"title":"XM for Ecommerce","id":"xm-for-ecommerce"},{"title":"XM for POS","id":"xm-for-pos"},{"title":"XM for Scheduling","id":"xm-for-scheduling"}],"/errors":[{"title":"Status codes","id":"status-codes"},{"title":"Error types","id":"error-types"}],"/finance":[{"title":"XM for Leasing","id":"xm-for-leasing"},{"title":"XM for Payment","id":"xm-for-payment"},{"title":"XM for Rental","id":"xm-for-rental"}],"/frontline":[{"title":"XM for CallCenter","id":"xm-for-call-center"},{"title":"XM for Chatbot","id":"xm-for-chatbot"},{"title":"XM for Help Center","id":"xm-for-help-center"},{"title":"XM for Ticket Management","id":"xm-for-ticket-management"}],"/employee":[],"/attachments":[{"title":"The attachment model","id":"the-attachment-model"},{"title":"List all attachments","id":"list-all-attachments","tag":"GET","label":"/v1/attachments"},{"title":"Create an attachment","id":"create-an-attachment","tag":"POST","label":"/v1/attachments"},{"title":"Retrieve an attachment","id":"retrieve-an-attachment","tag":"GET","label":"/v1/attachments/:id"},{"title":"Update an attachment","id":"update-an-attachment","tag":"PUT","label":"/v1/attachments/:id"},{"title":"Delete an attachment","id":"delete-an-attachment","tag":"DELETE","label":"/v1/attachments/:id"}],"/groups":[{"title":"Products","id":"products"},{"title":"Script Installation","id":"script-installation"},{"title":"Employee Experience Management","id":"employee-experience-management"},{"title":"Industries","id":"industries"},{"title":"Teams","id":"teams"},{"title":"Employee Experience Management","id":"employee-experience-management-2"}],"/intro":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"frequently-asked-questions"}],"/marketing":[{"title":"XM for Marketing automation","id":"xm-for-marketing-automation"},{"title":"XM for Newsletter","id":"xm-for-newsletter"},{"title":"XM for Survey","id":"xm-for-survey"}],"/messages":[{"title":"Team Inbox","id":"team-inbox"},{"title":"Introduction to add-ons","id":"introduction-to-add-ons"},{"title":"Introduction to services","id":"introduction-to-services"},{"title":"Introduction to power-ups","id":"introduction-to-power-ups"}],"/pagination":[{"title":"Contribute to codebase","id":"contribute-to-codebase"},{"title":"Contribute to documentation","id":"contribute-to-documentation"},{"title":"Documentation style guide","id":"documentation-style-guide"}],"/requirement":[],"/webhooks":[{"title":"Registering webhooks","id":"registering-webhooks"},{"title":"Consuming webhooks","id":"consuming-webhooks"},{"title":"Event types","id":"event-types"},{"title":"Security","id":"security"}],"/authentication/graphql":[],"/authentication/postman":[],"/conversations/brands":[{"title":"Brands","id":"brands"}],"/quickstart":[{"title":"Local installation","id":"local-installation"},{"title":"Server installation","id":"server-installation"}],"/authentication/reference":[{"title":"UI","id":"ui"},{"title":"API","id":"api"}],"/sdks":[{"title":"Create General Plugin","id":"create-general-plugin"},{"title":"Create Integration plugin","id":"create-integration-plugin"}],"/conversations/channel":[{"title":"Channel","id":"channel"}],"/conversations/impexp":[{"title":"Import/Export","id":"import-export"}],"/conversations/permission":[{"title":"Permission","id":"permission"}],"/conversations/team":[{"title":"Team member","id":"team-member"}],"/conversations/script":[{"title":"Script Installation","id":"script-installation"}],"/contacts/panel":[{"title":"Admin Panel","id":"panel"},{"title":"Marketplace","id":"market"}],"/groups/products":[],"/messages/add":[],"/contacts/market":[],"/messages/power":[],"/messages/channels":[{"title":"With Channels, you can do...","id":"with-channels-you-can-do"},{"title":"Creating your channels","id":"creating-your-channels"}],"/messages/services":[],"/conversations/system":[{"title":"System configuration","id":"system-configuration"}],"/groups/team":[{"title":"Employee Experience Management","id":"employee-experience-management"},{"title":"Centralized complete HR database","id":"centralized-complete-hr-database"},{"title":"Knowledge, onboarding & training campaign","id":"knowledge-onboarding-and-training-campaign"},{"title":"Automatically generated HR templates","id":"automatically-generated-hr-templates"},{"title":"Fully customizable recruitment pipeline","id":"fully-customizable-recruitment-pipeline"},{"title":"The next generation of time-tracking system","id":"the-next-generation-of-time-tracking-system"},{"title":"Clear view of employee productivity","id":"clear-view-of-employee-productivity"},{"title":"Employee feed & Communication","id":"employee-feed-and-communication"},{"title":"Quick and efficient asset record","id":"quick-and-efficient-asset-record"}],"/pagination/codebase":[{"title":"Prerequisites","id":"prerequisites"},{"title":"Issues before PRs","id":"issues-before-prs"}],"/messages/skills":[{"title":"To set up Skills","id":"to-set-up-skills"}],"/messages/response":[{"title":"With Response Template, you can do...","id":"with-response-template-you-can-do"},{"title":"Create your response template","id":"create-your-response-template"}],"/requirement/customer":[],"/messages/team":[{"title":"With Inbox, you can do...","id":"with-inbox-you-can-do"},{"title":"Features works with Inbox","id":"features-works-with-inbox"}],"/authentication/graphql/enu":[{"title":"CacheControlScope","id":"cache-control-scope"},{"title":"ChatMemberModifyType","id":"chat-member-modify-type"},{"title":"ChatType","id":"chat-type"},{"title":"ChatVisibilityType","id":"chat-visibility-type"},{"title":"ClientPortalUserVerificationStatus","id":"client-portal-user-verification-status"},{"title":"ContentType","id":"content-type"},{"title":"ExmGoingOrInterested","id":"exm-going-or-interested"},{"title":"FilterType","id":"filter-type"},{"title":"NotificationType","id":"notification-type"},{"title":"ReactionContentType","id":"reaction-content-type"},{"title":"RecipientType","id":"recipient-type"},{"title":"SourceType","id":"source-type"}],"/pagination/contributedoc":[],"/pagination/docstyle":[{"title":"Markdown Syntax","id":"markdown-syntax"},{"title":"Headers","id":"headers"},{"title":"H2 - Create the best documentation","id":"h2-create-the-best-documentation"},{"title":"H3 - Create the best documentation","id":"h3-create-the-best-documentation"},{"title":"Reference-style: ","id":"reference-style"},{"title":"Quote break.","id":"quote-break"}],"/requirement/employee":[{"title":"Assumptions","id":"assumptions"},{"title":"Scalability","id":"scalability"},{"title":"Security","id":"security"},{"title":"Usability","id":"usability"},{"title":"Performance","id":"performance"}],"/authentication/graphql/object":[{"title":"Absence","id":"absence"},{"title":"AbsenceType","id":"absence-type"},{"title":"Action","id":"action"},{"title":"ActivityLog","id":"activity-log"},{"title":"ActivityLogByAction","id":"activity-log-by-action"},{"title":"ActivityLogByActionResponse","id":"activity-log-by-action-response"},{"title":"App","id":"app"},{"title":"Asset","id":"asset"},{"title":"AssetCategory","id":"asset-category"},{"title":"Assignment","id":"assignment"},{"title":"AssignmentCampaign","id":"assignment-campaign"},{"title":"AssignmentMain","id":"assignment-main"},{"title":"Attachment","id":"attachment"},{"title":"Automation","id":"automation"},{"title":"AutomationHistory","id":"automation-history"},{"title":"AutomationNote","id":"automation-note"},{"title":"AutomationsListResponse","id":"automations-list-response"},{"title":"automationsTotalCountResponse","id":"automations-total-count-response"},{"title":"AvgEmailStats","id":"avg-email-stats"},{"title":"Board","id":"board"},{"title":"BoardCount","id":"board-count"},{"title":"BookingData","id":"booking-data"},{"title":"BookingProduct","id":"booking-product"},{"title":"Branch","id":"branch"},{"title":"BranchListQueryResponse","id":"branch-list-query-response"},{"title":"Brand","id":"brand"},{"title":"Callout","id":"callout"},{"title":"Channel","id":"channel"},{"title":"Chat","id":"chat"},{"title":"ChatMessage","id":"chat-message"},{"title":"ChatMessageResponse","id":"chat-message-response"},{"title":"ChatResponse","id":"chat-response"},{"title":"ChatTypingStatusChangedResponse","id":"chat-typing-status-changed-response"},{"title":"ChatUser","id":"chat-user"},{"title":"ChatUserDetails","id":"chat-user-details"},{"title":"Checklist","id":"checklist"},{"title":"ChecklistItem","id":"checklist-item"},{"title":"CheckReport","id":"check-report"},{"title":"ClientPortal","id":"client-portal"},{"title":"ClientPortalComment","id":"client-portal-comment"},{"title":"ClientPortalNotification","id":"client-portal-notification"},{"title":"ClientPortalUser","id":"client-portal-user"},{"title":"clientPortalUsersListResponse","id":"client-portal-users-list-response"},{"title":"ColumnConfigItem","id":"column-config-item"},{"title":"Comment","id":"comment"},{"title":"CommentResponse","id":"comment-response"},{"title":"CompaniesListResponse","id":"companies-list-response"},{"title":"Company","id":"company"},{"title":"Config","id":"config"},{"title":"ConfigDay","id":"config-day"},{"title":"Conformity","id":"conformity"},{"title":"Conversation","id":"conversation"},{"title":"ConversationAdminMessageInsertedResponse","id":"conversation-admin-message-inserted-response"},{"title":"ConversationChangedResponse","id":"conversation-changed-response"},{"title":"ConversationClientTypingStatusChangedResponse","id":"conversation-client-typing-status-changed-response"},{"title":"ConversationDetailResponse","id":"conversation-detail-response"},{"title":"ConversationMessage","id":"conversation-message"},{"title":"ConvertTo","id":"convert-to"},{"title":"Coordinate","id":"coordinate"},{"title":"Customer","id":"customer"},{"title":"CustomerConnectionChangedResponse","id":"customer-connection-changed-response"},{"title":"CustomersListResponse","id":"customers-list-response"},{"title":"Dashboard","id":"dashboard"},{"title":"DashboardItem","id":"dashboard-item"},{"title":"DashboardListResponse","id":"dashboard-list-response"},{"title":"Deal","id":"deal"},{"title":"DealListItem","id":"deal-list-item"},{"title":"DealTotalCurrency","id":"deal-total-currency"},{"title":"DeliveryList","id":"delivery-list"},{"title":"DeliveryReport","id":"delivery-report"},{"title":"Department","id":"department"},{"title":"DepartmentListQueryResponse","id":"department-list-query-response"},{"title":"DeviceConfig","id":"device-config"},{"title":"DeviceConfigsListResponse","id":"device-configs-list-response"},{"title":"Document","id":"document"},{"title":"DocumentEditorAttribute","id":"document-editor-attribute"},{"title":"Donate","id":"donate"},{"title":"DonateCampaign","id":"donate-campaign"},{"title":"DonateMain","id":"donate-main"},{"title":"Email","id":"email"},{"title":"EmailDelivery","id":"email-delivery"},{"title":"EmailDeliveryList","id":"email-delivery-list"},{"title":"EmailTemplate","id":"email-template"},{"title":"EngageData","id":"engage-data"},{"title":"EngageDeliveryReport","id":"engage-delivery-report"},{"title":"EngageLog","id":"engage-log"},{"title":"EngageMessage","id":"engage-message"},{"title":"EngageMessageSms","id":"engage-message-sms"},{"title":"EngageScheduleDate","id":"engage-schedule-date"},{"title":"ENV","id":"env"},{"title":"Error","id":"error"},{"title":"Exm","id":"exm"},{"title":"ExmAppearance","id":"exm-appearance"},{"title":"ExmCeremonyData","id":"exm-ceremony-data"},{"title":"ExmEventData","id":"exm-event-data"},{"title":"ExmFeature","id":"exm-feature"},{"title":"ExmFeed","id":"exm-feed"},{"title":"ExmFeedResponse","id":"exm-feed-response"},{"title":"ExmList","id":"exm-list"},{"title":"ExmThank","id":"exm-thank"},{"title":"ExmThankResponse","id":"exm-thank-response"},{"title":"ExmWelcomeContent","id":"exm-welcome-content"},{"title":"ExportHistory","id":"export-history"},{"title":"ExportHistoryList","id":"export-history-list"},{"title":"FacebookComment","id":"facebook-comment"},{"title":"FacebookConversationMessage","id":"facebook-conversation-message"},{"title":"FacebookCustomer","id":"facebook-customer"},{"title":"FacebookPost","id":"facebook-post"},{"title":"Field","id":"field"},{"title":"FieldsGroup","id":"fields-group"},{"title":"Form","id":"form"},{"title":"FormCode","id":"form-code"},{"title":"FormConnectResponse","id":"form-connect-response"},{"title":"FormSubmission","id":"form-submission"},{"title":"GrowthHack","id":"growth-hack"},{"title":"IMap","id":"i-map"},{"title":"IMapIntegration","id":"i-map-integration"},{"title":"ImportHistory","id":"import-history"},{"title":"ImportHistoryList","id":"import-history-list"},{"title":"InboxField","id":"inbox-field"},{"title":"Integration","id":"integration"},{"title":"integrationsGetUsedTypes","id":"integrations-get-used-types"},{"title":"integrationsTotalCount","id":"integrations-total-count"},{"title":"InternalNote","id":"internal-note"},{"title":"InternalNotesByAction","id":"internal-notes-by-action"},{"title":"Invoice","id":"invoice"},{"title":"invoicesTotalCount","id":"invoices-total-count"},{"title":"ItemSourceLocation","id":"item-source-location"},{"title":"IUserAbsenceInfo","id":"iuser-absence-info"},{"title":"KnowledgebaseApp","id":"knowledgebase-app"},{"title":"KnowledgeBaseArticle","id":"knowledge-base-article"},{"title":"KnowledgeBaseCategory","id":"knowledge-base-category"},{"title":"KnowledgeBaseLoader","id":"knowledge-base-loader"},{"title":"KnowledgeBaseParentCategory","id":"knowledge-base-parent-category"},{"title":"KnowledgeBaseTopic","id":"knowledge-base-topic"},{"title":"LeadApp","id":"lead-app"},{"title":"List","id":"list"},{"title":"LocationOption","id":"location-option"},{"title":"Log","id":"log"},{"title":"Logic","id":"logic"},{"title":"LogList","id":"log-list"},{"title":"Lottery","id":"lottery"},{"title":"LotteryCampaign","id":"lottery-campaign"},{"title":"LotteryMain","id":"lottery-main"},{"title":"Loyalty","id":"loyalty"},{"title":"LoyaltyConfig","id":"loyalty-config"},{"title":"MailAttachment","id":"mail-attachment"},{"title":"MailConfig","id":"mail-config"},{"title":"MailData","id":"mail-data"},{"title":"ManualVerificationConfig","id":"manual-verification-config"},{"title":"MessengerApp","id":"messenger-app"},{"title":"MessengerAppsResponse","id":"messenger-apps-response"},{"title":"MessengerConnectResponse","id":"messenger-connect-response"},{"title":"MessengerSupportersResponse","id":"messenger-supporters-response"},{"title":"ModifiedNote","id":"modified-note"},{"title":"Movement","id":"movement"},{"title":"MovementItem","id":"movement-item"},{"title":"Notification","id":"notification"},{"title":"NotificationConfig","id":"notification-config"},{"title":"NotificationConfiguration","id":"notification-configuration"},{"title":"ObjectListConfig","id":"object-list-config"},{"title":"OnboardingGetAvailableFeaturesResponse","id":"onboarding-get-available-features-response"},{"title":"OnboardingHistory","id":"onboarding-history"},{"title":"OnboardingNotification","id":"onboarding-notification"},{"title":"OTPConfig","id":"otp-config"},{"title":"PayDate","id":"pay-date"},{"title":"Payment","id":"payment"},{"title":"PaymentConfig","id":"payment-config"},{"title":"PaymentConfigList","id":"payment-config-list"},{"title":"paymentsTotalCount","id":"payments-total-count"},{"title":"Permission","id":"permission"},{"title":"PermissionAction","id":"permission-action"},{"title":"PermissionModule","id":"permission-module"},{"title":"Pipeline","id":"pipeline"},{"title":"PipelineChangeResponse","id":"pipeline-change-response"},{"title":"PipelineLabel","id":"pipeline-label"},{"title":"PipelineTemplate","id":"pipeline-template"},{"title":"PipelineTemplateStage","id":"pipeline-template-stage"},{"title":"Product","id":"product"},{"title":"ProductCategory","id":"product-category"},{"title":"ProductsConfig","id":"products-config"},{"title":"Report","id":"report"},{"title":"ReportsListResponse","id":"reports-list-response"},{"title":"RequestsListResponse","id":"requests-list-response"},{"title":"ResponseTemplate","id":"response-template"},{"title":"RobotEntry","id":"robot-entry"},{"title":"Rule","id":"rule"},{"title":"SaveFormResponse","id":"save-form-response"},{"title":"Schedule","id":"schedule"},{"title":"ScheduleConfig","id":"schedule-config"},{"title":"ScheduleReport","id":"schedule-report"},{"title":"SchedulesListResponse","id":"schedules-list-response"},{"title":"SchemaField","id":"schema-field"},{"title":"ScoreLog","id":"score-log"},{"title":"Script","id":"script"},{"title":"SeenInfo","id":"seen-info"},{"title":"Segment","id":"segment"},{"title":"ShiftsRequest","id":"shifts-request"},{"title":"Skill","id":"skill"},{"title":"SkillType","id":"skill-type"},{"title":"SmsDelivery","id":"sms-delivery"},{"title":"SmsStatus","id":"sms-status"},{"title":"Spin","id":"spin"},{"title":"SpinCampaign","id":"spin-campaign"},{"title":"SpinMain","id":"spin-main"},{"title":"Stage","id":"stage"},{"title":"Structure","id":"structure"},{"title":"Styles","id":"styles"},{"title":"Submission","id":"submission"},{"title":"SuccessResult","id":"success-result"},{"title":"Tag","id":"tag"},{"title":"Task","id":"task"},{"title":"TaskListItem","id":"task-list-item"},{"title":"Ticket","id":"ticket"},{"title":"TicketListItem","id":"ticket-list-item"},{"title":"Timeclock","id":"timeclock"},{"title":"TimeClocksListResponse","id":"time-clocks-list-response"},{"title":"Timelog","id":"timelog"},{"title":"TimelogListResponse","id":"timelog-list-response"},{"title":"TimeTrack","id":"time-track"},{"title":"TotalForType","id":"total-for-type"},{"title":"Trigger","id":"trigger"},{"title":"Unit","id":"unit"},{"title":"UnitListQueryResponse","id":"unit-list-query-response"},{"title":"Uom","id":"uom"},{"title":"User","id":"user"},{"title":"UserConversationListResponse","id":"user-conversation-list-response"},{"title":"UserDetailsType","id":"user-details-type"},{"title":"UserMovement","id":"user-movement"},{"title":"UserNotificationSettings","id":"user-notification-settings"},{"title":"UserReport","id":"user-report"},{"title":"UsersGroup","id":"users-group"},{"title":"UserStatus","id":"user-status"},{"title":"VerificationRequest","id":"verification-request"},{"title":"VideoCallData","id":"video-call-data"},{"title":"Voucher","id":"voucher"},{"title":"VoucherCampaign","id":"voucher-campaign"},{"title":"VoucherMain","id":"voucher-main"},{"title":"WebbuilderContentType","id":"webbuilder-content-type"},{"title":"WebbuilderContentTypesList","id":"webbuilder-content-types-list"},{"title":"WebbuilderEntriesList","id":"webbuilder-entries-list"},{"title":"WebbuilderEntry","id":"webbuilder-entry"},{"title":"WebbuilderPage","id":"webbuilder-page"},{"title":"WebbuilderPagesList","id":"webbuilder-pages-list"},{"title":"WebbuilderSite","id":"webbuilder-site"},{"title":"WebbuilderTemplate","id":"webbuilder-template"},{"title":"WebSiteApp","id":"web-site-app"},{"title":"Zalo","id":"zalo"},{"title":"ZaloAccount","id":"zalo-account"},{"title":"ZaloAttachmentPayload","id":"zalo-attachment-payload"},{"title":"ZaloAttachments","id":"zalo-attachments"},{"title":"ZaloConversationMessage","id":"zalo-conversation-message"}],"/authentication/graphql/input":[{"title":"ActionInput","id":"action-input"},{"title":"AttachmentInput","id":"attachment-input"},{"title":"BookingStyleInput","id":"booking-style-input"},{"title":"ClientPortalUserUpdate","id":"client-portal-user-update"},{"title":"ConversationMessageParams","id":"conversation-message-params"},{"title":"CoordinateInput","id":"coordinate-input"},{"title":"EmailSignature","id":"email-signature"},{"title":"EngageMessageSmsInput","id":"engage-message-sms-input"},{"title":"EngageMessageEmail","id":"engage-message-email"},{"title":"EngageMessageMessenger","id":"engage-message-messenger"},{"title":"EngageScheduleDateInput","id":"engage-schedule-date-input"},{"title":"EventAttributeFilter","id":"event-attribute-filter"},{"title":"ExmAppearanceInput","id":"exm-appearance-input"},{"title":"ExmEventDataInput","id":"exm-event-data-input"},{"title":"ExmFeatureInput","id":"exm-feature-input"},{"title":"ExmWelcomeContentInput","id":"exm-welcome-content-input"},{"title":"FieldItem","id":"field-item"},{"title":"FieldValueInput","id":"field-value-input"},{"title":"FormCodeInput","id":"form-code-input"},{"title":"FormSubmissionInput","id":"form-submission-input"},{"title":"IMovementItem","id":"i-movement-item"},{"title":"InputRule","id":"input-rule"},{"title":"IntegrationBookingData","id":"integration-booking-data"},{"title":"IntegrationLinks","id":"integration-links"},{"title":"IntegrationLeadData","id":"integration-lead-data"},{"title":"IntegrationMessengerData","id":"integration-messenger-data"},{"title":"Interval","id":"interval"},{"title":"ItemDate","id":"item-date"},{"title":"InvitationEntry","id":"invitation-entry"},{"title":"KnowledgeBaseArticleDoc","id":"knowledge-base-article-doc"},{"title":"KnowledgeBaseCategoryDoc","id":"knowledge-base-category-doc"},{"title":"KnowledgeBaseMessengerAppInput","id":"knowledge-base-messenger-app-input"},{"title":"KnowledgeBaseTopicDoc","id":"knowledge-base-topic-doc"},{"title":"LeadMessengerAppInput","id":"lead-messenger-app-input"},{"title":"LocationOptionInput","id":"location-option-input"},{"title":"LogicInput","id":"logic-input"},{"title":"MailConfigInput","id":"mail-config-input"},{"title":"MessengerAppsInput","id":"messenger-apps-input"},{"title":"MessengerOnlineHoursSchema","id":"messenger-online-hours-schema"},{"title":"MessengerUiOptions","id":"messenger-ui-options"},{"title":"NotificationConfigInput","id":"notification-config-input"},{"title":"objectListConfigInput","id":"object-list-config-input"},{"title":"OrderItem","id":"order-item"},{"title":"OTPConfigInput","id":"otp-config-input"},{"title":"PipelineTemplateStageInput","id":"pipeline-template-stage-input"},{"title":"ProductField","id":"product-field"},{"title":"SegmentCondition","id":"segment-condition"},{"title":"StylesParams","id":"styles-params"},{"title":"ShiftsRequestInput","id":"shifts-request-input"},{"title":"SubmissionFilter","id":"submission-filter"},{"title":"SubSegment","id":"sub-segment"},{"title":"TriggerInput","id":"trigger-input"},{"title":"UserDetails","id":"user-details"},{"title":"WebSiteMessengerAppInput","id":"web-site-messenger-app-input"}],"/authentication/graphql/scalars":[{"title":"Boolean","id":"boolean"},{"title":"Date","id":"date"},{"title":"Float","id":"float"},{"title":"Int","id":"int"},{"title":"JSON","id":"json"},{"title":"String","id":"string"}],"/quickstart/deployment":[],"/authentication/graphql/mutations":[],"/authentication/graphql/queries":[{"title":"absenceDetail","id":"absence-detail"},{"title":"ActionInput","id":"action-input"},{"title":"absenceTypes","id":"absence-types"},{"title":"activeMe","id":"active-me"},{"title":"activityLogs","id":"activity-logs"},{"title":"activityLogsByAction","id":"activity-logs-by-action"},{"title":"allBrands","id":"all-brands"},{"title":"allLeadIntegrations","id":"all-lead-integrations"},{"title":"allUsers","id":"all-users"},{"title":"BookingStyleInput","id":"booking-style-input"},{"title":"ClientPortalUserUpdate","id":"client-portal-user-update"},{"title":"ConversationMessageParams","id":"conversation-message-params"},{"title":"CoordinateInput","id":"coordinate-input"},{"title":"EmailSignature","id":"email-signature"},{"title":"EngageMessageSmsInput","id":"engage-message-sms-input"},{"title":"EngageMessageEmail","id":"engage-message-email"},{"title":"EngageMessageMessenger","id":"engage-message-messenger"},{"title":"EngageScheduleDateInput","id":"engage-schedule-date-input"},{"title":"EventAttributeFilter","id":"event-attribute-filter"},{"title":"ExmAppearanceInput","id":"exm-appearance-input"},{"title":"ExmEventDataInput","id":"exm-event-data-input"},{"title":"ExmFeatureInput","id":"exm-feature-input"},{"title":"ExmWelcomeContentInput","id":"exm-welcome-content-input"},{"title":"FieldItem","id":"field-item"},{"title":"FieldValueInput","id":"field-value-input"},{"title":"FormCodeInput","id":"form-code-input"},{"title":"FormSubmissionInput","id":"form-submission-input"},{"title":"IMovementItem","id":"i-movement-item"},{"title":"InputRule","id":"input-rule"},{"title":"IntegrationBookingData","id":"integration-booking-data"},{"title":"IntegrationLinks","id":"integration-links"},{"title":"IntegrationLeadData","id":"integration-lead-data"},{"title":"IntegrationMessengerData","id":"integration-messenger-data"},{"title":"Interval","id":"interval"},{"title":"ItemDate","id":"item-date"},{"title":"InvitationEntry","id":"invitation-entry"},{"title":"KnowledgeBaseArticleDoc","id":"knowledge-base-article-doc"},{"title":"KnowledgeBaseCategoryDoc","id":"knowledge-base-category-doc"},{"title":"KnowledgeBaseMessengerAppInput","id":"knowledge-base-messenger-app-input"},{"title":"KnowledgeBaseTopicDoc","id":"knowledge-base-topic-doc"},{"title":"LeadMessengerAppInput","id":"lead-messenger-app-input"},{"title":"LocationOptionInput","id":"location-option-input"},{"title":"LogicInput","id":"logic-input"},{"title":"MailConfigInput","id":"mail-config-input"},{"title":"MessengerAppsInput","id":"messenger-apps-input"},{"title":"MessengerOnlineHoursSchema","id":"messenger-online-hours-schema"},{"title":"MessengerUiOptions","id":"messenger-ui-options"},{"title":"NotificationConfigInput","id":"notification-config-input"},{"title":"objectListConfigInput","id":"object-list-config-input"},{"title":"OrderItem","id":"order-item"},{"title":"OTPConfigInput","id":"otp-config-input"},{"title":"PipelineTemplateStageInput","id":"pipeline-template-stage-input"},{"title":"ProductField","id":"product-field"},{"title":"SegmentCondition","id":"segment-condition"},{"title":"StylesParams","id":"styles-params"},{"title":"ShiftsRequestInput","id":"shifts-request-input"},{"title":"SubmissionFilter","id":"submission-filter"},{"title":"SubSegment","id":"sub-segment"},{"title":"TriggerInput","id":"trigger-input"},{"title":"UserDetails","id":"user-details"},{"title":"WebSiteMessengerAppInput","id":"web-site-messenger-app-input"}],"/authentication/graphql/intro":[],"/authentication/reference/ui":[],"/sdks/createinte":[{"title":"Create an integration","id":"create-an-integration"},{"title":"Receive data from your desired APIs","id":"receive-data-from-your-desired-apis"},{"title":"Store the data","id":"store-the-data"},{"title":"Conversation detail","id":"conversation-detail"},{"title":"API file structure","id":"api-file-structure"},{"title":"Main files","id":"main-files"},{"title":"configs.ts","id":"configs-ts"},{"title":"controller.ts","id":"controller-ts"},{"title":"messageBroker.ts","id":"message-broker-ts"},{"title":"GraphQL development","id":"graph-ql-development"},{"title":"GraphQL resolvers","id":"graph-ql-resolvers"},{"title":"GraphQL typeDefs","id":"graph-ql-type-defs"},{"title":"Database development","id":"database-development"},{"title":"Mongoose schema and model","id":"mongoose-schema-and-model"},{"title":"UI file structure","id":"ui-file-structure"},{"title":"Running port for plugin","id":"running-port-for-plugin"},{"title":"Enabling plugins","id":"enabling-plugins"}],"/groups/products/exm":[{"title":"Employee Experience Management","id":"employee-experience-management"},{"title":"Centralized complete HR database","id":"centralized-complete-hr-database"},{"title":"Knowledge, onboarding & training campaign","id":"knowledge-onboarding-and-training-campaign"},{"title":"Automatically generated HR templates","id":"automatically-generated-hr-templates"},{"title":"Fully customizable recruitment pipeline","id":"fully-customizable-recruitment-pipeline"},{"title":"The next generation of time-tracking system","id":"the-next-generation-of-time-tracking-system"},{"title":"Clear view of employee productivity","id":"clear-view-of-employee-productivity"},{"title":"Employee feed & Communication","id":"employee-feed-and-communication"},{"title":"Quick and efficient asset record","id":"quick-and-efficient-asset-record"}],"/quickstart/groups":[],"/requirement/customer/finance":[],"/authentication/reference/api":[{"title":"Common functions","id":"common-functions"}],"/requirement/customer/marketing":[],"/requirement/customer/sales":[],"/requirement/employee/attendance":[],"/requirement/employee/database":[],"/requirement/employee/engagement":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/sdks/creategen":[{"title":"GraphQL development","id":"graph-ql-development"},{"title":"UI file structure","id":"ui-file-structure"},{"title":"Main files","id":"main-files"},{"title":"UI development","id":"ui-development"},{"title":"Running port for plugin","id":"running-port-for-plugin"},{"title":"Location for plugin","id":"location-for-plugin"},{"title":"Enabling plugins","id":"enabling-plugins"}],"/requirement/customer/frontline":[],"/groups/products/script":[{"title":"Script Installation","id":"script-installation"}],"/requirement/employee/learning":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/employee/reports":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/employee/structure":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/quickstart/deployment/deploymentDockerCompose":[{"title":"Perquisite","id":"perquisite"},{"title":"Summarize of the progress","id":"summarize-of-the-progress"}],"/authentication/reference/ui/attachment":[{"title":"Example","id":"example"},{"title":"Size","id":"size"},{"title":"Additional item","id":"additional-item"},{"title":"Image","id":"image"},{"title":"Video","id":"video"},{"title":"Audio","id":"audio"},{"title":"Multiple attachments","id":"multiple-attachments"},{"title":"Index","id":"index"},{"title":"API","id":"api"}],"/authentication/reference/ui/avatar":[{"title":"Default avatar","id":"default-avatar"},{"title":"Avatar","id":"avatar"},{"title":"API","id":"api"}],"/authentication/reference/ui/box":[{"title":"Title","id":"title"},{"title":"State","id":"state"},{"title":"Collapsible","id":"collapsible"},{"title":"Extra buttons","id":"extra-buttons"},{"title":"API","id":"api"}],"/authentication/reference/ui/animated":[{"title":"Height and width","id":"height-and-width"},{"title":"Color","id":"color"},{"title":"Round","id":"round"},{"title":"Box","id":"box"},{"title":"With image","id":"with-image"},{"title":"API","id":"api"}],"/authentication/reference/ui/buttons":[{"title":"Examples","id":"examples"},{"title":"API","id":"api"}],"/authentication/reference/ui/chip":[{"title":"Examples","id":"examples"},{"title":"Capitalized","id":"capitalized"},{"title":"Front Content","id":"front-content"},{"title":"API","id":"api"}],"/authentication/reference/ui/collapse":[{"title":"Simple","id":"simple"},{"title":"Description","id":"description"},{"title":"Image","id":"image"},{"title":"Image background color","id":"image-background-color"},{"title":"Before title","id":"before-title"},{"title":"ContendId","id":"contend-id"},{"title":"Compact","id":"compact"},{"title":"Open","id":"open"},{"title":"** API**","id":"api"}],"/quickstart/deployment/deploymentDocker":[{"title":"Create an erxes user on the instance","id":"create-an-erxes-user-on-the-instance"},{"title":"Installation steps","id":"installation-steps"}],"/authentication/reference/ui/divider":[{"title":"Example","id":"example"},{"title":"API","id":"api"}],"/requirement/employee/user":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/authentication/reference/ui/data":[{"title":"Loading","id":"loading"},{"title":"Count","id":"count"},{"title":"Empty content","id":"empty-content"},{"title":"Empty state","id":"empty-state"},{"title":"Image","id":"image"},{"title":"API","id":"api"}],"/authentication/reference/ui/breadcrumb":[{"title":"Example","id":"example"},{"title":"API","id":"api"}],"/authentication/reference/ui/econtent":[{"title":"Steps","id":"steps"},{"title":"Button","id":"button"},{"title":"Button text","id":"button-text"},{"title":"isOutside","id":"is-outside"},{"title":"Icon","id":"icon"},{"title":"Title","id":"title"},{"title":"Url","id":"url"},{"title":"Vertical","id":"vertical"},{"title":"Max width","id":"max-width"},{"title":"API","id":"api"}],"/authentication/reference/ui/error":[{"title":"Example","id":"example"},{"title":"API","id":"api"}],"/authentication/reference/ui/filterable":[{"title":"Example","id":"example"},{"title":"Blank filterable list","id":"blank-filterable-list"},{"title":"Loading","id":"loading"},{"title":"Custom style","id":"custom-style"},{"title":"Avatar","id":"avatar"},{"title":"Additional icon","id":"additional-icon"},{"title":"Links","id":"links"},{"title":"Show Checkmark","id":"show-checkmark"},{"title":"Tree view","id":"tree-view"},{"title":"API","id":"api"}],"/authentication/reference/ui/header":[{"title":"Example","id":"example"},{"title":"API","id":"api"}],"/authentication/reference/ui/help":[{"title":"API","id":"api"}],"/authentication/reference/ui/estate":[{"title":"Light","id":"light"},{"title":"Icon size","id":"icon-size"},{"title":"Image","id":"image"},{"title":"Extra","id":"extra"},{"title":"API","id":"api"}],"/authentication/reference/ui/info":[{"title":"Examples","id":"examples"},{"title":"Icon","id":"icon"},{"title":"API","id":"api"}],"/authentication/reference/ui/label":[{"title":"Style","id":"style"},{"title":"Color","id":"color"},{"title":"API","id":"api"}],"/authentication/reference/ui/modifiable":[{"title":"Options","id":"options"},{"title":"Add button label","id":"add-button-label"},{"title":"API","id":"api"}],"/authentication/reference/ui/namecard":[{"title":"Username","id":"username"},{"title":"Full name","id":"full-name"},{"title":"Avatar size","id":"avatar-size"},{"title":"User E-mail","id":"user-e-mail"},{"title":"Single Line","id":"single-line"},{"title":"Second line","id":"second-line"},{"title":"API","id":"api"}],"/authentication/reference/ui/progress":[{"title":"Percentage","id":"percentage"},{"title":"Color","id":"color"},{"title":"Height","id":"height"},{"title":"**Close","id":"close"},{"title":"API","id":"api"}],"/authentication/reference/ui/sort":[{"title":"Label","id":"label"},{"title":"Field","id":"field"},{"title":"API","id":"api"}],"/authentication/reference/ui/spinner":[{"title":"Examples","id":"examples"},{"title":"Position","id":"position"},{"title":"Objective","id":"objective"},{"title":"API","id":"api"}],"/authentication/reference/ui/steps":[{"title":"Example","id":"example"},{"title":"Active","id":"active"},{"title":"Step","id":"step"},{"title":"Title","id":"title"},{"title":"No button","id":"no-button"},{"title":"API","id":"api"},{"title":"Step","id":"step-2"}],"/authentication/reference/ui/sub":[{"title":"Example","id":"example"},{"title":"Additional item","id":"additional-item"},{"title":"API","id":"api"}],"/authentication/reference/ui/table":[{"title":"Bordered","id":"bordered"},{"title":"Striped","id":"striped"},{"title":"Table hover","id":"table-hover"},{"title":"White-space","id":"white-space"},{"title":"API","id":"api"}],"/authentication/reference/ui/tabs":[{"title":"Dynamic tabbed interfaces.","id":"dynamic-tabbed-interfaces"},{"title":"Example","id":"example"},{"title":"Full","id":"full"},{"title":"Border","id":"border"},{"title":"API","id":"api"},{"title":"TabTitle","id":"tab-title"}],"/authentication/reference/ui/tags":[{"title":"Color","id":"color"},{"title":"Limit","id":"limit"},{"title":"API","id":"api"}],"/authentication/reference/ui/filter":[{"title":"Example","id":"example"},{"title":"Empty","id":"empty"},{"title":"Loading","id":"loading"},{"title":"Count","id":"count"},{"title":"Multiple","id":"multiple"},{"title":"Searchable","id":"searchable"},{"title":"Icon","id":"icon"},{"title":"Color","id":"color"},{"title":"Tree view","id":"tree-view"},{"title":"Related","id":"related"},{"title":"API","id":"api"}],"/authentication/reference/ui/text":[{"title":"Types","id":"types"},{"title":"Size","id":"size"},{"title":"API","id":"api"}],"/authentication/reference/ui/timer":[{"title":"Completed time tracking","id":"completed-time-tracking"},{"title":"Started time tracking","id":"started-time-tracking"},{"title":"Paused time tracking","id":"paused-time-tracking"},{"title":"Stopped time tracking","id":"stopped-time-tracking"},{"title":"API","id":"api"}],"/authentication/reference/ui/icon":[{"title":"Color","id":"color"},{"title":"Size","id":"size"},{"title":"Active","id":"active"},{"title":"API","id":"api"}],"/authentication/reference/ui/tip":[{"title":"Tip text","id":"tip-text"},{"title":"Placement","id":"placement"},{"title":"API","id":"api"}],"/authentication/reference/ui/toggle":[{"title":"Example","id":"example"},{"title":"Icons","id":"icons"},{"title":"Checked","id":"checked"},{"title":"Always checked","id":"always-checked"},{"title":"Disabled toggle switch","id":"disabled-toggle-switch"},{"title":"API","id":"api"}],"/authentication/reference/ui/uploader":[{"title":"Multiple","id":"multiple"},{"title":"Limit","id":"limit"},{"title":"Single","id":"single"},{"title":"Default files","id":"default-files"},{"title":"API","id":"api"}],"/quickstart/groups/mac":[{"title":"If your browser don't automatically jump to localhost:3000, you should check logs by using these commands.","id":"if-your-browser-dont-automatically-jump-to-localhost-3000-you-should-check-logs-by-using-these-commands"},{"title":"If you see this screen, you have successfully install erxes XOS. Congratulations πŸŽ‰πŸŽ‰πŸŽ‰","id":"if-you-see-this-screen-you-have-successfully-install-erxes-xos-congratulations"}],"/authentication/reference/ui/file":[{"title":"Default file preview","id":"default-file-preview"},{"title":"File preview","id":"file-preview"},{"title":"Picture and Video preview","id":"picture-and-video-preview"},{"title":"API","id":"api"}],"/quickstart/groups/ubuntu":[{"title":"Installing dependencies using docker","id":"installing-dependencies-using-docker"},{"title":"If your browser don't automatically jump to localhost:3000, you should check logs by using these commands.","id":"if-your-browser-dont-automatically-jump-to-localhost-3000-you-should-check-logs-by-using-these-commands"},{"title":"If you see this screen, you have successfully install erxes XOS. Congratulations πŸŽ‰πŸŽ‰πŸŽ‰","id":"if-you-see-this-screen-you-have-successfully-install-erxes-xos-congratulations"}],"/requirement/customer/finance/rental":[],"/requirement/customer/marketing/newsletter":[],"/requirement/customer/sales/b2bs":[],"/requirement/customer/sales/catering":[],"/requirement/customer/finance/payment":[],"/requirement/customer/marketing/survey":[],"/requirement/customer/sales/pos":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/schedule":[],"/requirement/customer/frontline/callcenter":[],"/requirement/customer/frontline/chatbot":[],"/requirement/customer/finance/leasing":[],"/requirement/customer/frontline/help":[],"/requirement/customer/sales/ecommerce":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/pos/erkhet":[],"/requirement/customer/sales/pos/inventory":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/pos/management":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/pos/menu":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/pos/payment":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/pos/coffeeshop":[],"/requirement/customer/sales/pos/processing":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/pos/reporting":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/pos/restaurant":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/frontline/ticket":[],"/requirement/customer/sales/pos/retail":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/ecommerce/order":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/ecommerce/product":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/ecommerce/promotions":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/ecommerce/shopping":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/ecommerce/user":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/ecommerce/customer":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/ecommerce/payment":[{"title":"Architecture","id":"architecture"},{"title":"Frequently Asked Questions","id":"faq"}],"/requirement/customer/sales/order":[]},"children":["$","$L7",null,{"parallelRouterKey":"children","segmentPath":["children"],"error":"$undefined","errorStyles":"$undefined","loading":"$undefined","loadingStyles":"$undefined","hasLoading":false,"template":["$","$L8",null,{}],"templateStyles":"$undefined","notFound":[["$","div",null,{"className":"absolute inset-0 -z-10 mx-0 max-w-none overflow-hidden","children":["$","div",null,{"className":"absolute left-1/2 top-0 ml-[-38rem] h-[25rem] w-[81.25rem] dark:[mask-image:linear-gradient(white,transparent)]","children":[["$","div",null,{"className":"absolute inset-0 bg-gradient-to-r from-[#4c1d95] to-[#c7d2fe] opacity-40 [mask-image:radial-gradient(farthest-side_at_top,gray,transparent)] dark:from-[#4c1d95]/30 dark:to-[#c7d2fe]/30 dark:opacity-100","children":["$","svg",null,{"aria-hidden":"true","className":"absolute inset-x-0 inset-y-[-50%] h-[200%] w-full skew-y-[-18deg] fill-black/40 stroke-black/50 mix-blend-overlay dark:fill-white/2.5 dark:stroke-white/5","children":[["$","defs",null,{"children":["$","pattern",null,{"id":":S1:","width":72,"height":56,"patternUnits":"userSpaceOnUse","x":-12,"y":4,"children":["$","path",null,{"d":"M.5 56V.5H72","fill":"none"}]}]}],["$","rect",null,{"width":"100%","height":"100%","strokeWidth":0,"fill":"url(#:S1:)"}],["$","svg",null,{"x":-12,"y":4,"className":"overflow-visible","children":[["$","rect","4-3",{"strokeWidth":"0","width":73,"height":57,"x":288,"y":168}],["$","rect","2-1",{"strokeWidth":"0","width":73,"height":57,"x":144,"y":56}],["$","rect","7-3",{"strokeWidth":"0","width":73,"height":57,"x":504,"y":168}],["$","rect","10-6",{"strokeWidth":"0","width":73,"height":57,"x":720,"y":336}]]}]]}]}],["$","svg",null,{"viewBox":"0 0 1113 440","aria-hidden":"true","className":"absolute left-1/2 top-0 ml-[-19rem] w-[69.5625rem] fill-white blur-[26px] dark:hidden","children":["$","path",null,{"d":"M.016 439.5s-9.5-300 434-300S882.516 20 882.516 20V0h230.004v439.5H.016Z"}]}]]}]}],["$","div",null,{"className":"mx-auto flex h-full max-w-xl flex-col items-center justify-center py-16 text-center","children":[["$","p",null,{"className":"text-sm font-semibold text-zinc-900 dark:text-white","children":"404"}],["$","h1",null,{"className":"mt-2 text-2xl font-bold text-zinc-900 dark:text-white","children":"Page not found"}],["$","p",null,{"className":"mt-2 text-base text-zinc-600 dark:text-zinc-400","children":"Sorry, we couldn’t find the page you’re looking for."}],["$","$L9",null,{"className":"inline-flex gap-0.5 justify-center overflow-hidden text-sm font-medium transition rounded-full bg-zinc-900 py-1 px-3 text-white hover:bg-zinc-700 dark:bg-violet-400/10 dark:text-violet-400 dark:ring-1 dark:ring-inset dark:ring-violet-400/20 dark:hover:bg-violet-400/10 dark:hover:text-violet-300 dark:hover:ring-violet-300 mt-8","href":"/","children":[false,"Back to docs",["$","svg",null,{"viewBox":"0 0 20 20","fill":"none","aria-hidden":"true","className":"mt-0.5 h-5 w-5 -mr-1","children":["$","path",null,{"stroke":"currentColor","strokeLinecap":"round","strokeLinejoin":"round","d":"m11.5 6.5 3 3.5m0 0-3 3.5m3-3.5h-9"}]}]]}]]}]],"notFoundStyles":[],"childProp":{"current":["$","$L7",null,{"parallelRouterKey":"children","segmentPath":["children","quickstart","children"],"error":"$undefined","errorStyles":"$undefined","loading":"$undefined","loadingStyles":"$undefined","hasLoading":false,"template":["$","$L8",null,{}],"templateStyles":"$undefined","notFound":"$undefined","notFoundStyles":"$undefined","childProp":{"current":["$","$L7",null,{"parallelRouterKey":"children","segmentPath":["children","quickstart","children","groups","children"],"error":"$undefined","errorStyles":"$undefined","loading":"$undefined","loadingStyles":"$undefined","hasLoading":false,"template":["$","$L8",null,{}],"templateStyles":"$undefined","notFound":"$undefined","notFoundStyles":"$undefined","childProp":{"current":["$","$L7",null,{"parallelRouterKey":"children","segmentPath":["children","quickstart","children","groups","children","ubuntu","children"],"error":"$undefined","errorStyles":"$undefined","loading":"$undefined","loadingStyles":"$undefined","hasLoading":false,"template":["$","$L8",null,{}],"templateStyles":"$undefined","notFound":"$undefined","notFoundStyles":"$undefined","childProp":{"current":["$La",["$","article",null,{"className":"flex h-full flex-col pb-10 pt-16","children":[["$","div",null,{"className":"flex-auto prose dark:prose-invert [html_:where(&>*)]:mx-auto [html_:where(&>*)]:max-w-2xl [html_:where(&>*)]:lg:mx-[calc(50%-min(50%,theme(maxWidth.lg)))] [html_:where(&>*)]:lg:max-w-3xl","children":[["$","div",null,{"className":"absolute inset-0 -z-10 mx-0 max-w-none overflow-hidden","children":["$","div",null,{"className":"absolute left-1/2 top-0 ml-[-38rem] h-[25rem] w-[81.25rem] dark:[mask-image:linear-gradient(white,transparent)]","children":[["$","div",null,{"className":"absolute inset-0 bg-gradient-to-r from-[#4c1d95] to-[#c7d2fe] opacity-40 [mask-image:radial-gradient(farthest-side_at_top,gray,transparent)] dark:from-[#4c1d95]/30 dark:to-[#c7d2fe]/30 dark:opacity-100","children":["$","svg",null,{"aria-hidden":"true","className":"absolute inset-x-0 inset-y-[-50%] h-[200%] w-full skew-y-[-18deg] fill-black/40 stroke-black/50 mix-blend-overlay dark:fill-white/2.5 dark:stroke-white/5","children":[["$","defs",null,{"children":["$","pattern",null,{"id":":S2:","width":72,"height":56,"patternUnits":"userSpaceOnUse","x":-12,"y":4,"children":["$","path",null,{"d":"M.5 56V.5H72","fill":"none"}]}]}],["$","rect",null,{"width":"100%","height":"100%","strokeWidth":0,"fill":"url(#:S2:)"}],["$","svg",null,{"x":-12,"y":4,"className":"overflow-visible","children":[["$","rect","4-3",{"strokeWidth":"0","width":73,"height":57,"x":288,"y":168}],["$","rect","2-1",{"strokeWidth":"0","width":73,"height":57,"x":144,"y":56}],["$","rect","7-3",{"strokeWidth":"0","width":73,"height":57,"x":504,"y":168}],["$","rect","10-6",{"strokeWidth":"0","width":73,"height":57,"x":720,"y":336}]]}]]}]}],["$","svg",null,{"viewBox":"0 0 1113 440","aria-hidden":"true","className":"absolute left-1/2 top-0 ml-[-19rem] w-[69.5625rem] fill-white blur-[26px] dark:hidden","children":["$","path",null,{"d":"M.016 439.5s-9.5-300 434-300S882.516 20 882.516 20V0h230.004v439.5H.016Z"}]}]]}]}],"\n",["$","h1",null,{"children":"Local installation on Ubuntu"}],"\n",["$","p",null,{"children":["The following documentation will guide you through the installation of an erxes project using ",["$","$L9",null,{"href":"https://www.docker.com/","children":"Docker"}]," on ",["$","$L9",null,{"href":"https://ubuntu.com/","children":"Ubuntu."}]]}],"\n",["$","p",null,{"children":"Docker is an open platform that allows to develop, ship and run applications by using containers (i.e. packages containing all the parts an application needs to function, such as libraries and dependencies)."}],"\n",["$","h1",null,{"children":"Preparing the installation"}],"\n",["$","hr",null,{}],"\n",["$","p",null,{"children":"erxes installation requires at least four software prerequisites to be already installed on your computer:"}],"\n",["$","div",null,{"className":"text-base my-3 flex flex-col border-l-4 border-amber-500 bg-amber-100 p-4 leading-6 text-amber-950 dark:border-amber-500 dark:bg-amber-200 dark:text-amber-950 dark:[--tw-prose-links-hover:theme(colors.amber.300)] dark:[--tw-prose-links:theme(colors.amber)]","children":[["$","p",null,{"className":"text-lg p-0 mt-0 mb-2 font-bold text-amber-500 dark:text-amber-500","children":"βœ‹ Caution"}],["$","div",null,{"className":"[&>:first-child]:mt-0 [&>:last-child]:mb-0","children":["$","p",null,{"children":"Erxes code takes approximately 12GB storage space, make sure you have enough space in your device before going forward."}]}]]}],"\n",["$","h1",null,{"children":"Prerequisites"}],"\n",["$","ul",null,{"children":["\n",["$","li",null,{"children":[["$","$L9",null,{"href":"https://github.com/git-guides/install-git","children":"Git"}],["$","script",null,{"src":"https://cdn.jsdelivr.net/gh/eddymens/markdown-external-link-script@v2.0.0/main.min.js"}]]}],"\n",["$","li",null,{"children":[["$","$L9",null,{"href":"https://nodejs.org/en","children":"Node.js:"}],["$","script",null,{"src":"https://cdn.jsdelivr.net/gh/eddymens/markdown-external-link-script@v2.0.0/main.min.js"}]," only LTS versions are supported v18.17.1 or higher. Other versions of Node.js may not be compatible with the latest release of erxes. The 18.17.x version is most recommended by erxes. The easier way to install ",["$","$L9",null,{"href":"https://github.com/nvm-sh/nvm#installing-and-updating","children":"nvm"}]," is here."]}],"\n",["$","li",null,{"children":[["$","$L9",null,{"href":"https://docs.npmjs.com/cli/v6/commands/npm-install/","children":"npm"}],["$","script",null,{"src":"https://cdn.jsdelivr.net/gh/eddymens/markdown-external-link-script@v2.0.0/main.min.js"}]," and ",["$","$L9",null,{"href":"https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable","children":"yarn"}],["$","script",null,{"src":"https://cdn.jsdelivr.net/gh/eddymens/markdown-external-link-script@v2.0.0/main.min.js"}]," (latest version) to run the erxes."]}],"\n",["$","li",null,{"children":[["$","$L9",null,{"href":"https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-20-04","children":"Docker"}],["$","script",null,{"src":"https://cdn.jsdelivr.net/gh/eddymens/markdown-external-link-script@v2.0.0/main.min.js"}]," Latest version."]}],"\n"]}],"\n",["$","hr",null,{}],"\n",["$","h1",null,{"children":"Installing erxes"}],"\n",["$","hr",null,{}],"\n",["$","ol",null,{"children":["\n",["$","li",null,{"children":"Create an empty folder."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"mkdir example\n","children":["$","$Lc",null,{"className":"language-tsx","children":"mkdir example\n"}]}],"\n",["$","ol",null,{"start":"2","children":["\n",["$","li",null,{"children":"In your empty folder, where the new erxes project will be created, and it defines the database and erxes plugins to use."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"cd example\n","children":["$","$Lc",null,{"className":"language-tsx","children":"cd example\n"}]}],"\n",["$","ol",null,{"start":"3","children":["\n",["$","li",null,{"children":"Run following command in the folder."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"git clone https://github.com/erxes/erxes.git\n","children":["$","$Lc",null,{"className":"language-tsx","children":"git clone https://github.com/erxes/erxes.git\n"}]}],"\n",["$","$Ld",null,{"level":2,"id":"installing-dependencies-using-docker","children":["$","strong",null,{"children":"Installing dependencies using docker"}]}],"\n",["$","ol",null,{"start":"4","children":["\n",["$","li",null,{"children":"In the folder, create dock directory using following command."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"mkdir dock\n","children":["$","$Lc",null,{"className":"language-tsx","children":"mkdir dock\n"}]}],"\n",["$","ol",null,{"start":"5","children":["\n",["$","li",null,{"children":"Go to the dock folder using following command."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"cd dock\n","children":["$","$Lc",null,{"className":"language-tsx","children":"cd dock\n"}]}],"\n",["$","div",null,{"className":"text-base my-3 flex flex-col border-l-4 border-emerald-500 bg-emerald-100 p-4 leading-6 text-emerald-950 dark:border-emerald-500/30 dark:bg-emerald-500/5 dark:text-emerald-200 dark:[--tw-prose-links-hover:theme(colors.emerald.300)] dark:[--tw-prose-links:theme(colors.white)]","children":[["$","p",null,{"className":"text-lg p-0 mt-0 mb-2 font-bold text-emerald-500 dark:text-emerald-200","children":"✏️ Note"}],["$","div",null,{"className":"[&>:first-child]:mt-0 [&>:last-child]:mb-0","children":["$","p",null,{"children":"Run sudo nano or sudo vim command to create .yml file."}]}]]}],"\n",["$","ol",null,{"start":"6","children":["\n",["$","li",null,{"children":["Create a ",["$","$Lc",null,{"children":"docker-compose.yml"}]," file, then copy the following script in the newly created file."]}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"version: '3.6'\nservices:\n mongo:\n hostname: mongo\n image: mongo:4.0.10\n # container_name: mongo\n ports:\n - \"27017:27017\"\n networks:\n - erxes-net\n healthcheck:\n test: test $$(echo \"rs.initiate().ok || rs.status().ok\" | mongo --quiet) -eq 1\n interval: 2s\n timeout: 2s\n retries: 200\n command: [\"--replSet\", \"rs0\", \"--bind_ip_all\"]\n extra_hosts:\n - \"mongo:127.0.0.1\"\n volumes:\n - ./data/db:/data/db\n\n redis:\n image: 'redis'\n # container_name: redis\n # command: redis-server --requirepass pass\n ports:\n - \"6379:6379\"\n networks:\n - erxes-net\n\n rabbitmq:\n image: rabbitmq:3.7.17-management\n # container_name: rabbitmq\n restart: unless-stopped\n hostname: rabbitmq\n ports:\n - \"15672:15672\"\n - \"5672:5672\"\n networks:\n - erxes-net\n # RabbitMQ data will be saved into ./rabbitmq-data folder.\n volumes:\n - ./rabbitmq-data:/var/lib/rabbitmq\n\nnetworks:\n erxes-net:\n driver: bridge\n","children":["$","$Lc",null,{"className":"language-tsx","children":"$e"}]}],"\n",["$","div",null,{"className":"text-base my-3 flex flex-col border-l-4 border-indigo-500 bg-indigo-100 p-4 leading-6 text-indigo-950 dark:border-violet-500/30 dark:bg-violet-500/5 dark:text-violet-200 dark:[--tw-prose-links-hover:theme(colors.violet.300)] dark:[--tw-prose-links:theme(colors.white)]","children":[["$","p",null,{"className":"text-lg p-0 mt-0 mb-2 font-bold text-indigo-500 dark:text-violet-200","children":"πŸ’‘ Tip"}],["$","div",null,{"className":"[&>:first-child]:mt-0 [&>:last-child]:mb-0","children":["$","p",null,{"children":["Please find the useful ",["$","$L9",null,{"href":"https://docs.docker.com/engine/reference/commandline/compose_images/#related-commands","children":"commands"}],["$","script",null,{"src":"https://cdn.jsdelivr.net/gh/eddymens/markdown-external-link-script@v2.0.0/main.min.js"}]," when you're working on Docker"]}]}]]}],"\n",["$","ol",null,{"start":"7","children":["\n",["$","li",null,{"children":"Run the following command in the folder where above file exists."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"sudo docker-compose up -d\n","children":["$","$Lc",null,{"className":"language-tsx","children":"sudo docker-compose up -d\n"}]}],"\n",["$","ol",null,{"start":"8","children":["\n",["$","li",null,{"children":"Go back to erxes folder using following command."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"cd ../erxes\n","children":["$","$Lc",null,{"className":"language-tsx","children":"cd ../erxes\n"}]}],"\n",["$","ol",null,{"start":"9","children":["\n",["$","li",null,{"children":"Switch a dev branch by using following command."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"git checkout dev\n","children":["$","$Lc",null,{"className":"language-tsx","children":"git checkout dev\n"}]}],"\n",["$","ol",null,{"start":"10","children":["\n",["$","li",null,{"children":"In erxes folder, Install node modules by using following command."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"yarn install\n","children":["$","$Lc",null,{"className":"language-tsx","children":"yarn install\n"}]}],"\n",["$","ol",null,{"start":"11","children":["\n",["$","li",null,{"children":["Install ",["$","$Lc",null,{"children":"pm2"}]," by using following command."]}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"sudo npm install -g pm2\n","children":["$","$Lc",null,{"className":"language-tsx","children":"sudo npm install -g pm2\n"}]}],"\n",["$","h1",null,{"children":"Running erxes"}],"\n",["$","hr",null,{}],"\n",["$","div",null,{"className":"text-base my-3 flex flex-col border-l-4 border-amber-500 bg-amber-100 p-4 leading-6 text-amber-950 dark:border-amber-500 dark:bg-amber-200 dark:text-amber-950 dark:[--tw-prose-links-hover:theme(colors.amber.300)] dark:[--tw-prose-links:theme(colors.amber)]","children":[["$","p",null,{"className":"text-lg p-0 mt-0 mb-2 font-bold text-amber-500 dark:text-amber-500","children":"βœ‹ Caution"}],["$","div",null,{"className":"[&>:first-child]:mt-0 [&>:last-child]:mb-0","children":["$","p",null,{"children":"Run erxes in erxes/cli directory"}]}]]}],"\n",["$","ol",null,{"children":["\n",["$","li",null,{"children":"Run following command to change the folder."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"cd cli\n","children":["$","$Lc",null,{"className":"language-tsx","children":"cd cli\n"}]}],"\n",["$","ol",null,{"start":"2","children":["\n",["$","li",null,{"children":"Install node modules in the erxes/cli directory."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"yarn install\n","children":["$","$Lc",null,{"className":"language-tsx","children":"yarn install\n"}]}],"\n",["$","ol",null,{"start":"3","children":["\n",["$","li",null,{"children":["Copy ",["$","$Lc",null,{"children":"configs.json.sample"}],", then convert it to ",["$","$Lc",null,{"children":"configs.json."}]]}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"cp configs.json.sample configs.json\n","children":["$","$Lc",null,{"className":"language-tsx","children":"cp configs.json.sample configs.json\n"}]}],"\n",["$","ol",null,{"start":"4","children":["\n",["$","li",null,{"children":"Run following command to start your erxes project."}],"\n"]}],"\n",["$","$Lb",null,{"language":"tsx","code":"./bin/erxes.js dev\n","children":["$","$Lc",null,{"className":"language-tsx","children":"./bin/erxes.js dev\n"}]}],"\n",["$","$Ld",null,{"level":2,"id":"if-your-browser-dont-automatically-jump-to-localhost-3000-you-should-check-logs-by-using-these-commands","children":"If your browser don't automatically jump to localhost:3000, you should check logs by using these commands."}],"\n",["$","div",null,{"className":"text-base my-3 flex flex-col border-l-4 border-indigo-500 bg-indigo-100 p-4 leading-6 text-indigo-950 dark:border-violet-500/30 dark:bg-violet-500/5 dark:text-violet-200 dark:[--tw-prose-links-hover:theme(colors.violet.300)] dark:[--tw-prose-links:theme(colors.white)]","children":[["$","p",null,{"className":"text-lg p-0 mt-0 mb-2 font-bold text-indigo-500 dark:text-violet-200","children":"πŸ’‘ Tip"}],["$","div",null,{"className":"[&>:first-child]:mt-0 [&>:last-child]:mb-0","children":[["$","p",null,{"children":["Frequently used ",["$","$Lc",null,{"children":"pm2"}]," commands on erxes:"]}],["$","ul",null,{"children":["\n",["$","li",null,{"children":"pm2 list - Display all processes status"}],"\n",["$","li",null,{"children":"pm2 kill - Will remove all processes from pm2 list"}],"\n",["$","li",null,{"children":"pm2 logs -f - Display all processes logs in streaming (gateway, plugin-name etc.)"}],"\n",["$","li",null,{"children":"pm2 restart all - Restart all processes"}],"\n"]}]]}]]}],"\n",["$","$Ld",null,{"level":2,"id":"if-you-see-this-screen-you-have-successfully-install-erxes-xos-congratulations","children":"If you see this screen, you have successfully install erxes XOS. Congratulations πŸŽ‰πŸŽ‰πŸŽ‰"}],"\n",["$","p",null,{"children":["$","img",null,{"src":"https://imagedelivery.net/5m26Aj-CutMXPPNacMs_yQ/1bee4344-9c4b-4a37-e3f4-6e4b02211000/public","alt":""}]}]]}],["$","footer",null,{"className":"mx-auto mt-16 w-full max-w-2xl lg:max-w-5xl","children":["$","$Lf",null,{}]}]]}],null],"segment":"__PAGE__"},"styles":[]}],"segment":"ubuntu"},"styles":[]}],"segment":"groups"},"styles":[]}],"segment":"quickstart"},"styles":[]}]}]}]}]}]}] a:null