K2 Business Apps Service Broker

/K2 Business Apps Service Broker
You are here:
< Back

K2 Business Apps Service Broker

The custom broker comes with a custom configuration. In this configuration, you can tweak various settings of the app. The XML contains the explanation of each value.
The XML file below is for version 3.5.0 of the service broker, applicable to K2 Business Apps 1.5.2.

<?xml version="1.0" encoding="utf-8"?>
<configuration>

<configSections>
  <section name="K2BusinessApps" type="Indocs.K2.ServiceBrokers.App.Configurations.K2BusinessApps, Indocs.K2BusinessApps, Version=3.5.0.0, Culture=neutral, PublicKeyToken=null" />
</configSections>

<!-- K2ConnectionString: The connection string is used to connect to K2. -->
<!-- SQLConnectionString: The connection string is used to connect to the K2 Business Apps database. -->
<K2BusinessApps
  SQLConnectionString="YOUR SQL CONNECTION STRING"
  K2ConnectionString="Integrated=True;IsPrimaryLogin=True;Authenticate=True;EncryptedPassword=False;Host=LocalHost;Port=5555">

  <!-- Leaflet: Settings for the leaflet control specific items. -->
  <!-- TileMapDirectory: The directory where the tile zips are stored. -->
  <!-- MarkerIconDirectory: The directory where your custom marker icons are stored. -->
  <Leaflet
    TileMapDirectory="PATH TO ZIP FILES WITH TILES"
    MarkerIconDirectory="PATH TO DIRECTORY WITH MARKER ICONS" />

  <!-- LanguageFiles: Specifies where the translation files for the GetLanguage control are stored. -->
  <!-- Directory*: The directory in which translation files are stored. -->
  <LanguageFiles
    Directory="PATH TO LANGUAGE FILES">

    <!-- LanguageFile: A single file within the above specified directory. Multiple LanguageFile elements can be specified. -->
    <!--<LanguageFile Filename="core.xml" />-->

  </LanguageFiles>

  <!-- Logging*: Settings for logging. -->
  <!-- WriteToFiles*: Whether logs will be written to files. -->
  <!-- Directory: The directory to write logs to. If left empty, logs will be written to a directory "K2 Business Apps Logs" created next to the K2 Business Apps dll. -->
  <!-- Level: (default: Info) The log level determines which logs are written and which are not. (Debug, Info, Warning, Error) The level and all levels right of it will be written. -->
  <!-- MaxLineSize: (default 500) If a log line exceed this number, the log gets truncated. Exceptions will always be logged completely. -->
  <!-- WriteToSMO*: Each log message will call an SMO. You can use this to e.g. write logs to a database. -->
  <!-- ID*: The ID of an SMO to be called for each log. -->
  <!-- Method*: The method to execute on the SMO. -->
  <Logging
    WriteToFiles="False"
    Directory="YOUR LOG DIRECTORY HERE"
    Level="Info"
    MaxLineSize="500"
    WriteToSMO="True"
    ID="469cf087-916a-49b6-8edf-0204cfcd17ff"
    Method="Create" />

  <!-- UMGroup*: The SmartObject information used to determine in which groups the user is. -->
  <!-- ID*: The Guid of the SmartObject "UMGroup". Usually "17f70b41-2829-4886-ad85-d4f4d7457836". -->
  <!-- Method*: The name of the method of the SmartObject to execute. Should be "FindUserGroups". -->
  <!-- Inputs: Inputs to be passed to the SmartObject call. Should be "userName=[User];labelName=[Label]". -->
  <UMGroup ID="17f70b41-2829-4886-ad85-d4f4d7457836" Method="FindUserGroups" Inputs="userName=[User];labelName=[Label]" />

  <!-- AppItems*: This sections specifies which items may be access by the user. -->
  <AppItems>

    <!-- Projects*: The SmartObject information used to determine which projects may be accessed by the user. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID" and "Name". -->
    <Projects ID="55b30fe4-91df-4939-8e42-2a78b7d94e89" Method="List" Inputs="FQN=[FQN]" />

    <!-- Headers*: The SmartObject information used to determine which headers may be accessed by the user. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID" and "Name". -->
    <Headers ID="c97f7ff8-1853-45f3-85c3-2ef147ac0466" Method="List" Inputs="FQN=[FQN]" />

    <!-- Forms*: The SmartObject information used to determine which forms may be accessed by the user. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID", "Name", "DisplayName", and "Description". -->
    <Forms ID="49a52c27-daa2-4036-9549-09c048dc9bf4" Method="List" Inputs="FQN=[FQN]" />

    <!-- FormParameters*: The SmartObject information used to determine which form parameters should be used. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "FormID", "Name", and "Value". -->
    <FormParameters ID="c80949e9-48e4-4080-8614-2a3b5770fa4b" Method="List" Inputs="FQN=[FQN]" />

    <!-- FormConditions*: The SmartObject information used to determine which form conditions should be used. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID", "Name", and "Value". -->
    <FormConditions ID="844aa299-283b-4f08-9e7a-f5c99a36110d" Method="List" Inputs="FQN=[FQN]" />

    <!-- Projectheaders*: The SmartObject information used to determine which projects contains which headers. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID" and "Name". -->
    <ProjectHeaders ID="829e933b-2ec9-451f-b864-542795a6c00d" Method="List" Inputs="FQN=[FQN]" />

    <!-- HeaderHeaders*: The SmartObject information used to determine which projects contains which headers. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID" and "Name". -->
    <HeaderHeaders ID="25124e1b-bc0b-4410-a16c-d3aad8da3513" Method="List" Inputs="FQN=[FQN]" />

    <!-- ProjectForms*: The SmartObject information used to determine which projects contains which forms. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID" and "Name". -->
    <ProjectForms ID="95e20b3d-5e8f-4295-8618-a39e551f33b0" Method="List" Inputs="FQN=[FQN]" />

    <!-- HeaderForms*: The SmartObject information used to determine which headers contains which forms. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID" and "Name". -->
    <HeaderForms ID="d88587e3-6684-4007-8a46-fe0460fb1766" Method="List" Inputs="FQN=[FQN]" />

    <!-- FormFormTypes*: The SmartObject information used to determine which forms are available in which category. -->
    <!-- ID*: The Guid of the SmartObject to execute. -->
    <!-- Method*: The name of the method of the SmartObject to execute. -->
    <!-- Inputs: Optional static inputs to be passed to the SmartObject call. These should be in the format: Inputs="key1=value1;key2=value2;". The term [FQN] will be replaced by the user's FQN. -->
    <!-- The resulting table should contain at least the columns "ID" and "Name". -->
    <FormFormTypes ID="71ee82a3-daf1-4594-91f8-e51d4ba9fedc" Method="List" Inputs="FQN=[FQN]" />

  </AppItems>

  <!-- AppSettings: Settings that can be tweaked on the server and are used by the app. -->
  <!-- K2RuleSpinnerTime: (default 250) The amount of milliseconds a rule should run before the spinner is shown. If this is too low, users will often see a flashing spinner. -->
  <!-- LeafletClusterDistancePixels: (default 100) If the amount of pixels between two markers are less than this amount, the markers become a cluster. The devices screen density factory is taken into account. -->
  <!-- LeafletScreenshotSize: (default 300) The maximum dimension when a screenshot is taken of the leaflet control. The aspect ratio is honored. -->
  <App
    K2RuleSpinnerTime="500"
    LeafletClusterDistancePixels="100"
    LeafletScreenshotSize="300">

    <!-- SetupForm: An optional form that will be shown when the user logs in for the first time, or when the user wants to change the project he's working on. -->
    <!-- SystemName*: The system name of the form to be used as setup form. -->
    <SetupForm SystemName="K2BA.Demo.Setup.Form" />

    <!-- FormConfiguration*: An element used to define which SmartObject should be executed in order to retrieve the form configuration, that is, the forms to be downloaded to the app. -->
    <!-- SmartObjectID*: The ID of the SmartObject to be executed. -->
    <!-- SmartObjectMethod*: The method on the SmartObject to be executed. -->
    <!-- SmartObjectInputs: Optional inputs to pass along when the method is executed. These should be in the form "key1=value1;key2=value2;". Remember that any Global Parameter set in the app will be passed along as well. -->
    <FormConfiguration
      SmartObjectID="6c0e9743-8a0e-4ec0-82fe-97ba34b63232"
      SmartObjectMethod="List"
      SmartObjectInputs="" />

    <!-- Images: Settings regarding photo's taken and images selected from the gallery. -->
    <!-- MaxDimension: If the width or height of an image is greater than this number, it will be resized to this value. -->
    <!-- JpegQuality: The image - if a Jpeg - will be compressed to this amount of percentages. -->
    <Images
      MaxDimension="1920"
      JpegQueality="85"
      AllowCropping="False" />

    <!-- DigitalSignature: Settings for the Digital Signature custom control. (K2 Community) -->
    <!-- PenColor: The color of the pen. -->
    <!-- SignBackgroundColor: The color of the background on which a user can draw. -->
    <!-- SaveBackgroundColor: The color of the background used when the signature is saved. -->
    <!-- MaxDimension: The length of the longest edge of the resulting image. -->
    <DigitalSignature
      PenColor="#000F55"
      SignBackgroundColor="FFFFE0"
      SaveBackgroundColor="#FFFFFF"
      MaxDimension="600" />

    <!-- Notifications: all notification related settings. -->
    <!-- CompanyTopic: A GUID used for server wide notifications. -->
    <Notifications CompanyTopic="5BB8F5AA-075E-46C7-AA00-CD89E0C3699A" />

    <!-- MAM: Mobile Application Management is supported or more specifically: Microsoft Intune is supported. -->
    <!-- Enabled: Whether to use MAM. -->
    <!-- ClientID: The Azure Client ID (or application ID) to use for MAM. -->
    <MAM
      Enabled="False"
      ClientID="6aa0c691-5ccb-4144-89a8-b7e0fb691c7b" />

    <!-- Developers: a list of FQN that may see debug options in K2 Business Apps. -->
    <Developers>

      <!-- Developer: A single developer. -->
      <Developer FQN="YOUR FQN HERE" />

    </Developers>

  </App>

</K2BusinessApps>

  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7" />
  </startup>

</configuration>
2019-10-07T10:47:26+01:00