App Workflow
Use this function to can create a workflow for an app. This workflow will be shown to the users in SmartAnalyzer after they have chosen the app. This way you can give the users of the app a step-by-step guide on how to work with the app.
Step-by-Step
- To create a workflow select New in the File tab. Alternatively, you can click the New icon in the Quick Access Toolbar.
- In the New SmartAnalyzer App SDK Project dialog box select App Workflow.
- Enter a name for the SmartAnalyzer App SDK Project. The name has to comply with the Windows guidelines for file and folder names.
- Select the location of the file to be created by clicking the Browse button.
- Click OK. A new dialog box is opened.
- In the General area the name, the author and the version number are shown. You can change them. The name is the content item name in SmartAnalyzer, the maximum length is 128 characters. You do not have to consider any Windows guidelines when entering the name, any character is allowed.
- Enter the minimum version of IDEA which supports the audit test in the Minimum IDEA Version field. By default, the lowest version number for which an app definition could be created is shown. If you enter a lower number it will be changed automatically.
-
Supports Unicode specifies whether the Standard Import Routine is compatible with the IDEA Unicode version or not. Setting this property to Yes means that the Standard Import Routine will always be executed. Selecting No means that a Standard Import Routine will not be displayed in case an IDEA Unicode version is installed. You may choose this setting if a command was used which is not supported by IDEA Unicode (@ASCII, @CHR, @RegExpr, @Soundex and @SoundsLike).
- Activate the check box Use Long Action Descriptions if you want to enter a long description (more than 100 characters) for actions. This option can only be used for IDEA 10.3 or higher.
- Click the button in the Workflow Definition field to define a workflow you recommend for working with the app. The Workflow Actions dialog box appears.
-
If one or more embedded dialog boxes are needed for the macro, you can select them by clicking the button within the Embedded Dialogs field. A dialog box is opened where you can choose one or more Visual Studio projects.
Provided that the app workflow includes the embedded dialog "TestDialog", the script to invoke it looks like this:
Dim dialogInvoker As Object
Dim args As Object
Set dialogInvoker = SmartContext.GetServiceById("MacroDialogInvoker")
If not dialogInvoker is nothing then
Set args = dialogInvoker.NewTaskParameters
dialogInvoker.PerformTask("TestDialog",args)
End If
- In the Content Item Filter area you can assign Standard Import Routines, Data Requests, Audit Test Navigator trees and Report plug-ins to the workflow. To do so click the Browse button to open the corresponding dialog box. If you enter a property, all Standard Import Routines, Data Requests, Audit Test Navigator trees or report plug-ins containing the same property as the one you have entered will be shown in the workflow.
- In the Compatibility Indicator field you can enter a group of string values used later to enable the merging of app workflows. App workflows can be merged if they have at least one compatible indicator value in common.
Working with SmartAnalyzer App SDK Projects you can use a context menu by right-clicking on a card-index tab.
In the context menu for content items you can select the following tasks:
| Command | Description |
|---|---|
| Close | Closes the current content item tab. If the tab is not saved, you will be asked whether you want to save it or not. |
| Close all | All currently opened content items will be closed. If one of them is not saved yet, you will be asked whether you want to save it or not. |
| Close all except this | Closes all content item tabs except the one the command was called from. If one of the content item tabs to be closed is not saved yet, you will be asked whether you want to save it or not. |
| Duplicate content item | This command duplicates an existing content item. A dialog box opens where you can enter a name for the content item. The duplicated content item gets a new unique ID. |
| Create Labeled Import Routine | This command is only active for Standard Import Routines. The command creates a new content item of type "Labeled Import Routine". In this case the project folder can only be created when saving the properties grid context. Only in this case the name of the new project is known. |
| Create app based on opened items | This command allows creating a demo app. In contrast to creating testing apps, apps created with this command will be IP protected and will have their own fixed icon and its own fixed app ID. This function is only available as of IDEA version 10.1. |
| Open folder | Opens the project folder of the currently selected content item in Windows explorer. |