Configuration
For details about the installation of Workflow Composer, please refer to Installation Manager Help. |
Once Workflow Composer 4.x is installed, you need to specify whether it accesses the databases via direct connections or via a Workflow Web API.
-
In an Anthology Cloud 2.0 environment, configure the Workflow Web API Connection. The Workflow Web API replaces the Citrix connections used previously in cloud environments.
-
In on-premise or Azure (non-Anthology Cloud 2.0) environments, configure Direct Database Connections.
The configuration needs to be done only once when Workflow Composer is installed the first time. The settings are retained during upgrades.
Workflow Composer 4.0.1 introduces the option to change the configuration upon launching the application. You can choose to Connect to the previously configured environment or change the configuration to access a different environment.
If you change the configuration, the following message appears. When you click OK, Workflow Composer will restart and connect to the newly configured host. It will take a few seconds to start.
On initial start up, the Configuration window displays Connect and Exit buttons. When you select Connect after you have configured the connection, Workflow Composer will launch and connect to the configured host. If you select Exit, Workflow Composer will not launch.
Once Workflow Composer has been launched, the Configuration window displays Connect and Close buttons. You can update the existing configuration and select Connect to continue working with the updated configuration. If you click Close, the Configuration window will close.
After you click the button at the top of the Configuration window, you can open the Configuration window again and change the configuration details if needed.
Direct Database Connections
If you are using Workflow Composer with on-premises databases connections:
-
Select Direct connection with the database.
-
Specify the server names and database names for your database connections.
-
The Workflow Database is the database that supplies values to your workflow activities. It can be an Anthology Student or CampusNexus CRM database.
-
The Durable Instancing Database typically uses the same server and database as the Workflow Database.
- (Optional) The Tracking Database is named "WorkflowTracking" by default. It can be on the same server as the Workflow Database and the Durable Instancing Database.
-
-
In the API Key field, specify the key you use to access Anthology Activities and Contracts packages.
-
(Optional) In the CRM Configuration section, specify the following:
-
CRM Main Database Server and Database
-
CRM Web Client URL
By default, the CRM Configuration section will be blank.
Integrated security will be used for the connection information.
When the Server and Database are populated under the CRM Main Database, a connection string will be created in the Workflow configuration file named CRMdbconnection.
<connectionStrings> <clear /> <add name="LocalSqlServer" connectionString="data source=.\SQLEXPRESS;Integrated Security=SSPI;AttachDBFilename=|DataDirectory|aspnetdb.mdf;User Instance=true" providerName="System.Data.SqlClient" /> <add name="dbConnection" connectionString="Data Source=<server>;Initial Catalog=<database>;Integrated Security=True;Application Name="Workflow Composer"" providerName="System.Data.SqlClient" /> <add name="WorkflowDurableInstancingConnection" connectionString="Data Source=<server>;Initial Catalog=<database>;Integrated Security=True;Pooling=True;MultipleActiveResultSets=True;Application Name="Workflow Composer"" providerName="System.Data.SqlClient" /> <add name="WorkflowTrackingConnection" connectionString="Data Source=<server>;Initial Catalog="Workflow Tracking";Integrated Security=True;Persist Security Info=False;Pooling=True;MultipleActiveResultSets=True;Application Name="Workflow Composer"" providerName="System.Data.SqlClient" /> <add name="CrmDbConnection" connectionString="Data Source=<server>;Initial Catalog=<database>;Integrated Security=True;Persist Security Info=False;Pooling=True;MultipleActiveResultSets=True;Application Name="Workflow Composer"" providerName="System.Data.SqlClient" /> </connectionStrings>
When the CRM Web Client URL is populated, an additional appSettings key will be added in the Workflow configuration file.
<appSettings file=""> <clear /> <add key="DataMapperAssembly" value="Cmc.CampusLink.BusinessEntities, Culture=neutral, PublicKeyToken=<token>" /> <add key="ConfigureCampusNexusWcfProxy" value="true" /> <add key="ConfigureCVueNexusWcfProxy" value="true" /> <add key="apiKey" value="<key>" /> <add key="StudentWebClientUrl" value="https://<server>.<domain>:<port>" /> <add key="CrmWebClientUrl" value="https://<server>.<domain>:<port>/" /> </appSettings>
-
-
Click Save.
-
Click Yes to proceed. Workflow Composer will restart.
Workflow Web API Connection
If you are using Workflow Composer in an Anthology Cloud 2.0 environment:
-
Select Use the Workflow Web API.
-
Specify your Student Web Client URL, i.e., https://<server>.<domain>:<port>. This URL provides access to the server where the Workflow Web API is deployed.
The remaining fields are disabled.
Workflow Composer 3.1 and later supports dual tenancy in Azure AD. This enables Anthology support staff to log in to a customer environment to diagnose an issue. Anthology staff append account/login/cmc to the Anthology Student URL value to use a different authentication context for the same environment.
Tenant Student Web Client URL Sign in Logo Azure AD Tenant (Customer) https://<server>.<domain>:<port>.
campusnexus.cloud/Support Tenant (Anthology Staff) https://<server>.<domain>:<port>.
campusnexus.cloud/account/login/cmc -
Click Save.
-
Click Yes to proceed. Workflow Composer will restart.
When you use the Workflow Web API, you must log in to your Anthology Cloud 2.0 account in the Azure Active Directory (AAD).
In case of a service interruption or incorrect configuration, the following message 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 Anthology Cloud 2.0 AAD must be 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 you have configured Workflow Composer, install the Activities and Contracts required for you environment. See Package Manager.
For details about the installation of Workflow Composer, please refer to Installation Manager Help. |
Once Workflow Composer is installed, you need to specify whether it accesses the databases via direct connections or via a Workflow Web API.
-
In an Anthology Cloud 2.0 environment, configure the Workflow Web API Connection. The Workflow Web API replaces the Citrix connections used previously in cloud environments.
-
In on-premise or Azure (non-Anthology Cloud 2.0) environments, configure Direct Database Connections.
The configuration needs to be done only once when Workflow Composer is installed the first time. The settings are retained during upgrades.
The System tab in the ribbon of Workflow Composer provides a Configuration option that enables you to change the initial configuration.
If you are using Workflow Composer with on-premises databases connections:
-
Select Direct connection with the database.
-
Specify the server names and database names for your database connections.
-
The Workflow Database is the database that supplies values to your workflow activities. It can be an Anthology Student or CampusNexus CRM database.
-
The Durable Instancing Database typically uses the same server and database as the Workflow Database.
- (Optional) The Tracking Database is named "WorkflowTracking" by default. It can be on the same server as the Workflow Database and the Durable Instancing Database.
-
-
In the API Key field, specify the key you use to access Anthology workflow Activities and Contracts packages.
-
Click Save.
-
Click Yes to proceed. Workflow Composer will restart.
If you are using Workflow Composer in an Azure cloud environment with Anthology Cloud 2.0:
-
Select Use the Workflow Web API.
-
Specify your Student Web Client URL, i.e., https://<server>.<domain>:<port>. This URL provides access to the server where the Workflow Web API is deployed.
The remaining fields are disabled.
Workflow Composer 3.1 and later supports dual tenancy in Azure AD. This enables Anthology support staff to log in to a customer environment to diagnose an issue. Anthology staff append account/login/cmc to the Anthology Student URL value to use a different authentication context for the same environment.
Tenant Student Web Client URL Sign in Logo Azure AD Tenant (Customer) https://<server>.<domain>:<port>.campusnexus.cloud/ Support Tenant (Anthology Staff) https://<server>.<domain>:<port>.campusnexus.cloud/account/login/cmc -
Click Save.
-
Click Yes to proceed. Workflow Composer will restart.
When you use the Workflow Web API, you must log in to your Anthology 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. You will have the option to return to the Configuration window.
“The system is unable to perform authentication. You may need to contact your System Administrator.
However, the issue may be the configuration, would you like to review?"
Your user profile in the Anthology Cloud 2.0 AAD must be 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 you have configured Workflow Composer, install the Activities and Contracts required for you environment. See Package Manager.
For details about the installation of Workflow Composer, please refer to Installation Manager Help. |
Once Workflow Composer is installed, you need to specify whether it accesses the databases via direct connections or via a Workflow Web API.
-
In an Anthology Cloud 2.0 environment, configure the Workflow Web API Connection. The Workflow Web API replaces the Citrix connections used previously in cloud environments.
-
In on-premise or Azure (non-Cloud 2.0) environments, configure Direct Database Connections.
The configuration needs to be done only once when Workflow Composer is installed the first time. The settings are retained during upgrades.
The System tab in the ribbon of Workflow Composer provides a Configuration option that enables you to change the initial configuration.
If you are using Workflow Composer with on-premises databases connections:
-
Select Direct connection with the database.
-
Specify the server names and database names for your database connections.
-
The Workflow Database is the database that supplies values to your workflow activities. It can be an Anthology Student or CampusNexus CRM database.
-
The Durable Instancing Database typically uses the same server and database as the Workflow Database.
- (Optional) The Tracking Database is named "WorkflowTracking" by default. It can be on the same server as the Workflow Database and the Durable Instancing Database.
-
-
In the API Key field, specify the key you use to access Anthology workflow Activities and Contracts packages.
-
Click Save.
-
Click Yes to proceed. Workflow Composer will restart.
If you are using Workflow Composer in an Azure cloud environment with Anthology Cloud 2.0:
-
Select Use the Workflow Web API.
-
Specify your Student Web Client URL, i.e., https://<server>.<domain>:<port>. This URL provides access to the server where the Workflow Web API is deployed.
The remaining fields are disabled.
Workflow Composer 3.1 and later supports dual tenancy in Azure AD. This enables Anthology support staff to log in to a customer environment to diagnose an issue. Anthology staff append account/login/cmc to the Anthology Student URL value to use a different authentication context for the same environment.
Tenant Student Web Client URL Sign in Logo Azure AD Tenant (Customer) https://<server>.<domain>:<port>.campusnexus.cloud/ Support Tenant (Anthology Staff) https://<server>.<domain>:<port>.campusnexus.cloud/account/login/cmc -
Click Save.
-
Click Yes to proceed. Workflow Composer will restart.
When you use the Workflow Web API, you must log in to your Anthology 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. You will have the option to return to the Configuration window.
“The system is unable to perform authentication. You may need to contact your System Administrator.
However, the issue may be the configuration, would you like to review?"
Your user profile in the Anthology Cloud 2.0 AAD must be 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 you have configured Workflow Composer, install the Activities and Contracts required for you environment. See Package Manager.