Configurator/IniFiles: Difference between revisions

From UmsWiki
Jump to navigation Jump to search
VisualWikitext
Created page with "This settings determines if activities coming from the administrative system will be active in UMS. If there are no settings configured, activites can not be used in UMS product. UMS will synchronize users in an activity; by removing users that do not belong (anymore) and adding users that should be there. Synchronization information usually comes from the administrative system and is stored in the UMS Database. ==Template Setting== File:Template Activities.jpg|n..."
 
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
This settings determines if activities  coming from the administrative system will be active in UMS.
== Description ==
This setting allows UMS backend to run multiple UMS installation (customers) from the same backend server.


If there are no settings configured, activites can not be used in UMS product.
Options for this setting can be found under Settings -> IniFiles


UMS will synchronize users in an activity; by removing users that do not belong (anymore) and adding users that should be there.  
A file will be generate under the UMS installation folder containing these settings. '''They are not stored in a database.'''


Synchronization information usually comes from the administrative system and is stored in the UMS Database.
The file is called '''IniFiles.json''' and the contents of the file looks like this.
{
  "IniFiles": [
    {
      "Name": "Customer1",
      "FileName": "UserManagement - Customer1.ini",
      "Description": "Customer1 DB",
      "WebSiteName": "Customer 1"
    },
    {
      "Name": "Customer2",
      "FileName": "UserManagement - Customer2.ini",
      "Description": "Customer2 DB",
      "WebSiteName": "Customer 2"
    }
  ],
  "Concurrency": [
    {
      "ProgramName": "GetSkemaBrikker",
      "MaxConcurrency": 4
    },
    {
      "ProgramName": "GetStudents",
      "MaxConcurrency": 3
    },
    {
      "ProgramName": "SMS Server",
      "MaxConcurrency": 2
    }
  ]
}


==Template Setting==
==Settings==
[[File:Template Activities.jpg|none|thumb|791x791px]]
[[File:IniFiles Settings.jpg]]


===Setting===
===Databases / Customers===
The activity setting attached to this template.
This section is used to specify the Ini files used to run the programs with. These files must be in the usermanagement installation folder.


===Web search setting===
==== Name ====
Enter an Active Directory group here.
This is an abbreviated name for the ini file. This can only contain [a-zA-Z0-9].


If you are a member of this group then you can search the users and groups/activities from this template.
This is used for two things:


Leaving this blank means that there are no restrictions on who can see users and groups/activities from this template.
* When running the programs from the commandline with the parameter "'''/IniFilesName:Customer1'''". Change Customer1 to the name you want to use.
* It will generate new log files with the prefix "'''GetStudents Customer1.log'''" for each row name. This will allow you to see the log file just you would when this is not used.


===Include all===
==== Filename ====
UMS will see all activities as active. (Recommended)
The filename of the ini file to use for this setting.


====Filter====
==== Web site name ====
UMS will only see activities matching the filter as active.
This is the web site name from IIS manager. See picture marked with yellow arrow.


==Activity setting==
This is needed when running multiple frontends on the same installation.
[[File:Template Activities Settings.jpg|none|thumb|546x546px]]


===Description===
[[File:IniFiles IIS Manager.jpg]]
Enter a name for this setting.


===Settings===
You create multiple sites that points to the same installation folder where UMS Web is installed.


====Mail enable====
==== Description ====
Mail enable groups on this template. Look for Exchange documentation for further info.
Enter a description. This is not used for anything.


(Only works if an Exchange setting is attached to the template)
===Concurrency for each program===
This controls how many instances are running at a time. This is for each program.


<br />
If the program is not specified the default is 10.


====Only senders inside my Organization====
For service the default is all is running.
Everyone can send to this groups mail address if this checkbox is cleared. Look for Exchange documentation for further info.


(Only works if an Exchange setting is attached to the template)
==== Program name ====
The name of the *.exe file from the UMS installation folder.


<br />
For UMS Services this is still the *.exe file name.


====Do not empty groups====
You can enter some reserved Keywords:
UMS will not remove users from this group (even if they do not belong according to the administrative data).


====Create - day(s) before start====
* Programs
The group will be seen as active in UMS, X number of days before it starts.
** All backend programs that are not services
* Services
** All backend services
* *
** All backend programs and services


====Keep active - day(s) after end====
The order in which the program or service decides the concurrency is:
The group will still be active after it ends. This only works if UMS still gets the information from the administrative system, so it only works with certain administrative systems.


====Exchange delivery management====
# Specified with the program name
This controls who can send to the group.
# Programs or Services keyword
# *


It only works if "'''Only senders inside my Organization'''" is checked.
==== Max concurrency ====
Specify how many should be activated at the same time.


This is only set on the group when it's mail enabled in Active Directory.
==Change setting==
[[File:IniFiles ChangeSetting.jpg]]


(Only works if an Exchange setting is attached to the template)
===Name===
Choose the setting you want to change to.


====Only accept message from group members====
You will see the setting has been change in the here. Marked with yellow.
Check this to activate the feature.


====New group====
[[File:IniFiles ChangeSetting see change.jpg]]
Enter an Active Directory group that should be mail enabled.


====Selected groups====
== How to create a new Ini file for a database ==
Shows all the current group that will be set on new groups.
Enter the information under the "'''Databases / Customers'''" section.


===Extra groups===
Then change to this setting under Settings -> IniFiles -> Change Setting. This will cause UMS to say that the file does not exist and ask you to fill out the SQL connection information.
[[File:Template Activities Settings Extra groups.jpg|none|thumb|666x666px]]All users on templates using this activity setting will be added to the UMS group entered here. Just as [[Custom_SQL_Commands#Add_users_to_groups]] would.


It's recommended to use [[Custom SQL Commands]] instead of this feature.
== How to run/install on IIS ==
You install UMS Academic web into a web site.


===Add extra AD groups to UMS groups===
Then you create new websites that points into the same physical folder. This website name is used in the IniFiles.json under the tag "'''Web site name'''" as described in under [[Configurator/IniFiles#Web site name]]
[[File:Template Activities Settings Extra AD groups.jpg|none|thumb|466x466px]]
Enter Active Directory groups here.


====Add to activities====
Remember to copy '''IniFiles.json''' into the bin folder along with the ini files specified in the json file.
This will add the Active Directory group to all UMS groups coming from the administrative system.
 
====Add to template groups====
This will add the Active Directory group to [[Configurator/Destination#Security_group_for_template]] of all templates using this setting.

Latest revision as of 10:48, 8 January 2025

Description

This setting allows UMS backend to run multiple UMS installation (customers) from the same backend server.

Options for this setting can be found under Settings -> IniFiles

A file will be generate under the UMS installation folder containing these settings. They are not stored in a database.

The file is called IniFiles.json and the contents of the file looks like this. 

{
 "IniFiles": [
   {
     "Name": "Customer1",
     "FileName": "UserManagement - Customer1.ini",
     "Description": "Customer1 DB",
     "WebSiteName": "Customer 1"
   },
   {
     "Name": "Customer2",
     "FileName": "UserManagement - Customer2.ini",
     "Description": "Customer2 DB",
     "WebSiteName": "Customer 2"
   }
 ],
 "Concurrency": [
   {
     "ProgramName": "GetSkemaBrikker",
     "MaxConcurrency": 4
   },
   {
     "ProgramName": "GetStudents",
     "MaxConcurrency": 3
   },
   {
     "ProgramName": "SMS Server",
     "MaxConcurrency": 2
   }
 ]
}

Settings

Databases / Customers

This section is used to specify the Ini files used to run the programs with. These files must be in the usermanagement installation folder.

Name

This is an abbreviated name for the ini file. This can only contain [a-zA-Z0-9].

This is used for two things:

  • When running the programs from the commandline with the parameter "/IniFilesName:Customer1". Change Customer1 to the name you want to use.
  • It will generate new log files with the prefix "GetStudents Customer1.log" for each row name. This will allow you to see the log file just you would when this is not used.

Filename

The filename of the ini file to use for this setting.

Web site name

This is the web site name from IIS manager. See picture marked with yellow arrow.

This is needed when running multiple frontends on the same installation.

You create multiple sites that points to the same installation folder where UMS Web is installed.

Description

Enter a description. This is not used for anything.

Concurrency for each program

This controls how many instances are running at a time. This is for each program.

If the program is not specified the default is 10.

For service the default is all is running.

Program name

The name of the *.exe file from the UMS installation folder.

For UMS Services this is still the *.exe file name.

You can enter some reserved Keywords:

  • Programs
    • All backend programs that are not services
  • Services
    • All backend services
  • *
    • All backend programs and services

The order in which the program or service decides the concurrency is:

  1. Specified with the program name
  2. Programs or Services keyword
  3. *

Max concurrency

Specify how many should be activated at the same time.

Change setting

Name

Choose the setting you want to change to.

You will see the setting has been change in the here. Marked with yellow.

How to create a new Ini file for a database

Enter the information under the "Databases / Customers" section.

Then change to this setting under Settings -> IniFiles -> Change Setting. This will cause UMS to say that the file does not exist and ask you to fill out the SQL connection information.

How to run/install on IIS

You install UMS Academic web into a web site.

Then you create new websites that points into the same physical folder. This website name is used in the IniFiles.json under the tag "Web site name" as described in under Configurator/IniFiles#Web site name

Remember to copy IniFiles.json into the bin folder along with the ini files specified in the json file.

Retrieved from "http://wiki.inlogic.dk/index.php?title=Configurator/IniFiles&oldid=4996"