Roster Manager - Initial Deployment Steps
Once you have purchased the Roster Manager iPart, a few initial deployment steps are required.
1. Create Panel Sources
When users submit a request via the iPart, an entry is saved into CSI_RosterManager_Action as summary information. Details regarding the request are saved into CSI_RosterManager_ActionItem.
Create 2 panel sources under RiSE > Panel Designer > Add Panel Definition
CSI_RosterManager_Action
Panel Name = CSI_RosterManager_Action
Parent Type = Contact
Select Multi-Instance
Select Create Source
Source Name = CSI_RosterManager_Action
Add the following Field Properties
Property Name | Property Type | Length | Data to be stored |
---|---|---|---|
ActionKey | Text | 36 | Unique identifier (GUID) - Primary Key |
Code | Text | 30 | Workflow action code |
Status | Text | 1 | Status of transaction A - Active |
Message | Text | 4000 | Response message |
Exception | Text | 4000 | Exception error |
DateAdded | Date and Time | UTC date and time record was added | |
LastUpdated | Date and Time | UTC date and time record was last updated |
CSI_RosterManager_ActionItem
Panel Name = CSI_RosterManager_ActionItem
Parent Type = Contact
Select Multi-Instance
Select Create Source
Source Name = CSI_RosterManager_ActionItem
Add the following Field Properties
Property Name | Property Type | Length | Data to be stored |
---|---|---|---|
ActionKey | Text | 36 | Unique identifier (GUID) tie back to Activity record |
ItemKey | Text | 36 | Unique identifier (GUID) - Primary Key |
SelectedId | Text | 10 | (Effected) iMIS ID of the person being selected (altered/changed) |
Blob | Upload File | Workflow definition compressed and serialized | |
Status | Text | 1 | Status of transaction A - Active |
Message | Text | 4000 | Response message |
Exception | Text | 4000 | Exception error |
DateAdded | Date and Time | UTC date and time record was added | |
LastUpdated | Date and Time | UTC date and time record was last updated |
An additional panel source to store client specific action detail is recommended but not required. The above panel sources are used for logging and tracking purposes only. For easier reporting of the action detail each time the Roster Manager iPart is used, it is recommended to create a Panel Source that will store the action details specific to the user record that was selected for the action. This panel source is also a good place to store the answers to the additional information questions that will be used within the iPart. See "Information" section below.
Example Panel Source
CSI_RosterManager_ActionDetails
Panel Name = CSI_RosterManager_ActionDetails
Parent Type = Contact
Select Multi-Instance
Select Create Source
Source Name = CSI_RosterManager_ActionDetails
Field Properties
Add other field types based on the data from the additional info section that you want to store, i.e. decimal, integer, yes_no, etc.
*Note - Remember that there is no need to add ID or Ordinal fields as those fields are automatically created when creating the panel source.
Property Name | Property Type | Length | Data to be stored |
---|---|---|---|
Action | Text | 100 | Action "code" or "label" to see the action that was selected |
TransactionDate | Date | Current Date when action was taken | |
LoggedInUserID | Text | 40 | Logged in User that completed action |
CompanyID | Text | 40 | Selected ID where the action was completed |
Date1 | Date | Answer to a date field using in additional info section | |
Date2 | Date | Answer to a date field using in additional info section | |
Date3 | Date | Answer to a date field using in additional info section | |
File1 | File Upload | File added in additional info section | |
File2 | File Upload | File added in additional info section | |
File3 | File Upload | File added in additional info section | |
Text1 | Text | 500 | Answer to a text field used in additional info section |
Text2 | Text | 500 | Answer to a text field used in additional info section |
Text3 | Text | 500 | Answer to a text field used in additional info section |
2. Create General Lookup Validation Tables
When the iPart sends a request to Azure to complete a workflow process, the following information is used to validate your Roster Manager iPart license.
Create 2 tables under Settings > General lookup tables
Table Name = CSI_CLOUDID
Add a single entry
Code = Cloud ID provided by CSI at time of purchase (Ex: DEVIMIS)
Description = iMIS URL (Ex: devems.csiinc.com)
Note: If you have multiple domain names that need to refer to the same CSI Cloud ID instance you can add another general lookup entry in the CSI_CLOUDID table and use the Expansion field to store the CSI Cloud ID. In this case the Code value will be discarded, and the Expansion value will be substituted instead. For example:Code = DEVIMIS203A
Description = devems-staging.csiinc.com
Expansion = DEVIMIS203
Table Name = CSI_CLOUDAPP
Entry 1
Code = ROSTERMANAGER_FUNCTIONURL
Description = https://rostermanager-fn.cloud.csiinc.com
Entry 2
Code = ROSTERMANAGER_FUNCTIONKEY
Description = Q-_1wMx_HuViERHAaYvCE_fEJFg0yKxTuudiVHP6VCedAzFuRJ-KYg==
3. Create Content Type
Create new content type under RiSE > Maintenance > Content Types
Select the Custom folder
Select New > Content Type
Select Client-based (preferred)
Name of Content Type = CSI Roster Manager
Description of Content Type = CSI Roster Manager - iPart
URL to the html file that is used to display items of this type at runtime = https://cdn.cloud.csiinc.com/apps/roster-manager/display.html
URL to the html file that is used to configure content items of this type = https://cdn.cloud.csiinc.com/apps/roster-manager/configure.html