diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 6a0014e..3eb6cde 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -60,8 +60,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -submit.digital@gov.bc.ca. -All complaints will be reviewed and investigated promptly and fairly. +submit.digital@gov.bc.ca or reach out to us through our [CHEFS Exchange Lab - Teams Channel](https://teams.microsoft.com/l/channel/19%3a34b9d4b4deb54eebaa9be8bc1ccf02f7%40thread.tacv2/CHEFS%2520(Exchange%2520Lab%2520Team)?groupId=bef8086f-20c7-43a4-bd07-29ce764e818c&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. diff --git a/docs/About.md b/docs/About.md index 7d7858c..900de45 100644 --- a/docs/About.md +++ b/docs/About.md @@ -88,7 +88,8 @@ Do you have a feature request for CHEFS? Post your ideas, leave a comment or vot <details> <summary><strong>Contact us</strong></summary> -You also can reach out to the CHEFS team directly at [submit.digital@gov.bc.ca](mailto:submit.digital@gov.bc.ca). +Join in the active discussions happening on our [CHEFS MS Teams Channel](https://teams.microsoft.com/l/channel/19%3A34b9d4b4deb54eebaa9be8bc1ccf02f7%40thread.tacv2/CHEFS%20(Exchange%20Lab%20Team)?groupId=bef8086f-20c7-43a4-bd07-29ce764e818c&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) or drop by to say hi in our virtual office space on a publicly accessible +[Common Components Discord Server](https://discord.com/channels/942948086773321799/943046207872319498). </details> @@ -99,4 +100,4 @@ Take a tour of CHEFS to see it in action. **(Youtube)** <iframe width="560" height="315" src="https://www.youtube.com/embed/obOhyYusMjM?si=HEnwSYnd48BWTio8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> *** -[Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) \ No newline at end of file +[Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) diff --git a/docs/About/SoAR-and-Compliance.md b/docs/About/SoAR-and-Compliance.md index 570cb52..3b2c7d5 100644 --- a/docs/About/SoAR-and-Compliance.md +++ b/docs/About/SoAR-and-Compliance.md @@ -18,7 +18,6 @@ CHEFS is on a two week sprint schedule, and this review happens every second spr - The `pr-external`, `test`, and `prod` Environments in GitHub have `Required reviewers` in the protection rules that must only be current users - The `RoleBindings` in the OpenShift `-tools`, `-dev`, `-test`, and `-prod` environments of the `a12c97` and `a191b5` namespaces must only be for current `User` and `ServiceAccount` subjects - SysDig access must only be for current team users (`oc -n a12c97-tools get sysdig-team a12c97-sysdigteam -o yaml`) -- The SSO environments `dev`, `test`, and `prod` must only contain current users in the groups `Realm Administrator`, `Realm Viewer`, and `operations-team` - The [SSO CSS app](https://bcgov.github.io/sso-requests-preview) in the `My Teams` tab must only contain current users in the `CoCo Team` <!-- #### TODO: @@ -39,9 +38,9 @@ The SoAR section "Assessment", subsection "Vulnerability Management" states: CHEFS is on a two week sprint schedule, and this review happens before every sprint planning meeting. In [Red Hat ACS](https://acs.developer.gov.bc.ca) ensure that the top item in the `Images most at risk` has a JIRA item created for it. If not, create a JIRA item in the Backlog using the template: - _Type_: Task -- _Title_: ACS Image most at risk: **[IMAGE_NAME]** -- _Description_:<br>The Red Hat Advanced Cluster Security (ACS) application has identified the image **[IMAGE_NAME]** as being most at risk. To satisfy the requirements outlined in the Security Threat and Risk Assessment's (STRA) Statement of Acceptable Risks (SoAR), this image must be updated to resolve fixable vulnerabilities (or mitigated in some other way, if updating the image is not possible). -- _Epic Link_: CHEFS DevOps +- _Title_: ACS Image at risk: **[IMAGE_NAME]** +- _Description_:<br>The Red Hat Advanced Cluster Security (ACS) application has identified the image **[IMAGE_NAME]** as having vulnerabilities that are fixable. To satisfy the requirements outlined in the Security Threat and Risk Assessment's (STRA) Statement of Acceptable Risks (SoAR), this image must be updated to resolve fixable vulnerabilities (or mitigated in some other way, if updating the image is not possible). +- _Epic Link_: CHEFS Bugs and Defects Update the log at the end of this page to show that this step has been completed. @@ -59,7 +58,7 @@ CHEFS is on a two week sprint schedule, and this review happens before every spr - _Title_: Dependabot Vulnerability Alert for **[PACKAGE_NAME]** in **[MANIFEST_DIR]** - _Description_:<br>The GitHub Dependabot process has created an alert for the **[PACKAGE_NAME]** dependency. To satisfy the requirements outlined in the Security Threat and Risk Assessment's (STRA) Statement of Acceptable Risks (SoAR), this vulnerability must be handled by updating the package version (or mitigated in some other way, if updating the package is not possible).<br> ht<workaround>tps://gi</workaround>thub.com/bcgov/common-hosted-form-service/security/dependabot/**[DEPENDABOT_ID]** -- _Epic Link_: CHEFS DevOps +- _Epic Link_: CHEFS Bugs and Defects Update the log at the end of this page to show that this step has been completed. @@ -80,7 +79,7 @@ CHEFS is on a two week sprint schedule, and this review happens before every spr - _Description_:<br>The OWASP Zap Scan process has identified a **[VULNERABILITY_RISK_LEVEL]** risk level vulnerability:<br> \> **[VULNERABILITY_DESCRIPTION]**<br> To satisfy the requirements outlined in the Security Threat and Risk Assessment's (STRA) Statement of Acceptable Risks (SoAR), this vulnerability must be remediated. -- _Epic Link_: CHEFS DevOps +- _Epic Link_: CHEFS Bugs and Defects Update the log at the end of this page to show that this step has been completed. @@ -91,11 +90,13 @@ During sprint planning arrange for the new JIRA item to be included in the sprin <!-- NOTE: The log is in reverse order by date (newest at top) --> |Date|Access Review|ACS|Dependabot|OWASP Zap Scan| |:---:|:---:|:---:|:---:|:---:| -|2024-04-11|✓|✓|✓|✓| -|2024-03-28|✓|✓|✓|✓| -|2024-03-14|✓|✓|✓|✓| -|2024-02-29|✓|✓|✓|✓| -|2024-02-15|✓|✓|✓|✓| +|2024-06-27|✓|✓|✓|Broken| +|2024-05-30|✓|✓|✓|Broken| +|2024-04-11|✓|✓|✓|Broken| +|2024-03-28|✓|✓|✓|Broken| +|2024-03-14|✓|✓|✓|Broken| +|2024-02-29|✓|✓|✓|Broken| +|2024-02-15|✓|✓|✓|Broken| |2024-02-01|✓|✓|✓|✓| |2024-01-18|✓|✓|✓|✓| |2024-01-04|✓|✓|✓|✓| diff --git a/docs/Archive/User-Comments-and-Monitoring.md b/docs/Archive/User-Comments-and-Monitoring.md index 9eb9ead..eb59b53 100644 --- a/docs/Archive/User-Comments-and-Monitoring.md +++ b/docs/Archive/User-Comments-and-Monitoring.md @@ -13,7 +13,6 @@ Everything reported by users or by automated systems will be used in our sprint | Channel | Purpose | Source | Owner #1 | Owner #2 | Owner #3 | | ---------------------------- | ----------------------------- | --------- | ----------- | ------------ | ------------ | -|[submit.digital@gov.bc.ca](mailto:submit.digital@gov.bc.ca)|General comments|Users|[Matthew Hall](https://teams.microsoft.com/l/chat/0/0?users=matthew.hall@gov.bc.ca) ||| |[Microsoft Teams](https://teams.microsoft.com/l/channel/19%3a34b9d4b4deb54eebaa9be8bc1ccf02f7%40thread.tacv2/CHEFS%2520(Exchange%2520Lab%2520Team)?groupId=bef8086f-20c7-43a4-bd07-29ce764e818c&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) | General comments | Users | [Walter Moar](https://teams.microsoft.com/l/chat/0/0?users=walter.moar@gov.bc.ca)||| |[#common-components](https://chat.developer.gov.bc.ca/channel/common-components)|General comments|Users|[Walter Moar](https://teams.microsoft.com/l/chat/0/0?users=walter.moar@gov.bc.ca)||| |[Stack Overflow](https://stackoverflow.developer.gov.bc.ca/)|General comments|Users|[Ayobami Idowu](https://teams.microsoft.com/l/chat/0/0?users=ayobamii.idowu@gov.bc.ca)||| diff --git a/docs/Capabilities/Accessibility.md b/docs/Capabilities/Accessibility.md index 61dcbd2..f0b67e2 100644 --- a/docs/Capabilities/Accessibility.md +++ b/docs/Capabilities/Accessibility.md @@ -12,8 +12,7 @@ We are committed to meeting your needs no matter how you use the service. We und ### Tell us how we’re doing To tell us about accessibility issues on Submit, you can: -* Reach out to us through our [CHEFS Exchange Lab - Teams Channel](https://teams.microsoft.com/l/channel/19%3a34b9d4b4deb54eebaa9be8bc1ccf02f7%40thread.tacv2/CHEFS%2520(Exchange%2520Lab%2520Team)?groupId=bef8086f-20c7-43a4-bd07-29ce764e818c&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) -* Email us at [submit.digital@gov.bc.ca](mailto:submit.digital@gov.bc.ca) +* Reach out to us through our [CHEFS Exchange Lab - Teams Channel](https://teams.microsoft.com/l/channel/19%3a34b9d4b4deb54eebaa9be8bc1ccf02f7%40thread.tacv2/CHEFS%2520(Exchange%2520Lab%2520Team)?groupId=bef8086f-20c7-43a4-bd07-29ce764e818c&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) * Create an issue on our [public GitHub repository](https://github.com/bcgov/common-hosted-form-service/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) We will work with you to: diff --git a/docs/Capabilities/Integrations.md b/docs/Capabilities/Integrations.md index 895b025..978e0db 100644 --- a/docs/Capabilities/Integrations.md +++ b/docs/Capabilities/Integrations.md @@ -5,6 +5,7 @@ * [MS Teams Channel Integration](MS-Teams-Channel-Integration) * [Event Subscription](Event-Subscription) (Experimental) * [Excel Power Query Integration](Excel-Power-Query-Integration) +* [Salesforce Integration](Salesforce-Integration) *** -[Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) \ No newline at end of file +[Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) diff --git a/docs/Capabilities/Integrations/Event-Subscription.md b/docs/Capabilities/Integrations/Event-Subscription.md index f1734f9..9e072f1 100644 --- a/docs/Capabilities/Integrations/Event-Subscription.md +++ b/docs/Capabilities/Integrations/Event-Subscription.md @@ -15,7 +15,7 @@ This should add another expandable panel section where Event Subscription parame * submission of a form, including drafts - ``` + ``` { "formId": "ed5f9b10-xxxx-xxxx-xxxx-a6133236564a", "formVersion": "1a62dec9-xxxx-xxxx-xxxx-342a1cc138cd", diff --git a/docs/Capabilities/Integrations/Power-BI-Integration.md b/docs/Capabilities/Integrations/Power-BI-Integration.md index d44511c..8cb05c3 100644 --- a/docs/Capabilities/Integrations/Power-BI-Integration.md +++ b/docs/Capabilities/Integrations/Power-BI-Integration.md @@ -7,16 +7,28 @@ Microsoft Power BI is one of many ways to work with form submission data. The we By creating a new Power BI query you can work with the submission data. -### CHEFS Form Information - -You will need this information about your form: -- The `formId` and `formVersionId`. One way to retrieve them is to "Manage" your form and in the table at the bottom click "Version 1" (or the version you want). The URL in the new browser window will contain ".../preview?f={formId}&v={formVersionId}" -- Your form's [API Key](../Data-Management/Generating-API-keys) - -### Query Configuration: Submissions - -- In the ribbon at the top of Power BI click `Get data` and select `Web` -- Use the URL `https://submit.digital.gov.bc.ca/app/api/v1/forms/{formId}/versions/{formVersionId}/submissions` to get the submissions for a version of your form - you will need to replace `{formId}` and `{formVersionId}` with the values for your form +You will need this information about your CHEFS form: +- `formId` - To put in the datasource URL and to use as the username in for the basic authorization. +- `API Key` - To use as the password for the basic authorization. Instructions are available for [Generating API Keys](../Data-Management/Generating-API-keys) +- `formVersionId` (optional) - If you want to filter to one version. +- `formSubmissionId` (optional) - If you want to get just one submission of a form. + +### To get all submissions for a CHEFS Form +For the datasource, use the URL: `https://submit.digital.gov.bc.ca/app/api/v1/forms/{formId}/export?format=json` +replace `{formId}` with yours + +### To get submissions for just one form version +- You will need the `formVersionId`. One way to retrieve them is to "Manage" your form and in the table at the bottom click "Version 1" (or the version you want). +- The URL in the new browser window will contain ".../preview?f={formId}&v={formVersionId}" +- to get the submissions for a version of your form - you will need to replace `{formId}` and `{formVersionId}` with these values from your form + +### Query Configuration: Submissions +__Open PowerBI Desktop version.__ +- In the ribbon at the top of Power BI click `Get data` and select `Web` +- depending on whether you want all submissions or just submission from one version, or just one submission, you will need to use a different URL for each: + - ALL Submissions: `https://submit.digital.gov.bc.ca/app/api/v1/forms/{formId}/export?format=json` + - Form Version Specific: `https://submit.digital.gov.bc.ca/app/api/v1/forms/{formId}/versions/{formVersionId}/submissions` + - Submission Specific: `https://submit.digital.gov.bc.ca/app/api/v1/submissions/{formSubmissionId}/ - Choose "Basic" for the authorization type, with "User name" set to your `formId` and "Password" set to your API Key ### Query Configuration: Submission Statuses @@ -28,4 +40,4 @@ It is also possible to get the list of statuses for each submission. - Choose "Basic" for the authorization type, with "User name" set to your `formId` and "Password" set to your API Key *** -[Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) \ No newline at end of file +[Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) diff --git a/docs/Capabilities/Integrations/Salesforce-Integration.md b/docs/Capabilities/Integrations/Salesforce-Integration.md new file mode 100644 index 0000000..ec1ae42 --- /dev/null +++ b/docs/Capabilities/Integrations/Salesforce-Integration.md @@ -0,0 +1,56 @@ +[Home](index) > [Capabilities](Capabilities) > [Integrations](Integrations) > **Salesforce Integration** +*** + +Salesforce is one of many ways to work with form submission data. + +## Salesforce Integration using Named Credentials and External Services + +By creating a new Salesforce External service you can work with the submission data. + +### CHEFS Form Information + +You will need this information about your form: +- The `formId` and `formVersionId`. One way to retrieve them is to "Manage" your form and in the table at the bottom click "Version 1" (or the version you want). The URL in the new browser window will contain ".../preview?f={formId}&v={formVersionId}" +- Your form's [API Key](../Data-Management/Generating-API-keys) + +### Named Credentials in salesforce + +**Named Credentials** allow Salesforce to manage authentication for calls to external systems. This simplifies the process of calling an external APIs by securely storing authentication details and abstracting the complexity of API authentication. + +**Steps to Create Named Credentials:** + +1. **Navigate to:** Setup > Named Credentials +2. **Click on:** New Named Credential +3. **Fill in the Details:** + - **Label:** Enter a name for the credential (e.g., "CHEFSAPICredential"). + - **Name:** This is automatically populated based on the label. + - **URL:** Enter the base URL of the external API as `https://submit.digital.gov.bc.ca/app/api/v1` + - **Identity Type:** Select `Named Principal` + - **Authentication Protocol:** Select `Basic Authentication`. + - **Username:** Enter the API username. It will be `formId` in our case. + - **Password:** "Password" will be set to your form [API Key](../Data-Management/Generating-API-keys) + +4. **Save:** This securely stores the authentication details for accessing the external API. + +### External Services in salesforce + +**External Services** in Salesforce allow you to connect to external APIs using a declarative approach. + +**Steps to Create an External Service:** + +1. **Navigate to:** Setup > External Services +2. **Click on:** New External Service +3. On the Select an API Source page, select whether you’re importing an API spec From Mulesoft Anypoint Platform, or From API Specification. Since we're using CHEFS spec here, select From API Specification. +4. **Fill in the Details:** + - **Service Name:** Enter a name for the external service (e.g., "CHEFSAPIService"). + - **Named Credential:** Select the named credential you created earlier i.e. `CHEFSAPICredential` + - **Service Schema:** Select `Relative URL`. + - **URL**: Enter `/api-spec.yaml`, provides the Open API specification for all CHEFS API's. Any API's with Authorization as Basic Auth can be integrated with the salesforce External Services. Following are some of useful API's + - Enter `/forms/{formId}/versions/{formVersionId}/submissions` to get the submissions for a version of your form - you will need to replace `{formId}` and `{formVersionId}` with the values for your form. + - Enter `/submissions/{formSubmissionId}/status` to get the statuses for each submission - you will need to replace `{formSubmissionId}` with the `id` value for each submission. + +5. **Save & Next:** Salesforce will parse the OpenAPI specification and generate Apex actions. +6. You can now integrate and work with CHEFS data using the newly added External Service in your Apex code, Flow Builder, Process Builder, or any other Salesforce components that support External Service. + +*** +[Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) diff --git a/docs/Components/Custom/Advanced-Progress-Bar.md b/docs/Components/Custom/Advanced-Progress-Bar.md index 7f63d22..de779ec 100644 --- a/docs/Components/Custom/Advanced-Progress-Bar.md +++ b/docs/Components/Custom/Advanced-Progress-Bar.md @@ -3,9 +3,9 @@ ## Examples > Try a working example<br> -> [View Example: Progress Bar with Validation](https://submit.digital.gov.bc.ca/app/form/submit?f=4e702761-c6af-4b10-91d0-0950b964cf4d) -> [View Example: Progress Bar Using Layout](https://submit.digital.gov.bc.ca/app/form/submit?f=f20ac79e-14a7-464f-8139-f5c5de9133e1) -> [View Example: Progress Bar Using Layout with Validation](https://submit.digital.gov.bc.ca/app/form/submit?f=ba809aaa-f975-42a8-bc20-8de12c11ec22) +> [View Example: Progress Bar with Validation](https://submit.digital.gov.bc.ca/app/form/submit?f=e7cb5ddd-1c24-4437-a7fd-85326713013f) +> [View Example: Progress Bar Using Layout](https://submit.digital.gov.bc.ca/app/form/submit?f=cd5eb16b-1565-419c-bed6-387281c066fc) +> [View Example: Progress Bar Using Layout with Validation](https://submit.digital.gov.bc.ca/app/form/submit?f=655438f6-40d9-475a-bc4f-bfe76d9a04b3) > Download this example file and [import](Importing-and-exporting-form-designs) it into your design<br> diff --git a/docs/Components/Custom/Calculating-Values-with-Dates.md b/docs/Components/Custom/Calculating-Values-with-Dates.md index a3c337f..59bf323 100644 --- a/docs/Components/Custom/Calculating-Values-with-Dates.md +++ b/docs/Components/Custom/Calculating-Values-with-Dates.md @@ -3,7 +3,7 @@ ## Examples > Try a working example<br> -> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=506ccffb-b0c5-49b3-8f8f-8e5f9809e1a5) +> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=ea72822f-209e-4509-85be-0ab525846969) > Download this example file and [import](Importing-and-exporting-form-designs) it into your design<br> > [example_counting_days_between_two_dates_schema.json](../examples/example_counting_days_between_two_dates_schema.json){:download="example_counting_days_between_two_dates_schema.json"} diff --git a/docs/Components/Custom/Dynamic-Select-Lists.md b/docs/Components/Custom/Dynamic-Select-Lists.md index 27eca6a..ae7dd19 100644 --- a/docs/Components/Custom/Dynamic-Select-Lists.md +++ b/docs/Components/Custom/Dynamic-Select-Lists.md @@ -3,7 +3,7 @@ ## Examples > Try a working example<br> -> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=4ee726e0-f7a7-49a1-8454-7325d2593a7d) +> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=29700227-dbaa-478b-b4c0-e39feeba3f43) > Download this example file and [import](Importing-and-exporting-form-designs) it into your design<br> > [example__dynamic_select_lists_schema.json](../examples/example_dynamic_select_lists_schema.json){:download="example_dynamic_select_lists_schema.json"} diff --git a/docs/Components/Custom/Navigation-Buttons.md b/docs/Components/Custom/Navigation-Buttons.md index af250ae..4ffacbe 100644 --- a/docs/Components/Custom/Navigation-Buttons.md +++ b/docs/Components/Custom/Navigation-Buttons.md @@ -3,7 +3,7 @@ ## Examples > Try a working example<br> -> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=3fe31d91-a802-44a4-8215-03110af26470) +> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=e0aa0b29-72a9-4268-aff1-5446d0aa7b57) > Download this example file and [import](Importing-and-exporting-form-designs) it into your design<br> > [example_navigation_buttons_schema.json](../examples/example_navigation_buttons_schema.json){:download="example_navigation_buttons_schema.json"} diff --git a/docs/Components/Custom/Progress-Bar.md b/docs/Components/Custom/Progress-Bar.md index 0284207..e3a22bc 100644 --- a/docs/Components/Custom/Progress-Bar.md +++ b/docs/Components/Custom/Progress-Bar.md @@ -3,7 +3,7 @@ ## Examples > Try a working example<br> -> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=296cb105-16f8-4dda-8d49-c83456e51345) +> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=d4f4a0d6-52f5-445b-a1b3-32cd1f43e72c) > Download this example file and [import](Importing-and-exporting-form-designs) it into your design<br> > [example_progress_bar_schema.json]../examples/example_progress_bar_schema.json){:download="example_progress_bar_schema.json"} diff --git a/docs/Components/Custom/Styles.md b/docs/Components/Custom/Styles.md index 1620062..79c162b 100644 --- a/docs/Components/Custom/Styles.md +++ b/docs/Components/Custom/Styles.md @@ -4,7 +4,7 @@ ## Working Examples > Try a working example<br> -> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=6ff5ba7d-ed8b-433e-a063-162f56627586) +> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=1a795260-d9b5-44dd-89a8-52d769284df2) > Download this example file and [import](Importing-and-exporting-form-designs) it into your design<br> > [example_styles_schema.json](../examples/example_styles_schema.json){:download="example_styles_schema.json"} diff --git a/docs/Components/Custom/Tooltip-for-Text-Images-Component.md b/docs/Components/Custom/Tooltip-for-Text-Images-Component.md index c968d14..8f52e83 100644 --- a/docs/Components/Custom/Tooltip-for-Text-Images-Component.md +++ b/docs/Components/Custom/Tooltip-for-Text-Images-Component.md @@ -3,7 +3,7 @@ ## Examples > Try a working example<br> -> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=3897ab9e-b9f2-43d5-ab95-3d1344c1516e) +> [View example](https://submit.digital.gov.bc.ca/app/form/submit?f=697d4f58-766c-427d-a6f6-2925f056d8da) > Download this example file and [import](Importing-and-exporting-form-designs) it into your design<br> > [example_tooltip_for_text_images_component_schema.json](../examples/example_tooltip_for_text_images_component_schema.json){:download="example_tooltip_for_text_images_component_schema.json"} diff --git a/docs/Components/Examples.md b/docs/Components/Examples.md index 91268e2..377d4ea 100644 --- a/docs/Components/Examples.md +++ b/docs/Components/Examples.md @@ -7,9 +7,9 @@ CHEFS has a lot of different features to help you collect data. Below are some e |Form name|CHEFS features|Downloads| |---|---|---| -|[Contaminated Sites Services Application Form](https://submit.digital.gov.bc.ca/app/form/submit?f=f003bc9e-0296-4a55-aa43-d8adaf0a022d)|[Conditional forms fields](Conditional-forms-fields), [Repeating data grids](Repeating-data-grids), [Dynamic select lists](Dynamic-Select-Lists), Save As PDF Button|| +|[Contaminated Sites Services Application Form](https://submit.digital.gov.bc.ca/app/form/submit?f=f003bc9e-0296-4a55-aa43-d8adaf0a022d)|[Conditional forms fields](Conditional-forms-fields), [Repeating data grids](Repeating-data-grids), [Dynamic select lists](Dynamic-Select-Lists)|| -Is your form taking advantage of CHEFS more advanced features? Or are you using it to collect a lot of different data? If you are interested in sharing your form with the broader community, send us an export of your form and the URL so others can check it out. You can send your files to [submit.digital@gov.bc.ca](mailto:submit.digital@gov.bc.ca). +Is your form taking advantage of CHEFS more advanced features? Or are you using it to collect a lot of different data? If you are interested in sharing your form with the broader community, send us an export of your form and the URL so others can check it out. You can reach out to us through our [CHEFS Exchange Lab - Teams Channel](https://teams.microsoft.com/l/channel/19%3a34b9d4b4deb54eebaa9be8bc1ccf02f7%40thread.tacv2/CHEFS%2520(Exchange%2520Lab%2520Team)?groupId=bef8086f-20c7-43a4-bd07-29ce764e818c&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) ## Examples of CHEFS features @@ -19,12 +19,13 @@ We have created some examples of features you might want to use in your forms. F |Feature example|Downloads| |---|---| -|[Conditional forms fields example](https://submit.digital.gov.bc.ca/app/form/submit?f=9bc36ebf-c6c3-4f5a-9a8d-ea9e8acb0ded)|[example_conditional_logic_schema.json](examples/example_conditional_logic_schema.json){:download="example_conditional_logic_schema.json"}| -|[Dynamic select lists example](https://submit.digital.gov.bc.ca/app/form/submit?f=4ee726e0-f7a7-49a1-8454-7325d2593a7d)|[example_dynamic_select_lists_schema.json](examples/example_dynamic_select_lists_schema.json){:download="example_dynamic_select_lists_schema.json"}| +|[Conditional forms fields example](https://submit.digital.gov.bc.ca/app/form/submit?f=d6325679-a77b-4458-b2a5-8c3bfbdc2d2e)|[example_conditional_logic_schema.json](examples/example_conditional_logic_schema.json){:download="example_conditional_logic_schema.json"}| +|[Dynamic select lists example](https://submit.digital.gov.bc.ca/app/form/submit?f=29700227-dbaa-478b-b4c0-e39feeba3f43)|[example_dynamic_select_lists_schema.json](examples/example_dynamic_select_lists_schema.json){:download="example_dynamic_select_lists_schema.json"}| |[Calculated values example](https://submit.digital.gov.bc.ca/app/form/submit?f=858a4aba-7e7b-4019-80c1-78a414ee5129)|[example_calculated_values_schema.json](examples/example_calculated_values_schema.json){:download="example_calculated_values_schema.json"}| -|[Calculations in a Data Grid example](https://submit.digital.gov.bc.ca/app/form/submit?f=66c7918f-aa60-4095-8dfb-36b3002b4d47)|[example_calculations_in_datagrid_schema.json](examples/example_calculations_in_datagrid_schema.json){:download="example_calculations_in_datagrid_schema.json"}| -|[Calculations in Data Grid with dates and time](https://submit.digital.gov.bc.ca/app/form/submit?f=66c7918f-aa60-4095-8dfb-36b3002b4d47)|[example_calculations_in_datagrid_schema_dates.json](example_calculations_in_datagrid_schema_dates.json){:download="example_calculations_in_datagrid_schema_dates.json"}| -|[Tabs controlled with Navigation Buttons](https://submit.digital.gov.bc.ca/app/form/submit?f=3fe31d91-a802-44a4-8215-03110af26470)|[example_navigation_buttons_schema.json](examples/example_navigation_buttons_schema.json){:download="example_navigation_buttons_schema.json"}| +|[Calculations in a Data Grid example](https://submit.digital.gov.bc.ca/app/form/submit?f=95f19df8-c7b2-4daf-a8a9-7738910c173b)|[example_calculations_in_datagrid_schema.json](examples/example_calculations_in_datagrid_schema.json){:download="example_calculations_in_datagrid_schema.json"}| +|[Calculations in Data Grid with dates and time](https://submit.digital.gov.bc.ca/app/form/submit?f=95f19df8-c7b2-4daf-a8a9-7738910c173b)|[example_calculations_in_datagrid_schema_dates.json](example_calculations_in_datagrid_schema_dates.json){:download="example_calculations_in_datagrid_schema_dates.json"}| +|[Tabs controlled with Navigation Buttons](https://submit.digital.gov.bc.ca/app/form/submit?f=e0aa0b29-72a9-4268-aff1-5446d0aa7b57)|[example_navigation_buttons_schema.json](examples/example_navigation_buttons_schema.json){:download="example_navigation_buttons_schema.json"}| +|[Business name search](https://submit.digital.gov.bc.ca/app/form/submit?f=3cbcc49b-6b9e-4a62-aa8e-7870659e6164)|[example_business_name_search.json](examples/example_business_name_search_schema.json){:download="example_business_name_search_schema.json"}| *** [Terms of Use](Terms-of-Use) | [Privacy](Privacy) | [Security](Security) | [Service Agreement](Service-Agreement) | [Accessibility](Accessibility) \ No newline at end of file diff --git a/docs/Components/Form-Builder/Advanced-Data.md b/docs/Components/Form-Builder/Advanced-Data.md index 32e79c7..066eade 100644 --- a/docs/Components/Form-Builder/Advanced-Data.md +++ b/docs/Components/Form-Builder/Advanced-Data.md @@ -62,7 +62,7 @@ If you require a high volume of columns in your Data Grid, we suggest that you o ### Examples > Try a working example:<br> -> [View simple example](https://submit.digital.gov.bc.ca/app/form/submit?f=c07fb298-afce-41c5-8f53-8bb838546347)<br> +> [View simple example](https://submit.digital.gov.bc.ca/app/form/submit?f=b4e1efc5-ee38-4f1e-8190-d4030b47baf0)<br> > [View advanced example](https://submit.digital.gov.bc.ca/app/form/submit?f=285efa0d-e3d7-457c-9d34-67a9719cac1c) > You can also download the example files and [import](Importing-and-exporting-form-designs) it into your design<br> diff --git a/docs/Components/examples/example_business_name_search_schema.json b/docs/Components/examples/example_business_name_search_schema.json new file mode 100644 index 0000000..13c9171 --- /dev/null +++ b/docs/Components/examples/example_business_name_search_schema.json @@ -0,0 +1,464 @@ +{ + "display": "form", + "type": "form", + "components": [ + { + "id": "elzuju8", + "key": "orgbook", + "data": { + "url": "https://orgbook.gov.bc.ca/api/v3/search/autocomplete", + "json": "", + "custom": "", + "values": [ + { + "label": "", + "value": "" + } + ], + "resource": "" + }, + "tags": [], + "type": "orgbook", + "input": true, + "label": "Orgbook Search", + "limit": 100, + "logic": [], + "addons": [], + "errors": "", + "filter": "latest=true&inactive=false&revoked=false", + "hidden": false, + "idPath": "id", + "prefix": "", + "suffix": "", + "unique": false, + "widget": null, + "dataSrc": "url", + "dbIndex": false, + "overlay": { + "top": "", + "left": "", + "page": "", + "style": "", + "width": "", + "height": "" + }, + "tooltip": "", + "dataType": "object", + "disabled": false, + "lazyLoad": true, + "multiple": false, + "redrawOn": "", + "tabindex": "", + "template": "{{ item.topic_source_id }}, {{item.value}}", + "validate": { + "json": "", + "custom": "", + "select": false, + "unique": false, + "multiple": false, + "required": false, + "customMessage": "", + "customPrivate": false, + "onlyAvailableItems": false, + "strictDateValidation": false + }, + "autofocus": false, + "encrypted": false, + "hideLabel": false, + "indexeddb": { + "filter": {} + }, + "minSearch": 3, + "modalEdit": false, + "protected": false, + "refreshOn": "", + "tableView": false, + "attributes": {}, + "errorLabel": "", + "persistent": true, + "properties": {}, + "validateOn": "change", + "clearOnHide": true, + "conditional": { + "eq": "true", + "json": "", + "show": false, + "when": "submit" + }, + "customClass": "", + "description": "", + "fuseOptions": { + "include": "score", + "threshold": 0.3 + }, + "ignoreCache": false, + "placeholder": "Start typing to search BC Registered Businesses database", + "searchField": "q", + "authenticate": false, + "defaultValue": {}, + "disableLimit": false, + "selectFields": "", + "selectValues": "results", + "customOptions": { + "duplicateItemsAllowed": false + }, + "dataGridLabel": false, + "labelPosition": "top", + "readOnlyValue": true, + "searchEnabled": true, + "showCharCount": false, + "showWordCount": false, + "uniqueOptions": false, + "valueProperty": "", + "calculateValue": "", + "clearOnRefresh": false, + "searchDebounce": 0.3, + "useExactSearch": false, + "calculateServer": false, + "searchThreshold": 3, + "selectThreshold": 0.3, + "customConditional": "", + "allowMultipleMasks": false, + "customDefaultValue": "", + "allowCalculateOverride": false + }, + { + "id": "e2j4tr7", + "key": "registeredBusinessNumber", + "case": "", + "mask": false, + "tags": [], + "type": "simpletextfieldadvanced", + "input": true, + "label": "Registered Business Number", + "logic": [], + "addons": [], + "errors": "", + "hidden": false, + "prefix": "", + "suffix": "", + "unique": false, + "widget": { + "type": "input" + }, + "dbIndex": false, + "overlay": { + "top": "", + "left": "", + "page": "", + "style": "", + "width": "", + "height": "" + }, + "tooltip": "", + "disabled": false, + "multiple": false, + "redrawOn": "", + "tabindex": "", + "validate": { + "json": "", + "custom": "", + "unique": false, + "pattern": "", + "multiple": false, + "required": false, + "maxLength": "", + "minLength": "", + "isUseForCopy": false, + "customMessage": "", + "customPrivate": false, + "strictDateValidation": false + }, + "autofocus": false, + "encrypted": false, + "hideLabel": false, + "inputMask": "", + "inputType": "text", + "modalEdit": false, + "protected": false, + "refreshOn": "", + "tableView": true, + "attributes": {}, + "errorLabel": "", + "persistent": true, + "properties": {}, + "spellcheck": true, + "validateOn": "change", + "clearOnHide": true, + "conditional": { + "eq": "", + "json": "", + "show": null, + "when": null + }, + "customClass": "", + "description": "", + "displayMask": "", + "inputFormat": "plain", + "placeholder": "", + "autocomplete": "", + "defaultValue": "", + "dataGridLabel": false, + "labelPosition": "top", + "showCharCount": false, + "showWordCount": false, + "calculateValue": "value = data.orgbook.topic_source_id;\nconsole.log(data.orgbook);", + "calculateServer": false, + "customConditional": "", + "allowMultipleMasks": false, + "customDefaultValue": "", + "allowCalculateOverride": false, + "truncateMultipleSpaces": false + }, + { + "id": "e7w562", + "key": "registeredBusinessName", + "case": "", + "mask": false, + "tags": [], + "type": "simpletextfieldadvanced", + "input": true, + "label": "Registered Business Name", + "logic": [], + "addons": [], + "errors": "", + "hidden": false, + "prefix": "", + "suffix": "", + "unique": false, + "widget": { + "type": "input" + }, + "dbIndex": false, + "overlay": { + "top": "", + "left": "", + "page": "", + "style": "", + "width": "", + "height": "" + }, + "tooltip": "", + "disabled": false, + "multiple": false, + "redrawOn": "", + "tabindex": "", + "validate": { + "json": "", + "custom": "", + "unique": false, + "pattern": "", + "multiple": false, + "required": true, + "maxLength": "", + "minLength": "", + "isUseForCopy": false, + "customMessage": "", + "customPrivate": false, + "strictDateValidation": false + }, + "autofocus": false, + "encrypted": false, + "hideLabel": false, + "inputMask": "", + "inputType": "text", + "modalEdit": false, + "protected": false, + "refreshOn": "", + "tableView": true, + "attributes": {}, + "errorLabel": "", + "persistent": true, + "properties": {}, + "spellcheck": true, + "validateOn": "change", + "clearOnHide": true, + "conditional": { + "eq": "", + "json": "", + "show": null, + "when": null + }, + "customClass": "", + "description": "", + "displayMask": "", + "inputFormat": "plain", + "placeholder": "", + "autocomplete": "", + "defaultValue": "", + "dataGridLabel": false, + "labelPosition": "top", + "showCharCount": false, + "showWordCount": false, + "calculateValue": "value = data.orgbook.value;\nconsole.log(data.orgbook);", + "calculateServer": false, + "customConditional": "", + "allowMultipleMasks": false, + "customDefaultValue": "", + "allowCalculateOverride": false, + "truncateMultipleSpaces": false + }, + { + "id": "eae6l6", + "key": "credential_id", + "case": "", + "mask": false, + "tags": [], + "type": "simpletextfieldadvanced", + "input": true, + "label": "Credential ID", + "logic": [], + "addons": [], + "errors": "", + "hidden": false, + "prefix": "", + "suffix": "", + "unique": false, + "widget": { + "type": "input" + }, + "dbIndex": false, + "overlay": { + "top": "", + "left": "", + "page": "", + "style": "", + "width": "", + "height": "" + }, + "tooltip": "", + "disabled": false, + "multiple": false, + "redrawOn": "", + "tabindex": "", + "validate": { + "json": "", + "custom": "", + "unique": false, + "pattern": "", + "multiple": false, + "required": false, + "maxLength": "", + "minLength": "", + "isUseForCopy": false, + "customMessage": "", + "customPrivate": false, + "strictDateValidation": false + }, + "autofocus": false, + "encrypted": false, + "hideLabel": false, + "inputMask": "", + "inputType": "text", + "modalEdit": false, + "protected": false, + "refreshOn": "", + "tableView": true, + "attributes": {}, + "errorLabel": "", + "persistent": true, + "properties": {}, + "spellcheck": true, + "validateOn": "change", + "clearOnHide": true, + "conditional": { + "eq": "", + "json": "", + "show": null, + "when": null + }, + "customClass": "", + "description": "", + "displayMask": "", + "inputFormat": "plain", + "placeholder": "", + "autocomplete": "", + "defaultValue": "", + "dataGridLabel": false, + "labelPosition": "top", + "showCharCount": false, + "showWordCount": false, + "calculateValue": "value = data.orgbook.credential_id;\nconsole.log(data.orgbook);", + "calculateServer": false, + "customConditional": "", + "allowMultipleMasks": false, + "customDefaultValue": "", + "allowCalculateOverride": false, + "truncateMultipleSpaces": false + }, + { + "id": "eaxzlt", + "key": "submit", + "size": "md", + "type": "button", + "block": false, + "input": true, + "label": "Submit", + "theme": "primary", + "action": "submit", + "addons": [], + "hidden": false, + "prefix": "", + "suffix": "", + "unique": false, + "widget": { + "type": "input" + }, + "dbIndex": false, + "overlay": { + "top": "", + "left": "", + "style": "", + "width": "", + "height": "" + }, + "tooltip": "", + "disabled": false, + "leftIcon": "", + "multiple": false, + "redrawOn": "", + "tabindex": "", + "validate": { + "custom": "", + "unique": false, + "multiple": false, + "required": false, + "customPrivate": false, + "strictDateValidation": false + }, + "autofocus": false, + "encrypted": false, + "hideLabel": false, + "modalEdit": false, + "protected": false, + "refreshOn": "", + "rightIcon": "", + "tableView": false, + "attributes": {}, + "errorLabel": "", + "persistent": false, + "properties": {}, + "validateOn": "change", + "clearOnHide": true, + "conditional": { + "eq": "", + "show": null, + "when": null + }, + "customClass": "", + "description": "", + "placeholder": "", + "defaultValue": null, + "dataGridLabel": true, + "labelPosition": "top", + "showCharCount": false, + "showWordCount": false, + "calculateValue": "", + "calculateServer": false, + "disableOnInvalid": true, + "allowMultipleMasks": false, + "customDefaultValue": "", + "allowCalculateOverride": false + } + ] +} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 3b6330e..9f55f96 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,9 +13,7 @@ ## Contact Us [ ](https://teams.microsoft.com/l/channel/19%3a34b9d4b4deb54eebaa9be8bc1ccf02f7%40thread.tacv2/CHEFS?groupId=bef8086f-20c7-43a4-bd07-29ce764e818c&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) [ ](https://chat.developer.gov.bc.ca/channel/common-components) -<a href="mailto:submit.digital@gov.bc.ca?subject=Subject%20Line&body=Body%20Text" target="_blank"> - <img src="images/email.png" alt="Image description"> -</a> + *** -[Terms of Use](About/Terms-of-Use) | [Privacy](About/Privacy) | [Security](About/Security) | [Service Agreement](About/Service-Agreement) | [Accessibility](Capabilities/Accessibility) \ No newline at end of file +[Terms of Use](About/Terms-of-Use) | [Privacy](About/Privacy) | [Security](About/Security) | [Service Agreement](About/Service-Agreement) | [Accessibility](Capabilities/Accessibility)