Workflow Composer

A single instance of Workflow Composer can be used to work with Anthology Student, CampusNexus CRM, and Forms Builder.

To enable this behavior in CampusNexus CRM:

1. In the Web.config file of CampusNexus CRM Web Client, change the database details of the ‘dbconnection’ key of Workflow Composer to the value that’s set in Anthology Student:

   <add name="dbConnection" providerName="System.Data.SqlClient" connectionString="data Source=<Name of the Anthology Student database>;initial catalog=<Name of the CampusNexus CRM database>;Integrated Security=SSPI;Persist Security Info=False;Pooling=True;MultipleActiveResultSets=True;Application Name=Workflow Composer;"/>

2. Make the same change in the Web.config file of the following iServices:

   • Account Iservice
   • Cof Iservice
   • Contact Iservice
   • HEFoundation Iservice
   • Report Iservice
   • Portal Iservice
   • Utils Iservice
   • Interaction Iservice

3. Ensure that Application Pool Identity Users of CampusNexus CRM Web Client and iServices are available in Anthology Student’s database. They must have login permissions in Anthology Student and read permissions to its database. For more information, see Application Pool Identity and Integrated Security.

4. To consume events triggered from Web Client and iServices in Workflow Composer, set the value of the Workflow Integrated parameter to True in the Web.config file (Web Client and iServices). By default, its value is False.

Install Workflow Composer

Install Using Installation Manager

Ellucian 1.x customers install the Workflow Composer from DevOps pipeline (Standalone pipeline or clubbed with Student and FormsBuilder pipeline).

Ellucian Cloud on-premises customers install Workflow Composer from Installation Manager.

1. Click the Package Manager tile in the Start screen of Installation Manager.

   

2. Download the package for Workflow Composer.

   

3. When the download is completed, return to the Start screen of Installation Manager.

4. Click the Workflow tile in the Start screen. File Manager displays the SetupFiles folder containing the Workflow Setup.exe file.

   

   After retrieving the installer, you can run the Workflow Setup.exe directly or copy and distribute it to other users within your organization.

5. Double-click the Workflow Setup.exe file. The Workflow Setup screen is displayed.

   

6. Click Install. The Setup Progress screen is displayed. You are notified if a previous installation of Workflow Composer is detected.

   

7. Click Next to continue. The API key and database settings screen is displayed.

   

8. In the API key database settings screen, specify the following:

   • Api Key (Package Manager Customer Key) - This is the same key that is used in the Package Manager screen of Installation Manager.

   • Database Server

   • Database

   Select Use Integrated Security or specify the Username and Password for the database.

   Click Test to verify database access. If the test was successful, click Next to continue.

   

9. (Optional) In the SMTP settings screen, specify the following if you want the application to be able to send emails to the intended recipients:

   • SMTP Server

   • SMTP Port (default: 25)

   • If applicable, select Use credentials to authenticate and specify the Username and Password.

   • If applicable, select Enable SSL.

   

10. Click Next. The installation process starts. Click Close when Workflow Composer has been successfully installed.

    

11. Click the Workflow icon on your desktop to open Workflow Composer. Note that the status bar at the bottom left indicates the Workflow Composer version and database connection.

Install Using ClickOnce

Ellucian Cloud 2.0 customers install Workflow Composer using a ClickOnce application. ClickOnce allows self-updating Windows-based applications to be installed and run with minimal user interaction. Users install Workflow Composer with one click on the Install button or launch it from a website.

For details about the ClickOnce URL and login credentials, refer to https://filetransfer.campusmgmt.com > softwareupdates > Workflow Composer > WF_ComposerInstallationSteps.pdf. (VERIFY)

Depending on the settings and antivirus/malware software installed on your machine and your corporate policies, you may see a warning when installing Workflow Composer and its Activities and Contracts packages.

Troubleshooting

During installation of Workflow Composer, you may encounter errors if a previous version is still installed on the system. To resolve this, uninstall the earlier version before installing the latest release using the below steps.

1. Uninstall the Previous Version.

   • Open the Control Panel

   • Navigate to Programs and Features

   • Locate Workflow Composer (version 24.0)

   • Right-click on it and select Uninstall to remove the existing version

2. Delete Old File References (Cloud 2.X customers)

   • Navigate to the following path on your system: C:\Users\<logged-in user>\AppData\Local\2.0\

   • In this directory, you will find folders with random names along with a folder named Data

   • Delete all folders except the “Data” folder to remove residual references from the previous installation

3. Delete Old File References (On-Prem customers)

   • Navigate to the following path on your system: C:\Program Files (x86)\CMC\Workflow

   • In this directory, you will find folders with random names along with a folder named Data

   • Delete all the files and folders to remove residual references from the previous installation.

After completing above steps, proceed to install the latest version of Workflow Composer.

When you use the Workflow Web API, you must log in to your Ellucian Cloud 2.0 account in the Azure Active Directory (AAD).

In case of a service interruption or incorrect configuration, a message similar to the following will be displayed.

After you click OK, you can launch Workflow Composer again and the Configuration window will be displayed again. You can change the Web API Configuration and log into your account.

Your user profile in the Ellucian Cloud 2.0 AAD is associated with a role.

• The Contributor role allows you to add/publish, delete, and edit workflows.

• The Reader role allows you to view workflows.

  As a Reader, you can modify a workflow and save it to the file system. But you cannot publish it. If you try to publish or delete a workflow or persisted instance, Workflow Composer returns the message: "You are not authorized to perform this action."

If you are not associated with either role, you will need to contact a System Administrator as you will not have access to the application.

Install Activities and Contracts

After installing Workflow Composer, you need install Activities and Contracts that match the versions of Anthology Student, CampusNexus CRM, and/or Forms Builder in your environment.

Note: If you installed Workflow Composer using ClickOnce with auto update, previously installed packages are removed and need to be reinstalled.

1. In the ribbon of Workflow Composer, click Package Manager. Click Yes to close Workflow Composer.

2. In the Package Manager screen, check the address of the Package Manager Host. If necessary, edit the address and click Update.

   

3. In the Available Packages section, locate the Activities and Contracts to be used with Workflow Composer in your environment. The packages are product and version specific.

   You can install only one version of a specific package type.

   Anthology Student requires two packages. For example, if your Anthology Student environment is at version 25.3.0, install Activities and Contracts (V1) 25.3.0 and Activities and Contracts (V2) 25.3.0.

   With Workflow Composer 4.x and Anthology Student 25.x and later, you need to install both the V2 Activities and Contracts and the V1 Contract packages. If you have workflows with V1 Activities, warning messages will be displayed when you select or run a workflow. See Run Time Messages About V1 Activities in Workflow Help. If workflows that contain V1 Activities have not been updated prior to upgrading to Anthology Student 25.x and installing 25.x Activities and Contracts packages, perform the following steps: Uninstall the V1 and V2 packages for 25.x. Import an earlier version of V1 and V2 packages. Update the workflows to replace the V1 activities. Re-import the 25.x packages. The packages for Anthology Student 25.x and later will only contain the V1 Contracts and not the Activities.

4. Click to install each package. The installed packages will be listed in the Currently Installed Packages section.

   To remove a package, click in the Currently Installed Packages section.

5. Click Done to close Package Manager.