Install TeleStaff Integrations

Po wdrożeniu integracji i skonfigurowaniu ustawień połączenia i właściwości procesu zainstaluj integracje, aby były dostępne do uruchamiania lub planowania.

Uwaga:
  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.
  • Zainstalowana integracja to pojedyncze wystąpienie integracji oparte na szablonie integracji. Podczas instalowania integracji można zdefiniować parametry lub ustawić parametry do zdefiniowania podczas uruchamiania integracji.
  1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
  2. You must repeat the remaining steps five times to install each of the integrations in the following order:
    1. TeleStaff Business Structure Export
    2. TeleStaff Skills and Certifications Export
    3. TeleStaff People Export
    4. TeleStaff Schedule Batch Import
    5. TeleStaff Schedule Import

    Options and values for each integration are specified in the corresponding steps.

  3. Kliknij Dotknij Create . 
  4. Enter the corresponding Integration Name as follows:
    • Business Structure Export
    • Skills and Certs Export
    • People Export
    • Schedule Batch Import
    • Schedule Import
  5. (Optional) Enter a Description.
  6. Integration type

    For Business Structure Export, Skills and Certifications Export, and People Export:

    1. Do not select API Integration.
    2. In File Access, leave at None, do not select an SFTP connection.
    3. (Optional) To allow the integration access to all APIs in the FAP, and the relevant permissions and data even if the person who runs the integration doesn't have full access, select Execute Integration with System Account.

    4. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

    5. Powiadomienia e-mail

      (Opcjonalne)

      1. Wybierz Tak, aby wysyłać wiadomości e -mail i powiadomienia centrum kontroli dla uruchomień integracji.
      2. Wprowadź adresy e -mail odbiorców dla następujących typów statusu uruchomienia. W przypadku wielu odbiorców rozdziel adresy przecinkami (,) bez spacji:

        W toku - integracja została rozpoczęta i nie została ukończona.

        Ukończono - integracja przebiegła pomyślnie bez błędów.

        Niepowodzenie - integracja została przeprowadzona pomyślnie, ale co najmniej jeden rekord zawiera błędy. Uruchomienie integracji jest traktowane jako nieudane. Jeśli w zbiorze integracji skonfigurowano funkcję Przerwij w przypadku niepowodzenia, zbiór integracji zostaje zatrzymany.

        Ukończono z błędami - uruchomienie integracji zawiera błędy lub integracji nie można uruchomić.

    6. Scheduling Configuration

      (Only for file-based integrations) For integrations that will be scheduled to run frequently, configure the behavior if integrations overlap in time. These settings allow frequent integration runs that avoid redundant processing of data and avoid multiple integrations processing the same data.

      • In Skip Configuration, select one of the following:

        None (default): Allow multiple integrations to run at the same time or with the same data without restrictions.

        Installed Instance (Recommended): Do not run a scheduled integration if another instance of the same installed integration is in-progress. Only once such integrations finish, this integration can run at the next scheduled time.

        Integration Template: Do not run a scheduled integration if any installed instance of the same integration template is in-progress. Only once such integrations finish, can this integration run at the next scheduled time.

      • Only if Installed Instance or Integration Template is selected, select Allow Minute Interval to allow the person who schedules the integration to select the By Minute recurrence to repeat the integration run every 5, 10, 15, 20, 25, or 30 minutes.

    For Schedule Batch Import and Schedule Import: Select API Integration.

  7. Integration template
    1. In Integration Template, select the corresponding integration template from the table as follows:
      • Business Structure Export: Select WFTSBusinessStructureExport-v1.
      • Skills and Certs Export: Select WFTSSkillsAndCertsSetupExport-v1.
      • People Export: Select WFTSPeopleExport-v1.
      • Schedule Batch Import: Select WFTSScheduleImport-Batch-v1.
      • Schedule Import: Select WFTSScheduleImport-v1.
    2. Kliknij Dotknij Assign .
  8. Integration parameters
    1. In Integration Parameters, kliknij dotknij Create .

    2. Configure the parameters for each integration.

      Enter the values for each parameter. Kliknij Dotknij Save for each parameter.

      • Business Structure Export

        EndDate
        Parameter Name (Required) Enter End Date.
        Description (Optional)
        Template Parameter

        (Required) Select EndDate.
        Parameter Type

        (Required) Select Date.
        Default Value (Optional) Enter a default date as the symbolic period (preferred), symbolic period span, or date in MM-DD-YYYY format.
        User Prompted

        Aby monitować osobę, która ręcznie uruchamia integrację, o ustawieniu tego parametru, wybierz Tak.
        LocationType
        Parameter Name LocationType; must be exactly the same spelling as the Template Parameter.
        Template Parameter LocationType
        Parameter Type Text
        Default Value Not specified
        User Prompted

        Aby monitować osobę, która ręcznie uruchamia integrację, o ustawieniu tego parametru, wybierz Tak.

        StartDate
        Parameter Name (Required) Enter Start Date.
        Description (Optional)
        Template Parameter

        (Required) Select StartDate.
        Parameter Type

        (Required) Select Date.
        Default Value (Optional) Enter a default date as the symbolic period (preferred), symbolic period span, or date in MM-DD-YYYY format.
        User Prompted

        Aby monitować osobę, która ręcznie uruchamia integrację, o ustawieniu tego parametru, wybierz Tak.

      • Skills & Certs Export: No integration parameters are defined.
      • People Export

        (Optional)

        InitialTimeToWait: If an API limit is exceeded, this property defines how long to wait before sending the API call again.

        Default = 60000 ms (1 minute)

        This property sets only the first retry. If the API call has to be sent again, each repetition adds 60,000 ms to the wait time.

        Example:

        • 1st TimetoWait = 60,000 ms (InitialTimeToWait)
        • 2nd TimetoWait = 60,000 ms + 60,000 ms = 120,000 ms
        • 3rd TimetoWait = 60,000 ms + (2 * 60,000 ms) = 180,000 ms

        To change the initial wait time:

        • Clear Use Default.
        • Enter the wait time in milliseconds (ms) up to a maximum of 180000 ms.

        (Optional) isMoreThan50K

        This integration exports records by employee ID based on each location. If a single location has more than 50,000 employees, the integration fails. To prevent this and export more than 50,000 employee records from a location, do the following when you install the integration:

        1. Select isMoreThan50K.
        2. Upload the BusinessStructureExport-v1_LocationTypes cross-reference table from the TeleStaff Business Structure Export integration. Alternatively, you can use the WFTSPeopleExport-v1_LocationTypes cross-reference table that is configured to map the WFTS Type Institution to the WFD Type WFTS_Institution.

        (Optional)

        EnableContactByInstitution
        Parameter Name EnableContactByInstitution; must be exactly the same spelling as the Template Parameter.
        Template Parameter EnableContactByInstitution
        Parameter Type Boolean
        Default Value To use institution-based contact mapping, enter True.
        User Prompted

        Jeśli wartość nie wymaga zmiany po uruchomieniu integracji, wybierz Nie.

        Przestroga :If you select Yes, the people who run the integrations can change this setting, and the results in the Run Summary become inconsistent between integration runs.
      • For bothSchedule Batch Import and Schedule Import:
        AdjustToCalendarDay
        Parameter NameAdjustToCalendarDay; must be exactly the same spelling as the Template Parameter.
        Template ParameterAdjustToCalendarDay
        Parameter TypeBoolean
        Default ValueFalse
        User Prompted

        Select Yes.

        AtwFromDate
        Parameter NameAtwFromDate; must be exactly the same spelling as the Template Parameter.
        Template ParameterAtwFromDate
        Parameter TypeText or Date
        Default Value

        No default value is assigned to this property.

        User Prompted

        Select Yes.

        AtwThruDate
        Parameter NameAtwThruDate; must be exactly the same spelling as the Template Parameter.
        Template ParameterAtwThruDate
        Parameter TypeText or Date
        Default Value

        No default value is assigned to this property.

        User Prompted

        Select Yes.

        DayDivide
        Parameter NameDayDivide; must be exactly the same spelling as the Template Parameter.
        Template ParameterDayDivide
        Parameter TypeNumber
        Default ValueNot specified
        User Prompted

        Select Yes.

        ExtraDaysBeyondPeriod
        Parameter NameExtraDaysBeyondPeriod; must be exactly the same spelling as the Template Parameter.
        Template ParameterExtraDaysBeyondPeriod
        Parameter TypeNumber
        Default ValueNot specified
        User Prompted

        Select Yes.

        FromDate
        Parameter NameFromDate; must be exactly the same spelling as the Template Parameter.
        Template ParameterFromDate
        Parameter TypeText
        Default ValueNot specified
        User Prompted

        Select Yes.

        MergeAdjacentShifts
        Parameter NameMergeAdjacentShifts; must be exactly the same spelling as the Template Parameter.
        Template ParameterMergeAdjacentShifts
        Parameter TypeBoolean
        Default ValueFalse
        User Prompted

        Select Yes.

        NoPaySegmentTag
        Parameter NameNoPaySegmentTag; must be exactly the same spelling as the Template Parameter.
        Template ParameterNoPaySegmentTag
        Parameter TypeText
        Default ValueNot specified
        User Prompted

        Select Yes.

        PayCodeEditsOnly
        Parameter NamePayCodeEditsOnly; must be exactly the same spelling as the Template Parameter.
        Template ParameterPayCodeEditsOnly
        Parameter TypeBoolean
        Default ValueFalse
        User Prompted

        Select Yes.

        ThruDate
        Parameter NameThruDate; must be exactly the same spelling as the Template Parameter.
        Template ParameterThruDate
        Parameter TypeText
        Default ValueNot specified
        User Prompted

        Select Yes.

      • Only for Schedule Batch Import:
         SupportPartialSuccess
        Parameter Name SupportPartialSuccess; must be exactly the same spelling as the Template Parameter.
        Template Parameter SupportPartialSuccess
        Parameter TypeBoolean
        Default Value

        Enter one of the following:

        • True — Runs of this integration can have a status of Completed with Errors in the Run Summary.
        • False (default) — Runs of this integration cannot have a status of Completed with Errors.
        User Prompted

        Select Yes.

        Przestroga :In TeleStaff, you must also select Import Manager > Integrations tab > Enable Partial Success.

  9. Kliknij Dotknij Save.
  10. Repeat to install the next integration.
  11. Configure and assign the GDAP for the people who need to run the installed integrations.

Uwaga: Only for the Schedule Batch Import and Schedule Import integrations.

API-based integrations generate an API integration key that you need when you configure the integrations in TeleStaff. Get the key as follows:

  1. Select the integration.
  2. Kliknij Dotknij Edit.
  3. Copy the API Integration Key to a text file.
  4. Kliknij Dotknij Cancel.
  5. In TeleStaff, enter this key in Setup > System > Import Manager > Integrations tab > Workforce Dimensions API Key.