Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vtfk/azf-archive

Azure function for archive operations in P360
https://github.com/vtfk/azf-archive

archive azure functions p360 rpc sif

Last synced: 2 months ago
JSON representation

Azure function for archive operations in P360

Host: GitHub
URL: https://github.com/vtfk/azf-archive
Owner: vtfk
Created: 2019-03-15T13:44:29.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-09-08T09:33:44.000Z (5 months ago)
Last Synced: 2024-09-08T11:28:21.423Z (5 months ago)
Topics: archive, azure, functions, p360, rpc, sif
Language: JavaScript
Homepage:
Size: 2.11 MB
Stars: 3
Watchers: 4
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# azf-archive

Azure function for archive operations in P360

## API

All calls needs a valid Azure Subscription key

### ```POST /archive - template```

Endpoint for template calls. See [here](#templates) for a complete list of templates

Required fields:
- `system`: Which ***system*** to use
- `template`: Which ***template*** to use
- `parameter`: Parameters for calling ***P360***

Optional fields:
- `parameter.attachments`: List of ***attachments*** to add to P360 Document when using templates with methods 'CreateDocument' or 'UpdateDocument'
- `parameter.contacts`: List of ***contacts*** to add to P360 Project, Case, or Document when using templates with methods 'CreateProject', 'UpdateProject', 'CreateCase', 'UpdateCase', 'CreateDocument', or 'UpdateDocument'

```json
{
"system": "iop",
"template": "document",
"parameter": {
"accessGroup": "Elev vgs",
"organizationNumber": "01234",
"ssn": "01010101010",
"base64": "JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwogIC9QYWdlcyAyIDAgUgo+PgplbmRvYmoKCjIgMCBvYmoKPDwKICAvVHlwZSAvUGFnZXMKICAvTWVkaWFCb3ggWyAwIDAgMjAwIDIwMCBdCiAgL0NvdW50IDEKICAvS2lkcyBbIDMgMCBSIF0KPj4KZW5kb2JqCgozIDAgb2JqCjw8CiAgL1R5cGUgL1BhZ2UKICAvUGFyZW50IDIgMCBSCiAgL1Jlc291cmNlcyA8PAogICAgL0ZvbnQgPDwKICAgICAgL0YxIDQgMCBSIAogICAgPj4KICA+PgogIC9Db250ZW50cyA1IDAgUgo+PgplbmRvYmoKCjQgMCBvYmoKPDwKICAvVHlwZSAvRm9udAogIC9TdWJ0eXBlIC9UeXBlMQogIC9CYXNlRm9udCAvVGltZXMtUm9tYW4KPj4KZW5kb2JqCgo1IDAgb2JqICAlIHBhZ2UgY29udGVudAo8PAogIC9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCjcwIDUwIFRECi9GMSAxMiBUZgooSGVsbG8sIHdvcmxkISkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNzkgMDAwMDAgbiAKMDAwMDAwMDE3MyAwMDAwMCBuIAowMDAwMDAwMzAxIDAwMDAwIG4gCjAwMDAwMDAzODAgMDAwMDAgbiAKdHJhaWxlcgo8PAogIC9TaXplIDYKICAvUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKNDkyCiUlRU9G",
"fileFormat": "pdf",
"displayName": "Bjarne Betjent",
"caseNumber": "30/99999",
"documentDate": "2021-09-27",
"versionNumber": "4.0"
}
}
```
#### `Sending to "unregistered" - for manual archiving`
Useful for when you do not have sufficient data for automatic archiving (e.g. foreign students not registered in DSF/folkeregister)
```json
{
"system": "archive",
"template": "unregistered",
"parameter": {
"title": "A title that describes the document",
"msg": "A message to the archivists, on why this could not be automatically be archived (keep it short)",
"base64": "JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwogIC9QYWdlcyAyIDAgUgo+PgplbmRvYmoKCjIgMCBvYmoKPDwKICAvVHlwZSAvUGFnZXMKICAvTWVkaWFCb3ggWyAwIDAgMjAwIDIwMCBdCiAgL0NvdW50IDEKICAvS2lkcyBbIDMgMCBSIF0KPj4KZW5kb2JqCgozIDAgb2JqCjw8CiAgL1R5cGUgL1BhZ2UKICAvUGFyZW50IDIgMCBSCiAgL1Jlc291cmNlcyA8PAogICAgL0ZvbnQgPDwKICAgICAgL0YxIDQgMCBSIAogICAgPj4KICA+PgogIC9Db250ZW50cyA1IDAgUgo+PgplbmRvYmoKCjQgMCBvYmoKPDwKICAvVHlwZSAvRm9udAogIC9TdWJ0eXBlIC9UeXBlMQogIC9CYXNlRm9udCAvVGltZXMtUm9tYW4KPj4KZW5kb2JqCgo1IDAgb2JqICAlIHBhZ2UgY29udGVudAo8PAogIC9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCjcwIDUwIFRECi9GMSAxMiBUZgooSGVsbG8sIHdvcmxkISkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNzkgMDAwMDAgbiAKMDAwMDAwMDE3MyAwMDAwMCBuIAowMDAwMDAwMzAxIDAwMDAwIG4gCjAwMDAwMDAzODAgMDAwMDAgbiAKdHJhaWxlcgo8PAogIC9TaXplIDYKICAvUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKNDkyCiUlRU9G",
"originRecno": "200007" // "200007" is displayed as source "Arkiveringsrobot" for archivists - if you need something else - ask an adult
}
}
```

#### `With attachments and/or contacts`

### ```POST /archive - raw```

Endpoint for raw SIF calls

Required fields:
- `service`: Which ***SIF service*** to use
- `method`: Which ***method*** from ***SIF service*** to use
- `parameter`: Parameters for calling ***service.method***

Optional fields:
- `secure`: If true, `SECURE P360` will be used; If false or undefined, `REGULAR P360` will be used
- `options`: JSON Object for repack options

#### `Secure`

```json
{
"service": "ContactService",
"method": "GetPrivatePersons",
"secure": true,
"parameter": {
"PersonalIdNumber": "01010101010"
}
}
```

#### `Non-Secure`

```json
{
"service": "ContactService",
"method": "GetPrivatePersons",
"secure": false, // this can be undefined, removed, empty string or 0 as well
"parameter": {
"PersonalIdNumber": "01010101010"
}
}
```

#### `With options`

```json
{
"service": "CaseService",
"method": "GetCases",
"parameter": {
"ContactReferenceNumber": "01010101010",
"Title": "Elevmappe"
},
"options": {
"onlyOpenCases": true // see #available-options
}
}
```

#### `Get first Case`

```json
{
"service": "CaseService",
"method": "GetCases",
"parameter": {
"ContactReferenceNumber": "01010101010",
"Title": "Elevmappe"
},
"options": {
"limit": 1 // see #available-options
}
}
```

#### Available options

| Option | Type | Value | Description |
| ------ | ---- | ----- | ----------- |
| onlyOpenCases | `Boolean` | `true` / `false` | If true, only cases with `Status === 'Under behandling'` will be returned; If false or undefined, all cases will be returned regardless of Status |
| excludeExpiredCases | `Boolean` | `true` / `false` | If true, only cases without `Status === 'Utgår'` will be returned; If false or undefined, all cases will be returned regardless of Status |
| limit | `int` | `1` - `2147483647` | If set to `1`, first occurance will be returned as an `object`. If set to `2` or greater, an array with `limit` amount of items are returned. If set to `0` or not set, the original output will be returned |

#### Supported **services** and their **methods**

- **AccessGroupService**
- *GetAccessGroups*
- **CaseService**
- *CreateCase*
- *GetCases*
- *UpdateCase*
- **ContactService**
- *GetContactPersons*
- *GetEnterprises*
- *GetPrivatePersons*
- *SynchronizeContactPerson*
- *SynchronizeEnterprise*
- *SynchronizePrivatePerson*
- *UpdatePrivatePerson*
- **DocumentService**
- *CreateDocument*
- *DispatchDocuments*
- *GetDocuments*
- *SignOffDocument*
- *UpdateDocument*
- **EstateService**
- *GetEstates*
- *SynchronizeEstate*
- **FileService**
- *CheckOutAndGetFileForExternalControl*
- *CreateFile*
- *DeleteFile*
- *GetFileWithMetadata*
- *GetFile*
- *Upload*
- *UploadAndCheckInFileFromExternalControl*
- *UploadFile*
- **MyCasesService**
- *GetMyCases*
- **ProjectService**
- *CreateProject*
- *GetProjects*
- *UpdateProject*
- **UserService**
- *GetUsers*
- *SynchronizeUser*

Full documentation for the **SIF services** can be found [here](https://github.com/vtfk/azf-archive/blob/master/docs/sif-generic-web-service.pdf)

### ```POST /Changes```

Endpoint for changes in IDM

No input or output. Changes will be fetched from IDM

### ```POST /SyncPrivatePerson```
- Create **PrivatePerson** on person if one doesn't exist
- Updates name and address on **PrivatePerson** if one already exists
- Updates ssn for **PrivatePerson** if parameter *oldSsn* is passed, or if new ssn is found in `Det sentrale folkeregister`

Fetches person info from [Det sentrale folkeregister](https://github.com/vtfk/azf-dsf)

#### `With ssn as parameter`
```json
{
"ssn": "01010101010"
}
```

#### `With birthdate and name as parameter (only works with one match)`
```json
{
"birthdate": "010101",
"firstName": "Per",
"lastName": "Son"
}
```

#### `Optional: Do not lookup person in DSF (det sentrale folkeregister). (Requires more info) Useful when person is not registered in DSF`
Either updates the **PrivatePerson** with the provided data if person exists on ssn, or creates new **PrivatePerson** with the provided data
```json
{
"ssn": "12345678910",
"firstName": "Bjarte",
"lastName": "Bjøstheim",
"streetAddress": "Gamlehjemmet 44",
"zipCode": "1234",
"zipPlace": "Jupiter",
"addressCode": 0,
"skipDSF": true // Must be set to "true" if you need to skip DSF lookup
}
```

#### `Optional: Do not lookup person in DSF (det sentrale folkeregister) AND generate a fake ssn for the preson. (Requires more info) Useful when person is not registered in DSF, and you need to generate a fake ssn`
Either updates the **PrivatePerson** with the provided data if person exists on the fake ssn AND the lastname of the existing 360-contact and the input-lastname matches, or creates new **PrivatePerson** with the provided data. Updates or creates **elevmappe** as well.
```json
{
"generateFakeSsn": true, // // Must be set to "true" if you need want to generate a fake ssn
"birthdate": "010188", // Used to generate fake ssn
"gender": "010188", // Used to generate fake ssn
"firstName": "Bjarte",
"lastName": "Bjøstheim",
"streetAddress": "Gamlehjemmet 44",
"zipCode": "1234",
"zipPlace": "Jupiter",
"addressCode": 0,
"skipDSF": true, // Must be set to "true" if you need to skip DSF lookup
}
```

### ```POST /SyncEnterprise```
- Create **Enterprise** on Brreg-company if one doesn't exist
- Updates data on **Enterprise** if one already exists

#### `Payload`
```json
{
"orgnr": "123456789"
}
```

Fetches company info from [Brønnøysundregisteret]https://www.brreg.no/)

### ```POST /SyncElevmappe```
- Creates **PrivatePerson** on person if one doesn't exist
- Updates name and address on **PrivatePerson** if one already exists
- Updates ssn for **PrivatePerson** if parameter *oldSsn* is passed, or if new ssn is found in `Det sentrale folkeregister`
- Creates **Elevmappe** on user if one doesn't exist
- Updates case contact and name on **Elevmappe** if one already exists
- Grants reading permissions to *newSchools* on relevant documents in **Elevmappe** if parameter *newSchools* is passed
- Sends email alert to archive department if there is need for manual operations
Fetches person info from [Det sentrale folkeregister](https://github.com/vtfk/azf-dsf)

#### `With ssn as parameter`
```json
{
"ssn": "01010101010"
}
```

#### `With birthdate and name as parameter (only works with one match)`
```json
{
"birthdate": "010101",
"firstName": "Per",
"lastName": "Son"
}
```

#### `Optional: With old ssn and new ssn as parameter (for updating ssn on PrivatePerson)`
Either updates the **PrivatePerson** with new ssn, if person exists on old ssn, or creates new **PrivatePerson** with new ssn. Updates or creates **elevmappe** as well.
```json
{
"ssn": "01010101011",
"oldSsn": "01010101010"
}
```
#### `Optional: Do not lookup person in DSF (det sentrale folkeregister). (Requires more info) Useful when person is not registered in DSF`
Either updates the **PrivatePerson** with the provided data if person exists on ssn, or creates new **PrivatePerson** with the provided data. Updates or creates **elevmappe** as well.
```json
{
"ssn": "12345678910",
"firstName": "Bjarte",
"lastName": "Bjøstheim",
"streetAddress": "Gamlehjemmet 44",
"zipCode": "1234",
"zipPlace": "Jupiter",
"addressCode": 0,
"skipDSF": true // Must be set to "true" if you need to skip DSF lookup
}
```

#### `Optional: With newSchools as parameter, for granting reading permissions for new school(s)`
Must be array of school(s), where each school is the official name of the school. [See available school names here](https://github.com/vtfk/vtfk-schools-info/blob/master/lib/data/schools.json)
```json
{
"ssn": "01010101011",
"newSchools": ["Gul videregående skole", "Livets videregående skole"]
}
```

### ```POST /SyncEmployee```
- Creates **PrivatePerson** on person if one doesn't exist
- Updates name and address on **PrivatePerson** if one already exists
- Creates **Employee project** on user if one doesn't exist
- Sends email alert to archive department if there is need for manual operations:
- If manager does not have user in P360
- If manager have several contactpersons on email-address
- If enterprise manager is employed in is missing enterprisenumber
- If several enterprises are found on the same enterprisenumber
- If enterprise does not have access group of type "Lønn" or "Personal"
- If several employee projects are found on one employee

Fetches person info from [Det sentrale folkeregister](https://github.com/vtfk/azf-dsf)

#### `With ssn and upn as parameter`
```json
{
"ssn": "01010101010",
"upn": "[email protected]"
}
```

#### `With birthdate and name as parameter (only works with one match)`
```json
{
"birthdate": "010101",
"firstName": "Per",
"lastName": "Son",
"upn": "[email protected]"
}
```

#### `Optional: Do not lookup person in DSF (det sentrale folkeregister). (Requires more info) Useful when person is not registered in DSF`
Either updates the **PrivatePerson** with the provided data if person exists on ssn, or creates new **PrivatePerson** with the provided data. Updates or creates **elevmappe** as well.
```json
{
"ssn": "12345678910",
"firstName": "Bjarte",
"lastName": "Bjøstheim",
"streetAddress": "Gamlehjemmet 44",
"zipCode": "1234",
"zipPlace": "Jupiter",
"addressCode": 0,
"skipDSF": true, // Must be set to "true" if you need to skip DSF lookup
"upn": "[email protected]
}
```

#### `Optional: With parameter allowNullValues`
Set **allowNullValues** to **true**, if you want to continue also when accessGroups and enterprise is not found. **REMARK:** Client itself must handle access groups, enterprise, and manager when this parameter is set to true
```json
{
"ssn": "01010101011",
"upn": "[email protected]",
"allowNullValues": true // Defaults to "false"
}
```
#### `RETURNS`
```json
{
"dsfPerson": {
"ssn": "010101010101",
"oldSsn": "010101010101", // The same as ssn if no change in DSF, or not specified by client
"firstName": "Per",
"lastName": "Son",
"streetAddress": "Gata 2",
"zipCode": "1234",
"zipPlace": "STED",
"addressType": "VANLIG BOSATT",
"addressCode": 0,
"residentialAddress": {
"ADR": "Gata 2",
"POSTN": "1234",
"POSTS": "STED"
}
},
"privatePerson": {
"ssn": "010101010101",
"oldSsn": "010101010101",
"firstName": "Per",
"lastName": "Son",
"streetAddress": "Gata 2",
"zipCode": "1234",
"zipPlace": "STED",
"addressCode": 0,
"recno": 123456,
"updated": false, // If the privatePerson was updated
"updatedSsn": false // If the ssn of the privatePerson was updated
},
"employee": {
"upn": "[email protected]", // Employee userPrincipalName from azure ad
"manager": "[email protected]", // Registered manager in azure ad
"enterpriseNumber": "123456", // NOTE: Can be null if allowNullValues is false
"enterpriseName": "Seksjon for surr og tull", // NOTE: Can be null if allowNullValues is false
"accessGroups": {
"personal": "Personal surr og tull", // NOTE: Can be null if allowNullValues is false
"lonn": "Lønn surr og tull" // NOTE: Can be null if allowNullValues is false
},
"recno": 12345, // Recno of employeeProject
"projectNumber": "23-12" // ProjectNumber of employeeProject
}
}
```

### ```POST /SyncSharePointSite```
Endpoint for connecting a Sharepoint site to a archive-project, and a list || documentLibrary || folder to a archive-case

The Sharepoint site is connected to a archive-projectNumber. The list || documentLibrary || folder is connected to a archive case through the archive-field **externalId**

- Creates **Project** in archive if parameter `projectNumber` is not provided, or set to the string 'nei'.
- Creates **Case** in archive if the Sharepoint-id of the list || documentLibrary || folder does not exist as externalId in archive - or fetches the caseNumber if it exists.
- Does **not** update case or project metadata in archive. This is for avoiding conflicting changes if archivists change metadata directly in archive.
- If project exists - new case will inherit responsible person from the project, even if you specify a different responsible person this in the payload. This is for avoiding conflicting changes if archivists change metadata directly in archive.
- Returns metadata on **Project** and **Case** from archive

#### `Example payload`
```json
{
"siteUrl": "https://.sharepoint.com/sites/",
"projectNumber": "{existing project number} || ${'nei'} || ${undefined}", // Undefined and 'nei' creates new project in archive
"projectTitle": "Something that describes the Sharepoint site",
"responsiblePersonEmail": "[email protected]", // Must have access to archive - will throw error if user email is not found on a user in archive
"caseExternalId": "{siteUrl}-{type}-{guid}", // TODO: decide common structure - externalId MUST be unique
"caseTitle": "Something that describes the list || documentLibrary || folder",
"accessGroup": "Elev gul skole", // OPTIONAL. Defaults to "Alle"
"paragraph": "Offntl. 13.3" // OPTIONAL. Defaults to ""
}
```
#### `Response`
```json
{
"msg": "Succesfully synced SharePointSite",
"projectNumber": "24-1",
"projectTitle": "Bygging av nye fylkeskommuner",
"caseNumber": "22/00013",
"caseTitle": "Arkivering fra Sharepoint til P360"
}
```

## Templates
[All templates](https://github.com/vtfk/azf-archive/blob/master/templates)

Currently available archive templates [All templates](https://github.com/vtfk/azf-archive/blob/master/templates)

| System | Template | Languages | Description |
|--------|----------|-----------|-------------|
| elevmappe | create-elevmappe | nb | Create **Elevmappe** by referencing **social security number**.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/elevmappe-create-elevmappe.json)
| elevmappe | create-private-person | nb | Create **PrivatePerson** in *P360* contact register.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/elevmappe-create-private-person.json)
| elevmappe | get-documents | nb | Get **Documents** archived on a **caseNumber**.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/elevmappe-get-documents.json)
| elevmappe | get-elevmappe | nb | Get **Elevmappe** archived on a **social security number**.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/elevmappe-get-elevmappe.json)
| elevmappe | get-private-person | nb | Get **PrivatePerson** from *P360* contact register by referencing **social security number**.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/elevmappe-get-private-person.json)
| elevmappe | update-elevmappe | nb | Update **PrivatePerson** on **Elevmappe** archived on a **caseNumber**.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/elevmappe-update-elevmappe.json)
| elevmappe | update-private-person | nb | Update **PrivatePerson** in *P360* contact register.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/elevmappe-update-private-person.json)
| iop | hemmelig | nb | Sends a auto generate PDF to school to distribute this manully.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/iop-hemmelig.json)
| iop | document | nb | Archive an IOP on students elevmappe.
[JSON template and data format available here](https://github.com/vtfk/azf-archive/blob/master/templates/iop-document.json)
| masseutsendelse | utsendelsesdokument | nb | Upload document(s)

## local.settings.json

```json
{
"Values": {
"AzureWebJobsStorage": "",
"FUNCTIONS_WORKER_RUNTIME": "node",
"P360_BASE_URL": "http://p360server.domain.no:3001",
"P360_TOKEN": "bla-bla-bla-bla-123",
"P360_SECURE_BASE_URL": "http://p360sikkerserver.domain.no:3001",
"P360_SECURE_TOKEN": "bla-bla-bla-bla-123",
"P360_VTFK_ROBOT_RECNO": "000000",
"PAPERTRAIL_HOST": "https://logs.collector.solarwinds.com/v1/log",
"PAPERTRAIL_TOKEN": "token",
"NODE_ENV": "production",
"PDF_GENERATOR": "https://pdf.no/generate",
"DSF_JWT_SECRET": "Noe skikkelig hemmelig",
"DSF_URL": "https://dsf.no/lookup",
"DSF_SAKSREF": "systemref",
"DB_USER": "db-user",
"DB_PASSWORD": "db-pass",
"DB_SERVER": "db-server",
"DB_DATABASE": "db-db",
"DB_TABLE": "db-table",
"E18_URL": "https://e18url.net", // optional
"E18_KEY": "secret token", // optional
"E18_SYSTEM": "p360", // optional
"E18_EMPTY_JOB": true // optional
}
}
```

### E18

To support [E18](https://github.com/vtfk/e18-node#usage), add `E18_URL`, `E18_KEY` and `E18_SYSTEM`

## Deploy

### Azure

You'll need a valid subscription and to setup the following resources

- resource group
- app service plan
- storage account

#### Setup function

The easiest way to make this function run is to setup an app service, configure the app and get the function from GitHub.

- add function app
- Runtime stack -> Node

Configuration for app (Application settings)
- add values from [local.settings.json](#local.settings.json)

- add function
- Plattform features -> deployment center
- github
- branch master

# Development

Install all tools needed for [local development](https://docs.microsoft.com/en-us/azure/azure-functions/functions-develop-local).

Clone the repo. Install dependencies (```npm install```)

Create a [local.settings.json](#local.settings.json) file

Start server

```
$ func start
```

# License

[MIT](LICENSE)