Initial Deployment Steps

iMIS Power Suite - Roster Manager

Once you have purchased the Roster Manager iPart, the following deployment steps are required:

  1. Create the panel sources
  2. Create the general lookup tables
  3. Create the content type

1. Creating the panel sources

The following panel sources must be created:

Source Description
CSI\_RosterManager\_Action When users submit a request using the iPart, an entry is saved into CSI\_RosterManager\_Action as summary information.
CSI\_RosterManager\_ActionItem Details regarding the request are saved into CSI\_RosterManager\_ActionItem.
CSI\_RosterManager\_ActionDetails For easier reporting of the action detail each time the Roster Manager iPart is used, the CSI\_RosterManager\_ActionDetails source 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.

Do the following to create the panel sources:

  1. Go to RiSE > Panel Designer > Panel sources.
  2. Select Add new panel source:
    • Source name - CSI_RosterManager_Action
    • Parent type - Contact
    • Multi-instance - Enabled
  3. Click Save.
  4. Select Add new property, and add the following 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 B - Busy C - Cancelled D - Done E - Error
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
  1. Go back to RiSE > Panel Designer > Panel sources.
  2. Select Add new panel source:
    • Source name - CSI_RosterManager_ActionItem
    • Parent type - Contact
    • Multi-instance - Enabled
  3. Click Save.
  4. Select Add new property, and add the following 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 B - Busy C - Cancelled D - Done E - Error
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
  1. Go back to RiSE > Panel Designer > Panel sources.
  2. Select Add new panel source:
    • Source name - CSI_RosterManager_ActionDetails
    • Parent type - Contact
    • Multi-instance - Enabled
  3. Click Save.
  4. Select Add new property, and add the following properties:
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
  1. 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.

2. Creating the general lookup tables

When you complete a workflow using the Roster Manager iPart, iMIS checks your license information to make sure it’s valid.

Do the following to create the tables:

  1. Go to Settings > General lookup tables.
  2. Select Add new table:
    • Table name - CSI_CLOUDID

    • Code - Cloud ID provided by ASI at time of purchase (e.g., DEVIMIS)

    • Description - The iMIS URL.

      🚧

      Warning

      Do not include https:// at the beginning of the URL.

      • If you plan on using Roster Manager across more than one of your organizations' sites, then it is recommended to use the root domain of the iMIS URL to cover all subdomains. For example:
      • If you have multiple domain names referring to the same Cloud ID instance, you can add another general lookup entry in the CSI_CLOUDID table and use the Expansion field to store the Cloud ID. In this case the Code value will be discarded, and the Expansion value will be substituted instead. For example:
  3. Click Save & Continue.
  4. Click Close.
  1. From the General tables drop-down, choose (None selected).

  2. Select Add new table:

    1. Table name - CSI_CLOUDAPP
    2. Code - ROSTERMANAGER_FUNCTIONURL
    3. Description - https://rostermanager-fn.cloud.csiinc.com
    4. Click Save & Continue.
    5. Code - ROSTERMANAGER_FUNCTIONKEY
    6. Description - Q-_1wMx_HuViERHAaYvCE_fEJFg0yKxTuudiVHP6VCedAzFuRJ-KYg==
    7. Click Save & Continue.
    8. Click Close.

3. Creating the content type

Do the following to create a new content type:

  1. Go to RiSE > Maintenance > Content types.

  2. Select the Custom folder.

  3. Select New > Content Type.

  4. Select Client-based (preferred):

    1. Name of Content Type - CSI Roster Manager
    2. Description of Content Type - CSI Roster Manager - iPart
    3. 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
    4. 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