Initial Deployment Steps

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:

SourceDescription
CSI_RosterManager_ActionWhen users submit a request using the iPart, an entry is saved into CSI_RosterManager_Action as summary information.
CSI_RosterManager_ActionItemDetails regarding the request are saved into CSI_RosterManager_ActionItem.
CSI_RosterManager_ActionDetailsFor 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 nameProperty typeLengthData to be stored
ActionKeyText36Unique identifier (GUID) - Primary Key
CodeText30Workflow action code
StatusText1Status of transaction A - Active B - Busy C - Cancelled D - Done E - Error
MessageText4000Response message
ExceptionText4000Exception error
DateAddedDate and TimeUTC date and time record was added
LastUpdatedDate and TimeUTC 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 nameProperty typeLengthData to be stored
ActionKeyText36Unique identifier (GUID) tie back to Activity record
ItemKeyText36Unique identifier (GUID) - Primary Key
SelectedIdText10(Effected) iMIS ID of the person being selected (altered/changed)
BlobUpload FileWorkflow definition compressed and serialized
StatusText1Status of transaction A - Active B - Busy C - Cancelled D - Done E - Error
MessageText4000Response message
ExceptionText4000Exception error
DateAddedDate and TimeUTC date and time record was added
LastUpdatedDate and TimeUTC 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 nameProperty typeLengthData to be stored
ActionText100Action "code" or "label" to see the action that was selected
TransactionDateDateCurrent Date when action was taken
LoggedInUserIDText40Logged in User that completed action
CompanyIDText40Selected ID where the action was completed
Date1DateAnswer to a date field using in additional info section
Date2DateAnswer to a date field using in additional info section
Date3DateAnswer to a date field using in additional info section
File1File UploadFile added in additional info section
File2File UploadFile added in additional info section
File3File UploadFile added in additional info section
Text1Text500Answer to a text field used in additional info section
Text2Text500Answer to a text field used in additional info section
Text3Text500Answer 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 - Depending on the region, enter one of the following:
    4. Click Save & Continue.
    5. Code - ROSTERMANAGER_FUNCTIONKEY
    6. Description -
      • United States - dbDTag3q1VZMp-RR1d8atkeARraTgxikvTA-5pvxtsANAzFum7WPCA==

      • Canada - s4hL-G6mvcDtZgU-Yd6SA7pPVVtLpPCMQ4VKaM8oCW28AzFuSl6lMA==

      • Asia Pacific - H6R6Eq6fBx9IYHtPw1KAkKuaktsMd9dNW7uxGvLBYULjAzFuy8tJwQ==

      • United Kingdom - 5R8obwO8v8gNGjIDmNITjajJfrscyCScPlke63O_U9oWAzFuNBnVog==

    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 - Depending on the region, enter one of the following:
    4. URL to the html file that is used to configure content items of this type - Depending on your region, enter one of the following:


Did this page help you?