Updating the ILST

This article describes how to update the ILST to a new version. You should always be running the most recent version of the ILST to ensure that:

  • It continues to function as expected.  
  • You can receive support should an issue arise; only the most recent version of the ILST is supported.

Sections in this article:

Requirements

To update the ILST, you require:

  • Access to where your organization runs the ILST from.
  • Be a Customer Care member, which gives you access to download the ILST.

How to update the ILST

1. Update your ILST files to the latest version

  1. Back up your existing ILST folder by creating a copy of it and its contents. You should now have two ILST folders, a primary one that will be updated and a backup one that you can revert to should you not be able to do the update immediately.
  2. Download the latest version of the ILST.
  3. Copy the following files from the downloaded ILST folder into your primary ILST folder, replacing the older files:
    • ILST.exe
    • Newtonsoft.Json.dll
    • NLog.config
    • NLog.dll
    • NLog.xml

2. Test the ILST to make sure it functions as expected

  1. Open the config.xml file located in your primary ILST folder.
  2. Put the ILST into test mode by giving <TestMode> a value of true. For example:
    <TestMode>true</TestMode>
    
  3. Save your change to the config.xml file.
  4. Run the ILST by double-clicking ILST.exe. Since the ILST is in test mode, it will not make changes to your digital workplace.
  5. Once the ILST finishes running, open ILST.log and verify that it finished without any issues.

3. Manually run the ILST

  1. Open the config.xml file located in your primary ILST folder.
  2. Take the ILST out of test mode by  <TestMode> a value of false. For example:
    <TestMode>false</TestMode>
    
  3. Save your change to the config.xml file.
  4. Run the ILST by double-clicking ILST.exe. With the ILST out of test mode, the ILST will sync to your digital workplace.
  5. Once the ILST finishes running, open ILST.log and verify that it finished without any issues.

4. Cleanup

  • Delete the ILST folder that you downloaded and copied files from.
  • Delete the backup ILST folder that you created.
  • If you have set the ILST to run as a scheduled task, verify that the task still functions. For information about using Microsoft Task Scheduler, see Using Task Scheduler to run the ILST.

Optional update for <ManagerAttribute>

Older config.xml files may not contain the elements necessary for syncing manager information. If you have an old config file and would like to sync this information to your digital workplace, you must edit your config.xml file and make the following changes.

Change 1: Adding the <ManagerAttribute> element to each <UserAccount> element

Within each <UserAccount> element, add the <ManagerAttribute> element between the <SurnameAttribute> and <ProfilePictureAttribute> elements. For example:

<SurnameAttribute>        
    <ActiveDirectoryName>sn</ActiveDirectoryName>
    <IglooName>lastname</IglooName>
    <DataTypeParser>DirectString</DataTypeParser>
</SurnameAttribute>
<ManagerAttribute>
    <ActiveDirectoryName>manager</ActiveDirectoryName>
</ManagerAttribute>
<ProfilePictureAttribute>
    <ActiveDirectoryName>thumbnailPhoto</ActiveDirectoryName>
    <DataTypeParser>RawBytes</DataTypeParser>
</ProfilePictureAttribute>

Change 2: Adding manager elements to the <CommunityApi> element

Within the <CommunityApi> element, add<ManagerNameFieldName> and <ManagerEmailFieldName> elements after <ProfileBatchSize>.

<CommunityApi>
    <Domain>ExampleDomain</Domain>
    <Username>ExampleUser</Username>
    <PasswordEncrypted>ExamplePassword</PasswordEncrypted>
    <UniqueIdentifierName>customIdentifier</UniqueIdentifierName>
    <ManagedByLdapFieldName>managedByLdap</ManagedByLdapFieldName>
    <ProfileBatchSize>250</ProfileBatchSize>
    <ManagerNameFieldName>i_report_to</ManagerNameFieldName>
    <ManagerEmailFieldName>i_report_to_email</ManagerEmailFieldName>
</CommunityApi>

Resolving issues

Refer to Solving ILST errors to assist with resolving any issues you may encounter. If you are unable to resolve your issue, contact our support team.