Skip to content

Commit

Permalink
Merge pull request #211 from Volt-MX-GO/zerlordMXGo-100124
Browse files Browse the repository at this point in the history
Zerlord mx go 100124
  • Loading branch information
zerlordsantiago authored and GitHub Enterprise committed Oct 14, 2024
2 parents bf33c71 + 3dd9bf0 commit 8c3a123
Show file tree
Hide file tree
Showing 18 changed files with 135 additions and 171 deletions.
Binary file modified docs/assets/images/didesignaction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/didesigninvoke.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/didesignproj.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/didevice1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/diprojectnamemob.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/howto/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ nav:
- diindex.md
- dicreatenativeapp.md
- configmobile.md
- deleteform.md
- importvoltformula.md
# - deleteform.md
- diagents.md
- VoltFormula:
- vfindex.md
- configrosetta.md
- regunregconfig.md
- clearfunction.md
- importvoltformula.md
- First Touch:
- ftindex.md
- Import First Touch: importft.md
- FTnsfupdate.md
- Operation:
- genindex.md
- codegen.md
- insertattachments.md
- insertattachments.md
- logginglevel.md
- Uninstall:
- uninstall.md
Expand Down
94 changes: 29 additions & 65 deletions docs/howto/clearfunction.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,57 @@
# Clear formulas in Controller and Action Editor
# Clear formulas in controller and Action Editor

--8<-- "mxgoversion.md"
!!!note
The information in this topic applies starting with the Volt MX Go version 2.0.4 release.

## About this task

Shows you how to clear JavaScript code and formulas in **Controller** and **Action Editor**.
Guides you on how to clear JavaScript code and formulas in **controllers** and **Action Editor**.

## Before you begin

- You must read and familiarize yourself with the VoltFormula tutorial.
- You need to use a **Controller** and **Action Editor** in your project to access this feature.
- You have launched Volt MX Go Iris and have opened the project containing the formulas and JavaScript codes you want to delete.
- You need to use **controller** and the **Action Editor** in your project to access this feature.

## Procedure in Controller
## Procedure

### For removing formula using Clear button
### For controllers

1. Go to your **Project** &rarr; **Responsive Web/ Desktop/ Mobile** &rarr; **Controller**.

2. Click the **Controller** you want to change.

3. Click **Clear** to delete the formula and the JavaScript code in the editor.

![Clear button in Formula Editor](../assets/images/vfclearformula.png)

4. A confirmation dialog shows to confirm deletion. Click **Yes** to delete the formula and JavaScript code.

![Delete confirmation dialog](../assets/images/vfdeldialog.png)

The Formula Editor after deleting the formula and the JavaScript code.

![Formula editor after deletion](../assets/images/vfremoveform.png)

### For removing formula using Delete Formula button

1. Go to your **Project** &rarr; **Responsive Web/ Desktop/ Mobile** &rarr; **Controller**.

2. Click the **Controller** you want to change.

3. Right-click on the JavaScript code and select **Delete Formula**.
1. Under the **Controllers** directory, select the controller that contains the formula you want to delete. The **Formula Editor** opens.
2. In the **Formula Editor**, right-click in the JavaScript code and select **Delete Formula** from the context menu.

![Selecting Delete Formula from the context menu](../assets/images/vfclearformula2.png)

4. A confirmation dialog shows to confirm deletion. Click **Yes** to delete the formula and JavaScript code.

![Delete confirmation dialog](../assets/images/vfdeldialog2.png)

The Formula Editor after deleting the formula and the JavaScript code.

![Formula editor after deletion](../assets/images/vfremoveform2.png)


## Procedure in Action Editor

### For deleting formula and JavaScript code using Clear button

1. Go to your **Project** &rarr; **Responsive Web/ Desktop/ Mobile** &rarr; **Forms**. For example, you have created a **Button** on your form.

2. Click **Edit** on **Action** tab. For example, **onClick**.

![Edit button on Action tab](../assets/images/vfbutton.png)

3. The **Action Editor** window opens. Click **Clear** to delete the formula and the JavaScript code in the editor.
3. In the confirmation dialog, click **Yes**.

![Action Editor](../assets/images/vfclearformula3.png)
![Delete confirmation dialog](../assets/images/vfdeldialog2.png)

4. A confirmation dialog shows to confirm delete. Click **Yes** to delete the formula and JavaScript code.
The JavaScript code and its source formula have now been deleted.

![Delete confirmation dialog](../assets/images/vfdeldialog3.png)
You can also click **Clear**, if the **Formula Language** section of the **Formula Editor** is open, to delete the formula and the corresponding JavaScript code.

The **Action Editor** after deleting the formula and the JavaScript code.
![Clear button in Formula Editor](../assets/images/vfclearformula.png)

![Action Editor after completing delete](../assets/images/vfremoveform3.png)
### For Action Editor

### For removing formula using Delete Formula button
1. Under the **Forms** directory, expand the form that contains the widget with the formula you want to delete, and then select the widget, for example a button in your form.
2. Go to the **Properties** tab and select **Action** tab.
4. Click **Edit** next to an event, for example **onClick**. The **Action Editor** opens.

1. Go to your **Project** &rarr; **Responsive Web/ Desktop/ Mobile** &rarr; **Forms**.
![Action tab](../assets/images/vfbutton.png)

2. Click **Edit** on **Action** tab. For example, **onClick**.
5. In the **Action Editor**, click the **Add Formula** diagram component to open the **Formula Editor**.
6. To delete the formula:

![Action tab](../assets/images/vfbutton.png)
- Right-click in the JavaScript code and select **Delete Formula** from the context menu.

3. The **Action Editor** window opens. Right-click on the JavaScript code and click **Delete Formula**.
![Selecting Delete Formula](../assets/images/vfclearformula4.png)

![Selecting Delete Formula](../assets/images/vfclearformula4.png)
OR

4. A confirmation dialog shows to confirm delete. Click **Yes** to delete the formula and JavaScript code.
- Click **Clear** in the **Formula Language** section of the **Formula Editor**.

![Delete confirmation dialog](../assets/images/vfdeldialog4.png)
![Action Editor](../assets/images/vfclearformula3.png)

The **Action Editor** after deleting the formula and the JavaScript code.
6. On the confirmation dialog, click **Yes**.

![Action Editor](../assets/images/vfremoveform4.png)
The JavaScript code and the source formula have now been deleted.
29 changes: 15 additions & 14 deletions docs/howto/configmobile.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,30 @@

## About this task

This procedure describes how to configure the mobile app browser before building and publishing the Native App.
Shows you how to configure the mobile app browser before building and publishing the Native App.

## Before you begin

- You have imported a Domino application into a native app project using Design Import.
- You have launched Volt MX Go Iris and opened your native app project.

## Procedure

1. Go to the **Design** tab.
2. In your **Project**, go to **Forms** and click the **Start-Up form**, for example the `frmLogin`.
1. Click the **Design** tab. 
2. Under **Project**, expand the **Forms** folder and then your start-up form, for example **frmLogin**, until you reach your login button, for example **btnLOGIN**.

![Project tab](../assets/images/didesignproj.png)

3. Click the login button and click the **Properties** tab.
4. Under **Properties**, click the **Action** tab.
5. Click **Edit** next to the **onClick** item. The **Action Editor** opens.
3. Select your login button and then go to the right side of the work area to click **Properties** and select the **Action** tab.
4. Click **Edit** corresponding to the **onClick** action. The **Action Editor** opens.

![Action tab](../assets/images/didesignaction.png)

6. Click the **Invoke service**.

!!!note
The default view is the **Diagram View**. Make sure to select the **Diagram View** tab if it's not already selected.


7. Select **Use Device Browser** under **Select Browser Widget**.
5. On the **Action Editor**, click **Invoke service** in the diagram and then select **Use Device Browser** under **Select Browser Widget**.

![Action Editor](../assets/images/didesigninvoke.png)

8. Click **Save**.
!!!note
The default view in the **Action Editor** is the **Diagram View**. In case you can't see the diagram to select the **Invoke service**, make sure to select the **Diagram View** tab.

6. Click **Save**
2 changes: 1 addition & 1 deletion docs/howto/configrosetta.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configure VoltFormula's Rosetta API Options
# Configure VoltFormula's Rosetta API options

## About this task

Expand Down
73 changes: 28 additions & 45 deletions docs/howto/diagents.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,51 @@
# Show Domino Agents as part of the Design Import app
# Access imported agents in a published Domino app

--8<-- "mxgoversion.md"
!!!note
The information in this topic applies starting with the Volt MX Go version 2.0.3 release.

**Domino Agents** which are part the HCL Domino are part of the `nsf` that only Domino Designer can be able to modify. These `nsf` will be able to use by the Domino REST API to be able to use it for other services. Only those configured Agents in a `nsf` will be available to amend by the Domino REST API. These **Agents** will be imported to Volt MX Go Iris as part of the Design Import.
Agents are stand-alone programs that perform a specific task in one or more Domino databases. Agents are the most flexible type of automation you can add to most design elements in a Domino application. To learn more, see [Agents](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_ABOUT_DESIGNING_AGENTS.html) in the *HCL Domino Designer* documentation.

For more information, see [Agents](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_ABOUT_DESIGNING_AGENTS.html) in the HCL Domino Designer documentation.
!!!note
As of Volt MX Go release v2.0.4, only agents meeting the following conditions can be imported using **Design Import**:

- The agent's trigger type configuration is **action menu selection**.
- The agent's document setting is configured to **All**.

You can include agents in the import when importing a Domino application using **Design Import**. These **agents are imported as actions** and are available in all the views on the imported Domino application.

## About this task

Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import.
Guides you on accessing and using imported agents in a published Domino app.

## Before you begin

- You must read and familiarize yourself with the Design Import tutorial.

## Procedure

You must finish the procedure [importing Domino Application](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app).

!!!important
- For the Volt MX Go release v2.0.4, only limited Agents are supported.
- The Design Import App shows the following conditions for using Domino Agents:
- If the Domino Agents' trigger type configuration is **action menu**.
- If the Domino Agents' document setting is configured to **All**.

**Importing Agents in Volt MX Go Iris using the Design Import capability**
- You have imported a Domino application, including agents, using Design Import to a **Web App project** in Volt MX Go Iris.

- The **Domino Agent** will be imported as **actions**. These will be available on **Views** for all the configured `views` on the imported Domino app.
!!!note
Agents are currently **not supported** for **Native App projects**.

## Expected result
- You have published the imported Domino application using Volt MX Go Iris and opened the published application.

**Sample output on Agents from the imported Domino App using Web App**

In this example, the Domino Agent has the capability to modify the Region.

1. On the **Views**, click the **Customers B ByRegion**.

![Dashboard](../assets/images/diviewagent.png)

The **Customers B ByRegion** will open.

![Customers B ByRegion window](../assets/images/diagentview.png)


2. **Agents** action will be available on the navigation bar. Click the **Agents**.

![Agents context menu](../assets/images/diactions.png)

The four configured Agent will appear as **actions**. These **actions** are imported from the Domino Agent, which is already set up inside the `nsf` file.
## Procedure

3. Click the **actions** *West to East*.
For this procedure, the steps will be based on an example Domino application with agents capable of modifying the region assignment of customers. Although the example Domino application and its agents will differ from your imported Domino application and its agents, the process of accessing and executing the agents will be the same. 

![Select West to East action](../assets/images/diactionclick.png)
1. Upon opening the published application in a browser, you will see the **Dashboard**. From the **Dashboard**, click a view. In the example image, we will click the **Customer B ByRegion** view.

4. It will give a prompt that the Agent has been done processing. Click **OK**.
![Dashboard](../assets/images/diviewagent.png)

![Notification prompt](../assets/images/diagtmsg.png)
2. On the **Customer B ByRegion** page, click **Agents** from the top header to open a context menu showing available agents. In the example image, you can see the available agents.

5. All customers in the *West* Region will move to the *East* Region.
![Agents context menu](../assets/images/diactions.png)

![Customers B ByRegion window](../assets/images/diactionsresult.png)
3. Select an agent. In the example image, the **West to East** agent is selected to move all customers from the West region to the East region.

![Select West to East action](../assets/images/diactionclick.png)

4. On the dialog indicating that the task of the selected agent has been completed, click **OK**.

![Notification prompt](../assets/images/diagtmsg.png)

In the example image, you can see that the task of the selected agent, which is to move all customers from the West region to the East region, has been completed.

![Customers B ByRegion window](../assets/images/diactionsresult.png)
23 changes: 8 additions & 15 deletions docs/howto/dicreatenativeapp.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,32 @@
# Create a new native app project

--8<-- "mxgoversion.md"
# Create a native app project

## About this task

Walks you through the process of creating a new project for a mobile or tablet platform.
Guides you through the process of creating a new project for a mobile or tablet platform.

## Before you begin

- You have launched Volt MX Go Iris.
<!-- You must read and familiarize yourself with the Design Import tutorial.-->
You have launched Volt MX Go Iris.

## Procedure

1. In the top menu of Volt MX Go Iris, select **Project** &rarr; **New Project**.
2. In the **What do you want to start with now?** dialog, select **Native App** and click **Next**.

![What do you want to start with now dialog](../assets/images/didevice.png){: style="height:80%;width:80%"}
![What do you want to start with now dialog](../assets/images/didevice1.png)

3. In the **Which device size do you want to start building for first?** dialog, select **Mobile** or **Tablet** and click **Next**.

![Project Name](../assets/images/distart.png){: style="height:80%;width:80%"}
<!--![Project Name](../assets/images/distart.png){: style="height:80%;width:80%"}-->

4. Enter your **Project Name** and click **Create**.

![Project Name](../assets/images/diprojectnamemob.png){: style="height:80%;width:80%"}
![Project Name](../assets/images/diprojectnamemob.png)

You have now created a new native app project. You can see your project name in the upper-left corner of the **Volt MX Go Iris** canvass.

![New native app project](../assets/images/diappnamemob.png){: style="height:80%;width:80%"}
![New native app project](../assets/images/diappnamemob.png)


!!!tip
For tutorials on how to import Domino applications, see:

- [Import a Domino Application using the new Volt MX Go Foundry app](../tutorials/designimport.md#import-a-domino-application-using-the-new-foundry-app)

- [Import a Domino Application from the existing Volt MX Go Foundry app](../tutorials/designimport.md#import-a-domino-application-from-the-existing-foundry-app)
For more information on importing Domino applications, see the [Design Import tutorial](../tutorials/designimport.md).
9 changes: 6 additions & 3 deletions docs/howto/diindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

How-to guides for instructing users in completing key goals and tasks related to Design Import.

- [Create a new native app project](dicreatenativeapp.md)
- [Create a native app project](dicreatenativeapp.md)

- [Configure mobile app browser](configmobile.md)

- [Access imported agents in a published Domino app](diagents.md)

<!--
- [Delete existing forms while using the Design Import wizard](deleteform.md)
- [Integrate VoltFormula function with Design Import's actions](importvoltformula.md)

- [Show Domino Agents as part of the Design Import app](diagents.md)
-->
5 changes: 4 additions & 1 deletion docs/howto/genindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,7 @@ How-to guides for instructing users in completing key goals and tasks related to

- [Insert attachments via Summernote Editor](insertattachments.md)

- [Set logging level](logginglevel.md)


- [Set logging level](logginglevel.md)

Loading

0 comments on commit 8c3a123

Please sign in to comment.